billing

PATCH /v1/accounting/xero

Change what a connection syncs.

Gbogbo àwọn billing endpoints

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda billing.invoice.manage; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

curl -X PATCH https://api.zinndigital.com/v1/accounting/xero \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "includeSubclientInvoices": <boolean> }'

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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

Akoonu ibeere naa

OrúkọIruTí a nílòKini o jẹ
includeSubclientInvoicesbooleanBẹẹniSee `updateXeroConnection`.

Idahun

OrúkọIruTí a nílòKini o jẹ
idUuidBẹẹkọUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<not_connected, connected, needs_reconnect, disconnected>Bẹẹni`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…
tenantNamestringBẹẹkọ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…
includeSubclientInvoicesbooleanBẹẹkọReseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
entitledbooleanBẹẹkọ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.
connectedAtstringBẹẹkọ
lastSyncAtstringBẹẹkọWhen a push last SUCCEEDED. Null means never — not "broken".
brokenSincestringBẹẹkọWhen it first stopped working, so "down for three weeks" is answerable.
lastErrorstringBẹẹkọA reason written for the customer. Never the vendor's error verbatim.
countsXeroSyncCountsBẹẹniHow this organization's invoices stand with Xero.

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 422 · 429