Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso billing.invoice.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
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 PATCH https://api.zinndigital.com/v1/accounting/xero \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "includeSubclientInvoices": <boolean> }'¿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
Today the one option is `includeSubclientInvoices`, which is meaningful only for a reseller: with it on, the invoices the reseller raised **to its own clients** are pushed into the reseller's Xero as well as the invoices Zinn® raised to them. ⛔ It never widens the scope to invoices Zinn® raised **directly** to those clients. Those are Zinn®'s own sales, on Zinn®'s legal entity, and are none of the reseller's business — the engine discriminates on the invoice's legal entity owner, not on the organization tree alone. Requires `billing.invoice.manage`.
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
includeSubclientInvoices | boolean | Sí | See `updateXeroConnection`. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<not_connected, connected, needs_reconnect, disconnected> | Sí | `connected` is healthy. `needs_reconnect` means the link died (Xero expires a refresh token after 60 days of inactivity, and access can be revoked in Xero) — invoices raised mea… |
tenantName | string | No | The Xero organization's own name. ⭐ The single most useful field on the screen: connecting the wrong company is the mistake that hurts, and the name is what lets a customer see… |
includeSubclientInvoices | boolean | No | Reseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients. |
entitled | boolean | No | Whether the plan includes accounting sync (or it has been bought as an add-on). Reported even when false so the screen can explain rather than show nothing. |
connectedAt | string | No | — |
lastSyncAt | string | No | When a push last SUCCEEDED. Null means never — not "broken". |
brokenSince | string | No | When it first stopped working, so "down for three weeks" is answerable. |
lastError | string | No | A reason written for the customer. Never the vendor's error verbatim. |
counts | XeroSyncCounts | Sí | How this organization's invoices stand with Xero. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429