List Invoice summaries
Invoices
List Invoice summaries
List invoices with only the fields the summary table renders
GET
List Invoice summaries
Headers
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
Available options:
2024-07-30 Query Parameters
before
after
limit
sortOrder
Available options:
ASC, DESC sortBy
invoiceStatus
invoicePaymentStatus
customerId
billingScheduleId
dueBefore
dueAfter
sentBefore
sentAfter
invoiceBefore
invoiceAfter
excludeZeroQuantity
invoiceCurrency
search
invoiceNumber
netTotal
excludeInvoiceStatus
excludeInvoicePaymentStatus
excludeCustomerId
excludeBillingScheduleId
excludeInvoiceCurrency
excludeInvoiceNumber
excludeNetTotal
excludeSearch
Response
OK
Invoice summaries
Example:
[
{
"id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
"invoiceNumber": "INV2",
"status": "DRAFT",
"currency": "GBP",
"grossTotal": 10,
"customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
"customerLegalCompanyName": "Facebook",
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"dueDate": "2022-11-05",
"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"
}
]
}
]Results pagination
Example:
{
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}