このページは現在翻訳中です。

Receipt API

The Receipts API allows you to retrieve daily receipts. Receipts accumulate all transaction and transfer fees and are generated daily up to the most recent full day.

Attributes

Name Type Description
object string

固定値receipt

id object_id

/rcpt(_test)?_[0-9a-z]+/に一致する RECEIPT_ID

livemode boolean

本番モード (true) あるいはテストモード(false) の追加振込先口座。

location string

現在のreceiptオブジェクトを取得するためのAPIパス。

adjustment_transaction object_id

調整取引

charge_fee integer

smallest currency unit(最小通貨単位)での決済手数料。

company_address string

Omise住所。

company_name string

Omiseの会社名。

company_tax_id string

Omise納税者番号。

created_at datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でレシートが作成されたUTC日時。

credit_note boolean

この料金サブユニットが負 (true) か正(false)か。

currency currency

3文字で表示される受領用通貨のISO 4217コード。

customer_address string

顧客の住所。

customer_email string

顧客のメールアドレス。

customer_name string

顧客名。

customer_statement_name string

顧客ステートメント名。

customer_tax_id string

顧客の納税者番号。

issued_on date

ISO 8601形式のレシート発行日。

number string

レシート番号。

subtotal integer

charge_feeからvoided_feeを引きtransfer_feeを足した結果。

total integer

subtotalvatからwhtを引いた結果。

transfer_fee integer

smallest currency unit(最小の通貨単位)での振替手数料。

vat integer

subtotal(小計)の付加価値税(VAT)。

voided_fee integer

smallest currency unit(最小の通貨単位)で無効となった手数料。

wht integer

subtotalの源泉徴収税(WHT)。

Retrieve a receipt

- GET https://api.omise.co/receipts/{id}

Returns an existing receipt object.

Example

  • Retrieve a receipt

List all receipts

- GET https://api.omise.co/receipts

receiptに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • List all receipts

  • List all receipts by specific month