Logoelepay
Invoice

List invoices

インボイス情報を一覧で取得します。

GET
/invoices

Authorization

AuthorizationBearer <token>

API呼出すの認証は、秘密鍵を認証トークンとして扱い、Bearer 認証経由で行われます。 秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。

In: header

Query Parameters

keyword?string

キーワード

from?integer

開始時間（エポックミリ秒）、指定した時間以降に作成されたデータを取得します

Formatint64
to?integer

終了時間（エポックミリ秒）、指定した時間以前に作成されたデータを取得します

Formatint64
status?array<>

status

limit?integer

最大件数

Default20
Rangevalue <= 100
offset?integer

検索開始位置

Default0

Response Body

application/json;charset=utf-8

curl -X GET "https://api.elepay.io/invoices"
{
  "total": 0,
  "invoices": [
    {
      "id": "string",
      "object": "invoice",
      "liveMode": true,
      "customer": {
        "id": "string",
        "object": "customer",
        "liveMode": true,
        "defaultSource": "string",
        "name": "string",
        "description": "string",
        "email": "string",
        "phone": "string",
        "remark": "string",
        "operator": "string",
        "status": "active",
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "updateTime": 0
      },
      "invoiceNo": "string",
      "name": "string",
      "memo": "string",
      "amount": 0,
      "currency": "JPY",
      "status": "draft",
      "operator": "string",
      "invoiceTime": 0,
      "sendTime": 0,
      "paidTime": 0,
      "expiryTime": 0,
      "createTime": 0,
      "fields": [
        "string"
      ],
      "items": [
        {
          "id": "string",
          "object": "invoiceItem",
          "name": "string",
          "unitPrice": 0,
          "currency": "JPY",
          "quantity": 0,
          "unit": "string",
          "taxRateType": "standard",
          "transactionTime": 0
        }
      ],
      "remark": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "enableAutoCharge": true
    }
  ]
}