List debit notes

get

https://api.cardda.com/v1/erp/payouts/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.

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.

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