Sign in
Invoice

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

get/v1/invoices

Query parameters

user_idstring

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

company_idstring

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

account_idstring

Filter by billing account UUID.

Parameters

#/paths/~1v1~1bills/get/parameters/0 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/1 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/2 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/3 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/4 — unresolved $ref

Response

Paginated list of invoices.

idstring uuid required
namestring nullable
account_idstring uuid required
company_idstring uuid nullable
user_idstring nullable
amount_in_clpinteger
parsed_conversion_ratestring nullable
paid_amountstring

Total already paid against this invoice, summed from its payment-order allocations. Added via serializer method.

accountobject nullable

The billing account, added via serializer method.

file_urlstring nullable
buy_invoice_urlstring nullable
commentsstring
datestring date nullable
commissioninteger nullable
taxinteger nullable
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "amount": {
      "value": "100000",
      "currency": "CLP"
    },
    "conversion_rate": {
      "value": "946.35",
      "pair": "USDCLP"
    },
    "parsed_conversion_rate": "946.350000",
    "paid_amount": "100000.0"
  }
]

Changes