agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso agency.invoicing.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
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 PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'¿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
⛔ `next_number` is deliberately NOT settable. Rewinding a sequence would mint a duplicate number for a document already in a client's hands; advancing it leaves a gap a tax authority will ask about. Requires `agency.invoicing.manage`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
org_id (query) | Uuid | No | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
business_name | string | No | — |
address | string | No | — |
email | string | No | — |
phone | string | No | — |
website | string | No | — |
tax_number_label | string | No | — |
tax_number | string | No | — |
payment_instructions | string | No | — |
logo_sha256 | string | No | — |
accent_colour | string | No | — |
default_currency | string | No | — |
default_payment_terms_days | integer | No | — |
default_footer | string | No | — |
default_notes | string | No | — |
number_prefix | string | No | — |
number_padding | integer | No | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
business_name | string | No | — |
address | string | No | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | No | — |
phone | string | No | — |
website | string | No | — |
tax_number_label | string | No | What the agency calls its tax registration — "VAT number", "ABN", "GSTIN", "EIN". ⛔ Printed only when the number is set too: a label with no number is an empty row, and a number… |
tax_number | string | No | — |
payment_instructions | string | No | Bank details or a "PayPal me at …" line, printed on the document verbatim and shown on the payment page. ⭐ Never translated — translating a payment instruction is not a safe act. |
logo_sha256 | string | No | A digest into the content-addressed logo store, never a URL. That is what lets the PDF inline the mark with no network call at render time. |
accent_colour | string | No | — |
default_currency | string | Sí | — |
default_payment_terms_days | integer | No | — |
default_footer | string | No | — |
default_notes | string | No | — |
number_prefix | string | Sí | — |
number_padding | integer | No | — |
next_number | integer | Sí | The next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands. |
next_number_preview | string | No | What the next invoice will be called, e.g. `INV-0042`. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429