v1
latestOpenAPI 3.1.02026-07-26580123.9 KBCompany credit notes
Get a list of all your company's credit notes
get/{companyDomain}/companies/creditnotes
Path parameters
companyDomainstring required
Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets
Query parameters
pageinteger required
The page of credit notes you would like to view
pageSizeinteger required
The number of records to return per page (max 100)
querystring
Add search terms here to filter results
orderBystring
Sort the results by particular properties
orderByDescendingstring
Sort the results by particular properties in descending order
isPendingboolean
Do you want to show credit notes with the status 'pending'; true or false
isPaidboolean
Do you want to show credit notes with the status 'paid'; true or false
isFailedboolean
Do you want to show credit notes with the status 'failed'; true or false
Response
200
Example response
{
"results": [
{
"creditNoteUniqueId": "string",
"customerUniqueId": "string",
"customerFirstName": "string",
"customerLastName": "string",
"customerFullName": "string",
"createdOn": "2020-04-30T10:22:14.547Z",
"amount": "string",
"status": "string",
"currency": "string"
}
]
}