List all

get

https://api.cardda.com/v1/erp/payouts/payables

Returns a list of payables the caller can access across their permitted companies.

The deprecated company_id query parameter is still accepted and, when present,
filters the results to those company id(s). The company-id header and the
company_id query parameter are not compared against each other, so there is no
mismatch error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_start

integer

≥ 0

If all the transactions where in an array, this would represent the index of the first item returned in the response

_end

integer

≥ 0

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

The field used to sort, the example illustrates a response that would be sorted by the creation date

company_id

uuid

deprecated

Deprecated — pass the company UUID via the company-id HTTP header instead.
See The company-id header. The backend
still accepts this query parameter for backwards compatibility but new integrations
should use the header exclusively.

When both this query parameter and the company-id header are present, their
values must match; the API returns 422 Unprocessable Entity when they disagree.

amount

string

Only as an example of filtering results that have an amount less than $11000.
For more detailed explanation, go to the How to filter results section.

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Pay endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

If the deprecated company_id query parameter is also sent, both values must match;
the API returns 422 Unprocessable Entity when they disagree.

Responses

401

Unauthorized

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of payable that the current user has access, default 25 per page but can be modified through the end and start params.