Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Credit Notes

List credit notes

Endpoint for retrieving a list of credit notes.

get/credit-notes/

Query parameters

branchstring

The unique identifier of the branch.

contactstring

The unique identifier of the contact.

created_ts_afterstring date-time

The timestamp in UTC when the credit note was created

created_ts_beforestring date-time

The timestamp in UTC when the credit note was created

credit_note_datestring date

Credit note date

external_idstring

External identifier

modified_ts_afterstring date-time

The timestamp in UTC when the credit note was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the credit note was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

projectstring

The unique identifier of the project.

statusstring

The status of the credit note

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}