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

21d41189c461

Payments

List payments

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

Payments represent an allocation of money within any customer accounts receivable account.

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

get/companies/{companyId}/data/payments

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