latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Reports
API to retrieve formatted invoices report
get/reports/invoices
Query parameters
businessNamestring required
Unique business name identifier.
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' required
Name of accounting service provider, reuse currently available enum used in the feeder
startDatestring required
The start date of the report frequency in the format: yyyy-MM-dd.
endDatestring required
The end date of the report frequency in the format: yyyy-MM-dd.
Response
Successfully returned invoices report
Example response
{
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-12-25T01:02:03Z",
"updatedAt": "2020-12-25T01:02:03Z",
"endDate": "2020-12-25T01:02:03Z",
"startDate": "2020-11-25T01:02:03Z"
},
"data": {
"paidAmount": 1000
}
}