List payables for export

get

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

Lean, export-oriented listing of payables. Returns only the fields the spreadsheet
export consumes, folds each payable's comments inline, and can optionally include signed
document URLs.

Set include_document_urls=true to embed signed urls for each payable's user
documents. When enabled the result set is capped at 500 rows; exceeding it returns
422 with error code payables/export_document_urls_limit.

Accepts the same filter and pagination parameters as the standard payables list.

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

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.

include_document_urls

boolean

Defaults to false

When true, embeds signed document URLs (capped at 500 rows).

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

200Export rows for the matching payables.

422Unprocessable Entity — document-URL export cap (500 rows) exceeded.