An invoice represents a list of goods sent or services provided by a business along with a statement of the amount due for these goods and services. Typically, a business's accounts receivable (AR) refer to the outstanding invoices that a company has or the money that counterparties owe the company.
| Attribute | Description |
|---|---|
| id string | Unique identifier for the invoice. |
| contact_details array of objects | The business contact details (email, phone number, and/or website) of the entity creating the invoice. |
| counterparty_id string | The ID of the counterparty receiving the invoice. |
| counterparty_billing_address object | The billing address of the counterparty or null. |
| counterparty_shipping_address object | The shipping address of the counterparty where physical goods should be delivered or null. |
| currency string | Currency that the invoice is denominated in. |
| description string | An optional free-form description of the invoice. |
| due_date datetime | A future date by when the invoice needs to be paid. |
| hosted_url string | The URL of the hosted web UI where the invoice can be viewed. |
| invoicer_address object | Business address of the entity creating the invoice or null. |
| number string | A unique record number assigned to each invoice that is issued. |
| originating_account_id string | The ID of the internal account the invoice should be paid to. |
| payment_orders array of objects | The payment orders created for paying the invoice through the invoice payment UI. |
| pdf_url string | The URL where the invoice PDF can be downloaded. |
| status string | One of draft, unpaid, payment_pending, paid, or void. |
| total_amount int32 | Total amount due in specified currency's smallest unit, e.g. $10 USD would be represented as 1000. |
{
"id": "e120c37a-83eb-4b31-bf49-868d0110cdaf",
"object": "invoice",
"live_mode": true,
"currency": "USD",
"description": "Invoice for goods and services provided",
"total_amount": 0,
"number": "2023-00001",
"status": "draft",
"counterparty_id": "60df9366-c98e-4be9-a1af-163e792331cd",
"due_date": "2023-02-19T16:25:12Z",
"hosted_url": "http://payments.moderntreasury.com/invoices/e120c37a-83eb-4b31-bf49-868d0110cdaf",
"pdf_url": null,
"invoicer_address": {
"id": "32fdb378-2a26-4b3c-8fe0-037932e07b4c",
"object": "address",
"live_mode": true,
"line1": "680 Darron Flats",
"line2": null,
"locality": "Lake Boville",
"region": "WV",
"postal_code": "36045-2227",
"country": "US",
"created_at": "2023-01-20T16:25:12Z",
"updated_at": "2023-01-20T16:25:12Z"
},
"contact_details": [
{
"contact_identifier": "[email protected]",
"contact_identifier_type": "email",
},
{
"contact_identifier": "www.example.com",
"contact_identifier_type": "website",
},
],
"counterparty_billing_address": null,
"counterparty_shipping_address": null,
"originating_account_id": "071f206e-4f79-424c-9e53-0c6a3366277d",
"payment_orders": [],
"created_at": "2023-01-20T16:25:12Z",
"updated_at": "2023-01-20T16:25:12Z"
}