latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Invoices
Gets the latest invoices for a business.
get/invoices
Query parameters
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' required
startDatestring
Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.
endDatestring
Transaction date less than or equal to parameter in the format: YYYY-MM-DD.
offsetnumber
The offset is the position in the dataset of a particular record.
limitnumber
This is the size of the results set you would like (default: 100).
orderBystring
status'open' | 'draft' | 'partiallyPaid' | 'paid' | 'unknown' | 'void'
Response
Example response
{
"count": 1,
"meta": {
"reportId": [
"5fad8a342a88364234392fb5",
"5fad8a342a88364234392fb6"
],
"serviceName": "xero",
"businessName": "Railz",
"startDate": "2020-11-25T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z"
},
"data": [
{
"id": "1",
"invoiceNumber": "string",
"customerRef": {
"id": "1",
"name": "Railz Financial"
},
"dueDate": "2021-03-09T15:59:47.118Z",
"currencyRate": 1.13,
"totalAmount": 283,
"subTotal": 250.5,
"taxAmount": 32.5,
"amountDue": 283,
"sourceModifiedDate": "2021-03-09T15:59:47.118Z",
"memo": "Example invoice memo.",
"payments": [
{
"amount": 50.5,
"paymentId": "50",
"date": "2021-03-09T10:18:29.985Z"
}
],
"subsidiaryRefs": [
{
"id": "1",
"name": "Railz Financial"
}
],
"postedDate": "2021-03-09T15:59:47.118Z",
"currencyRef": {
"id": "CAD",
"name": "Canadian Dollar",
"symbol": "USD,CAD"
},
"lines": [
{
"description": "Services rendered.",
"unitAmount": 100.5,
"quantity": 3,
"taxAmount": 20.5,
"taxRateRef": {
"id": "1",
"name": "HST",
"effectiveTaxRate": 13
},
"inventoryRef": {
"id": "1",
"name": "Digital Services"
},
"accountRef": {
"id": "145",
"name": "Example account"
},
"locationRef": {
"id": "52",
"name": "United States"
},
"discountPercentage": "10.5",
"totalAmount": 10.5,
"subTotal": 301.5,
"trackingCategoryRef": {
"id": "4040",
"name": "Region",
"option": "East",
"optionId": "40401"
}
}
]
}
]
}