An invoice is an itemized record of goods sold or services provided to a customer.
The Invoice Object
Property | Type | Description |
---|---|---|
id | string | |
invoice_number | string | |
customer_id | string | |
posted_at | string | The posted date in ISO 8601 format |
due_at | string | The due date in ISO 8601 |
currency | string | The ISO-4217 currency code |
currency_rate | number | |
line_items | object[] | |
status | string | Current state of an invoice, one of:
|
total_discount | number | |
sub_total | number | |
tax_amount | number | |
amount_due | number | |
discount_percentage | number | |
updated_at | string | The last updated date in ISO 8601 |
memo | string | |
payments | object[] |
{
"id": "1",
"invoice_number": "1",
"customer_id": "123",
"posted_at": "2021-03-09T15:59:47.118Z",
"due_at": "2021-03-09T15:59:47.118Z",
"currency": "USD",
"currency_rate": 1.13,
"line_items": [
{
"description": "Services rendered.",
"unit_amount": 100.5,
"quantity": 3,
"discount_amount": 0,
"sub_total": 301.5,
"tax_amount": 20.5,
"total_amount": 322,
"discount_percentage": 10.5,
"item_id": "123",
"account_id": "1234",
"location_id": "12"
}
],
"status": "open",
"total_discount": 0,
"sub_total": 250.5,
"tax_amount": 32.5,
"total_amount": 283,
"amount_due": 283,
"discount_percentage": 0,
"updated_at": "2021-03-09T15:59:47.118Z",
"memo": "Example invoice memo.",
"payments": [
{
"amount": 50.5,
"id": "50"
}
]
}