latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Aging Reports
Gets a range of AP aging reports for a business.
get/apAging
Query parameters
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'dynamicsBusinessCentral' 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
reportFrequency'month' | 'quarter' | 'year' required
Response
Example response
{
"count": 1,
"reports": [
{
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"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",
"reportFrequency": "month"
},
"data": [
{
"vendorRef": {
"id": "240",
"name": "Railz"
},
"current": 50000,
"dpd30": 25000,
"dpd60": 25000,
"dpd90": 60000,
"dpd90+": 90000,
"total": 200000,
"currencyRef": {
"id": "CAD",
"name": "Canadian Dollar",
"symbol": "USD,CAD"
}
}
]
}
]
}