Invoices
List Invoice summaries
List invoices with only the fields the summary table renders
get/invoices/list-summary
Query parameters
beforestring
before
afterstring
after
limitinteger
limit
sortOrder'ASC' | 'DESC'
sortOrder
sortBystring
sortBy
invoiceStatusstring
invoiceStatus
invoicePaymentStatusstring
invoicePaymentStatus
customerIdstring
customerId
billingScheduleIdstring
billingScheduleId
dueBeforestring
dueBefore
dueAfterstring
dueAfter
sentBeforestring
sentBefore
sentAfterstring
sentAfter
invoiceBeforestring
invoiceBefore
invoiceAfterstring
invoiceAfter
excludeZeroQuantityboolean
excludeZeroQuantity
invoiceCurrencystring
invoiceCurrency
searchstring
search
invoiceNumberstring
invoiceNumber
netTotalnumber
netTotal
excludeInvoiceStatusstring
excludeInvoiceStatus
excludeInvoicePaymentStatusstring
excludeInvoicePaymentStatus
excludeCustomerIdstring
excludeCustomerId
excludeBillingScheduleIdstring
excludeBillingScheduleId
excludeInvoiceCurrencystring
excludeInvoiceCurrency
excludeInvoiceNumberstring
excludeInvoiceNumber
excludeNetTotalnumber
excludeNetTotal
excludeSearchstring
excludeSearch
Headers
Authorizationstring required
Your API credentials. Eg. Basic {credentials}.
sequence-version'2024-07-30'
Use this header to select an API version
Response
OK
Example response
{
"items": [
{
"id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
"invoiceNumber": "INV2",
"status": "DRAFT",
"paymentStatus": "UNPAID",
"currency": "GBP",
"grossTotal": "10",
"customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
"customerLegalCompanyName": "Facebook",
"billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"dueDate": "2022-11-05",
"dueDateSource": "CALCULATED",
"accountingDate": "2022-10-05",
"links": [
{
"externalId": "ID",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z",
"externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
}
]
}
],
"pagination": {
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}
}