CAcardda
Credit Note

List credit notes

Returns a paginated list of the company's credit notes (notas de crédito). Each entry embeds its counterpart_company, business_partner, linked_tradable, and source. The internal embedding vector is always omitted.

get/v1/erp/payouts/credit_notes

Request

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

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 credit notes (default 25 per page).

idstring uuid required
company_idstring uuid required
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

The payable this credit note is applied against, if any.

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
business_partnerobject nullable

Included in the index response.

linked_tradableobject nullable

The linked payable. Included in the index response.

sourceobject nullable

The originating document (e.g. fiscal invoice). Included in the index response.

receiptboolean

Whether the credit note has a receipt attachment. Included only in the index response. Note: the real JSON key is receipt? (ends with a question mark); it is documented here without the ? suffix (the repo lint forbids ?-suffixed property names, as they are Ruby predicate methods, not valid JSON keys).

pdfboolean

Whether the credit note has a PDF document. Included only in the index response. Note: the real JSON key is pdf? (ends with a question mark); it is documented here without the ? suffix (the repo lint forbids ?-suffixed property names).

Changes

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