Sign in
Debit Note

List debit notes

Returns a paginated list of the company's debit notes (notas de débito). The listing scopes to records whose document type is a debit-note type and whose STI class is Erp::Payouts::DebitNote or Erp::Payouts::Payable. Each entry embeds its counterpart_company, business_partner, linked_tradable, source, and its type. The internal embedding vector is always omitted.

get/v1/erp/payouts/debit_notes

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

Paginated list of debit notes (default 25 per page).

idstring uuid required
company_idstring uuid required
typestring

STI class, one of Erp::Payouts::DebitNote or Erp::Payouts::Payable (a debit note that has already been converted into a payable). Serialized via the type method.

amountinteger
currencystring
document_typeinteger

SII document type code (see the document_types mapping).

source_typestring nullable
source_idstring nullable
counterpart_company_idstring uuid nullable
business_partner_idstring uuid nullable
linked_tradable_idstring uuid nullable
descriptionstring nullable
review_statusstring nullable
payment_statusstring nullable
due_datestring date-time nullable
issue_datestring date-time nullable
payment_datestring date-time nullable
created_atstring date-time
updated_atstring date-time
counterpart_companyobject nullable

Included in the index response.

business_partnerobject nullable

Included in the index response.

linked_tradableobject nullable

Included in the index response.

sourceobject nullable

Included in the index response.

Changes

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