curl --request GET \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/invoice \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"business_id": "biz_Pk2fNFDd8wj7EFeLWJywc7",
"number": "<string>",
"description": "<string>",
"total_amount": 123,
"total_paid": 0,
"source": "manual",
"due_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z",
"status": "open",
"credit_amount": 123,
"metadata_": {},
"id": "inv_WQMDNUHpBThYSNh4AprDBo",
"lines": [
{
"description": "<string>",
"ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
"discount_amount": 123,
"discount_rate": 123,
"unit_price": 123,
"quantity": 123,
"tax_amount": 123,
"tax_rate": 123,
"is_prepayment": true,
"metadata_": {},
"id": "inv_line_WQMDNUHpBThYSNh4AprDBo",
"invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo"
}
],
"payments": [
{
"invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo",
"transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",
"payment_id": "WQMDNUHpBThYSNh4AprDBo",
"datetime": "2021-01-01T00:00:00Z",
"payment_amount": 123,
"id": "inp_WQMDNUHpBThYSNh4AprDBo",
"invoice": {}
}
],
"customer_id": "<string>"
}
],
"pagination": {
"next_page_token": "<string>",
"previous_page_token": "<string>"
}
}
Get paginated list of invoices for a business with optional filtering.
curl --request GET \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/invoice \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"business_id": "biz_Pk2fNFDd8wj7EFeLWJywc7",
"number": "<string>",
"description": "<string>",
"total_amount": 123,
"total_paid": 0,
"source": "manual",
"due_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z",
"status": "open",
"credit_amount": 123,
"metadata_": {},
"id": "inv_WQMDNUHpBThYSNh4AprDBo",
"lines": [
{
"description": "<string>",
"ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
"discount_amount": 123,
"discount_rate": 123,
"unit_price": 123,
"quantity": 123,
"tax_amount": 123,
"tax_rate": 123,
"is_prepayment": true,
"metadata_": {},
"id": "inv_line_WQMDNUHpBThYSNh4AprDBo",
"invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo"
}
],
"payments": [
{
"invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo",
"transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",
"payment_id": "WQMDNUHpBThYSNh4AprDBo",
"datetime": "2021-01-01T00:00:00Z",
"payment_amount": 123,
"id": "inp_WQMDNUHpBThYSNh4AprDBo",
"invoice": {}
}
],
"customer_id": "<string>"
}
],
"pagination": {
"next_page_token": "<string>",
"previous_page_token": "<string>"
}
}
The access token received from the authorization server in the OAuth 2.0 flow.
Filter invoices by one or more statuses
Show child attributes
Include invoices due after this period (inclusive) in ISO-8601 format
Include invoices due before this period (inclusive) in ISO-8601 format
1 <= x <= 100
Successful Response
The response is of type object
.