COcodatio
Bills

List bills

Changed on

The List bills endpoint returns a list of bills for a given company's connection.

Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.

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

Tips and traps

To access the paymentAllocations property, ensure that the billPayments data type is queued and cached in Codat before retrieving bills from Codat's cache.

get/companies/{companyId}/data/bills

Request

  • Base URL
    https://api.codat.io
  • Auth
    API key in header Authorization

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"
    }
  }
}

Changes

  • e26d39d895b9Revision changes
    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became optional for the status

    • breaking

      the response property ////// became optional for the status

  • 2faca7013054Revision changes
    • warning

      added the new bills enum value to the //////// response property for the response status