Autenticación
Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
One billing document — an invoice or a credit note — with its own lines and the payment summaries of the order it bills. RBAC + RLS scoped; an out-of-scope or unknown id is a `404`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
invoiceId (path) | Uuid | Sí | The billing document's id. This is the `Invoice`/`CreditNote` id — **not** the order's. It was the order's id while `/v1/invoices` projected orders (docs/34 §7); the projection… |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
document_type | InvoiceDocumentType | Sí | Which kind of legal document this is (docs/34 §1.3). An `invoice` is what we bill; a `credit_note` is what we un-bill — it carries its own `ZD-CRN` series number and names the i… |
order_id | object | No | The order this document bills; null for a document raised without one. |
credits_invoice_id | object | No | For a `credit_note`, the invoice it un-bills. Always null on an `invoice`. |
number | string | Sí | The gapless legal document number (docs/34 §1.2), allocated per legal entity, series and year. Credit notes use the separate `ZD-CRN` series. |
status | InvoiceStatus | Sí | A billing document's payment state, read off the document itself (docs/34 §4.1). `paid` — money captured; `due` — issued and still owed; `overdue` — past its due date unpaid; `r… |
currency | CurrencyCode | Sí | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Sí | — |
tax_minor | integer | Sí | — |
discount_minor | integer | Sí | — |
total_minor | integer | Sí | — |
issued_at | object | No | When the document was issued and its number allocated. |
pdf_url | object | Sí | A short-lived PDF link once rendered (docs/34 §4.2); null until then. |
lines | InvoiceLine[] | Sí | — |
payments | Payment[] | Sí | Payment attempts against the order this document bills, so a customer can see how an invoice was settled. Empty for a document with no order. |
created_at | string | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429