get
https://public.billsby.com/api/v1/rest/core//companies/creditnotes
Get a list of all your company's credit notes
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This API returns a list of your companies credit notes. You'll get information on the associated with the credit note and the amount and currency. You won't get a full spectrum of information on the individual customers here but you can use the Get Customer details API to find more details - just use the Customer ID variable.
Credit notes are returned in pages. The first part of the results describes which page you're on, the total number of pages, the size of the page and how many rows are in the page. Then, each result is provided within the array.
Returned variables
| Variable name | Description |
|---|---|
| creditNoteId | The unique identifier of the credit note in the Billsby platform |
| creditNoteUniqueId | A unique, more readable alphanumeric ID (e.g. AHD12QR4) |
| customerId | The unique identifier of the customer in the Billsby platform |
| customerUniqueId | A unique, more readable alphanumeric ID (e.g. AHD12QR4) |
| customerFirstName | The customer's first name |
| customerLastName | The customer's last name |
| customerFullName | The customer's full name |
| createdOn | The date that credit note was issued |
| amount | The amount of the credit note |
| status | The status of the invoice |
| currency | The currency the credit note is issued in |