CAcardda
Bill

Get a bill

Returns a single bill by id, including its charges_with_descriptions breakdown.

Company users may only read bills for companies they belong to; requesting a bill outside that scope returns 404 Not Found.

get/v1/bills/{id}

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/bills/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The UUID of the bill.

Parameters

#/paths/~1v1~1bills/get/parameters/0 (unresolved $ref)

Response

The requested bill.

idstring uuid required
company_idstring uuid required

Company the bill belongs to.

monthinteger nullable
yearinteger nullable
statusstring nullable

Lifecycle state of the bill.

  • draft - being assembled, not yet issued
  • preissued - pre-issued at the tax authority
  • issued - final tax document emitted
transitionstring nullable

In-flight state transition, when a status change is being processed.

external_idstring nullable

Identifier of the emitted document at the external billing provider.

total_amountinteger nullable

Total amount of the bill, in the smallest currency unit.

datestring date nullable

Issue date of the bill.

fiscal_invoice_idstring nullable

Identifier of the associated fiscal (SII) invoice, when emitted.

chargesobject nullable

Raw per-product charge map ({ "<product>": <amount_cents> }) accumulated from the underlying commissions.

created_atstring date-time
updated_atstring date-time

Example response

{
  "month": 6,
  "year": 2024,
  "status": "issued",
  "total_amount": 119000,
  "charges_with_descriptions": [
    {
      "amount": 100000,
      "description": "Comisión transferencias"
    }
  ]
}

Changes

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