agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran agency.invoicing.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`org_id (query)`	`Uuid`	Tidak	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…

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`business_name`	`string`	Tidak	—
`address`	`string`	Tidak	—
`email`	`string`	Tidak	—
`phone`	`string`	Tidak	—
`website`	`string`	Tidak	—
`tax_number_label`	`string`	Tidak	—
`tax_number`	`string`	Tidak	—
`payment_instructions`	`string`	Tidak	—
`logo_sha256`	`string`	Tidak	—
`accent_colour`	`string`	Tidak	—
`default_currency`	`string`	Tidak	—
`default_payment_terms_days`	`integer`	Tidak	—
`default_footer`	`string`	Tidak	—
`default_notes`	`string`	Tidak	—
`number_prefix`	`string`	Tidak	—
`number_padding`	`integer`	Tidak	—

Respons

Nama	Jenis	Diperlukan	Apakah ia
`business_name`	`string`	Tidak	—
`address`	`string`	Tidak	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	Tidak	—
`phone`	`string`	Tidak	—
`website`	`string`	Tidak	—
`tax_number_label`	`string`	Tidak	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`	Tidak	—
`payment_instructions`	`string`	Tidak	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`	Tidak	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`	Tidak	—
`default_currency`	`string`	Ya	—
`default_payment_terms_days`	`integer`	Tidak	—
`default_footer`	`string`	Tidak	—
`default_notes`	`string`	Tidak	—
`number_prefix`	`string`	Ya	—
`number_padding`	`integer`	Tidak	—
`next_number`	`integer`	Ya	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`	Tidak	What the next invoice will be called, e.g. `INV-0042`.

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429