CAcardda
Payable

List payables 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.

get/v1/erp/payouts/payables/index_for_export

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/erp/payouts/payables/index_for_export
  • Auth
    HTTP bearer

Query parameters

include_document_urlsboolean

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

Parameters

#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/1 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/2 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/3 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/4 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1reviews/get/parameters/5 (unresolved $ref)

Response

Export rows for the matching payables.

idstring uuid
company_idstring uuid
source_idstring uuid

Id of the polymorphic source document (e.g. fiscal invoice).

source_typestring

Polymorphic type of the source document.

document_typeinteger
amountinteger
currencystring
payment_statusstring
descriptionstring
foliointeger
issue_datestring date-time
due_datestring date-time
payment_datestring date-time
effective_payment_datestring date-time
display_numberstring

Human-facing document number of the payable.

commentsstring[]
custom_column_valuesobject[]
urlsstring[]

Signed document URLs; present only when include_document_urls=true.

Changes

No recorded changes to this operation across all 1 revision of this API.