Receipt API

Receipts API สามารถใช้เรียกดูใบเสร็จของแต่ละวันได้ ในใบเสร็จจะแสดงค่าบริการในการทำธุรกรรมและค่าธรรมเนียมการโอนเงินทั้งหมด โดยจะแสดงข้อมูลของวันล่าสุด

Attribute

Name Type Description
object string

The string receipt.

id object_id

The RECEIPT_ID matching /rcpt(_test)?_[0-9a-z]+/.

location string

API path to retrieve the current receipt object.

charge_fee integer

The charge fee in the smallest currency unit.

company_address string

Omise address.

company_name string

Omise company name.

company_tax_id string

Omise tax ID.

credit_note boolean

Whether this is a negative (true) or positive (false) fee subunit.

currency string

Currency for receipt as three-letter ISO 4217 code.

customer_address string

Customer address.

customer_email string

Customer email.

customer_name string

Customer name.

customer_statement_name string

Customer statement name.

customer_tax_id string

Customer tax ID.

date date

Date of the receipt in ISO 8601 format.

number string

Receipt number.

subtotal integer

Result of charge_fee minus voided_fee plus transfer_fee.

total integer

Result of subtotal plus vat minus wht.

transfer_fee integer

Transfer fee in the smallest currency unit.

vat integer

Value-Added Tax (VAT) of subtotal.

voided_fee integer

Voided fee in the smallest currency unit.

wht integer

The Withholding Tax (WHT) of subtotal.

List all receipts

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

Returns a list of all receipt objects belonging to your account.

Request Parameter

Name Type Description
offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

limit integer

(optional, default: 20, maximum: 100) Number of records to return.

from datetime

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC date and time for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

to datetime

(optional, default: current UTC datetime) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

order string

(optional, default: chronological) Order in which to return records. One of chronological (earliest to latest) or reverse_chronological (latest to earliest).

Example

  • List all receipts

  • List all receipts by specific month

Retrieve a receipt

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

Returns an existing receipt object.

Example

  • Retrieve a receipt