List invoices

get

https://api.cardda.com/v1/invoices

Returns a paginated list of invoices ("facturas de venta").

Access

Access is scoped to the caller: a non-staff user must request their own invoices by
passing their user id as the user_id filter (user_id must equal the authenticated
user's id). Requests without a matching user_id are rejected with 401. Cardda
staff may query any invoices.

Filtering, sorting, pagination

Supports _start/_end pagination, _field/_order sorting, and per-field filters.
A filter value can be a plain value or a JSON string with an operator, e.g.
company_id={"$in":[...]}.

Response

Each invoice includes paid_amount (total paid to date) and its account.

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

user_id

string

Filter by owning user id. Required for non-staff callers, who may only pass
their own user id (otherwise the request returns 401).

company_id

string

Filter by company UUID. Supports {"$in":[...]} for batch lookups.

account_id

string

Filter by billing account UUID.

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Finance 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.

Responses

401

Unauthorized - missing/invalid token, or user_id does not match the caller.

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 invoices.