latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Invoice Credit Notes
Gets the latest invoice (customer) credit notes for a business.
get/invoices/creditNotes
Query parameters
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | '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
totalAmountnumber float
Total amount of a credit note.
remainingCreditnumber float
Remaining credit on a credit note.
status'open' | 'paid' | 'partiallyPaid' | 'void' | 'unknown' | 'draft'
Response
Example response
{
"count": 1,
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z",
"startDate": "2020-11-25T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z"
},
"data": [
{
"customerRef": {
"id": "1",
"name": "Railz Financial"
},
"locationRef": {
"id": "52",
"name": "United States"
},
"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"
},
"discountPercentage": 10.5,
"accountRef": {
"id": "145",
"name": "Example account"
},
"totalAmount": 10.5,
"subTotal": 301.5,
"trackingCategoryRef": {
"id": "4040",
"name": "Region",
"option": "East",
"optionId": "40401"
}
}
]
}
]
}