latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041351024.8 MB

21d41189c461

Bill credit notes

List bill credit notes

The List bill credit notes endpoint returns a list of bill credit notes for a given company's connection.

Bill credit notes are issued by a supplier for the purpose of recording credit.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/data/billCreditNotes

Query parameters

pageinteger
Example:1

Page number. Read more.

pageSizeinteger
Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring
Example:-modifiedDate

Field to order results by. Read more.

Response

Success

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required— unresolved $ref

Example response

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 1,
  "_links": {
    "self": {
      "href": "/companies/{id}/data/{dataType}"
    },
    "current": {
      "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
    }
  }
}