Sign in
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}/connections/{connectionId}/data/payments

Query parameters

linkTypestring required

The type of link on a payment's line in Codat.

Example:invoice

The type of link on a payment's line in Codat.

querystring

Codat query string. Read more.

pageinteger
Example:1

Page number. Read more.

pageSizeinteger
Example:100

Number of records to return in a page. 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"
    }
  }
}