agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

Ìfàṣẹ́pọ̀

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

Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí

Oju-iwọle yii nlo org_id gẹgẹbi ayẹwo ibeere. Fi silẹ ni ita yoo si bo igi iyalo rẹ lapapọ; ranṣẹ si lati dín ibeere naa kù si ajọ kan.

Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.

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/agency-invoicing/profile \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Ṣé 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ẹ̀

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

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`org_id (query)`	`Uuid`	Bẹẹkọ	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…

Akoonu ibeere naa

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`business_name`	`string`	Bẹẹkọ	—
`address`	`string`	Bẹẹkọ	—
`email`	`string`	Bẹẹkọ	—
`phone`	`string`	Bẹẹkọ	—
`website`	`string`	Bẹẹkọ	—
`tax_number_label`	`string`	Bẹẹkọ	—
`tax_number`	`string`	Bẹẹkọ	—
`payment_instructions`	`string`	Bẹẹkọ	—
`logo_sha256`	`string`	Bẹẹkọ	—
`accent_colour`	`string`	Bẹẹkọ	—
`default_currency`	`string`	Bẹẹkọ	—
`default_payment_terms_days`	`integer`	Bẹẹkọ	—
`default_footer`	`string`	Bẹẹkọ	—
`default_notes`	`string`	Bẹẹkọ	—
`number_prefix`	`string`	Bẹẹkọ	—
`number_padding`	`integer`	Bẹẹkọ	—

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`business_name`	`string`	Bẹẹkọ	—
`address`	`string`	Bẹẹkọ	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	Bẹẹkọ	—
`phone`	`string`	Bẹẹkọ	—
`website`	`string`	Bẹẹkọ	—
`tax_number_label`	`string`	Bẹẹkọ	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`	Bẹẹkọ	—
`payment_instructions`	`string`	Bẹẹkọ	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`	Bẹẹkọ	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`	Bẹẹkọ	—
`default_currency`	`string`	Bẹẹni	—
`default_payment_terms_days`	`integer`	Bẹẹkọ	—
`default_footer`	`string`	Bẹẹkọ	—
`default_notes`	`string`	Bẹẹkọ	—
`number_prefix`	`string`	Bẹẹni	—
`number_padding`	`integer`	Bẹẹkọ	—
`next_number`	`integer`	Bẹẹni	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`	Bẹẹkọ	What the next invoice will be called, e.g. `INV-0042`.

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

401 · 403 · 404 · 422 · 429