agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar agency.invoicing.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`org_id (query)`	`Uuid`	Hayır	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…

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`business_name`	`string`	Hayır	—
`address`	`string`	Hayır	—
`email`	`string`	Hayır	—
`phone`	`string`	Hayır	—
`website`	`string`	Hayır	—
`tax_number_label`	`string`	Hayır	—
`tax_number`	`string`	Hayır	—
`payment_instructions`	`string`	Hayır	—
`logo_sha256`	`string`	Hayır	—
`accent_colour`	`string`	Hayır	—
`default_currency`	`string`	Hayır	—
`default_payment_terms_days`	`integer`	Hayır	—
`default_footer`	`string`	Hayır	—
`default_notes`	`string`	Hayır	—
`number_prefix`	`string`	Hayır	—
`number_padding`	`integer`	Hayır	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`business_name`	`string`	Hayır	—
`address`	`string`	Hayır	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	Hayır	—
`phone`	`string`	Hayır	—
`website`	`string`	Hayır	—
`tax_number_label`	`string`	Hayır	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`	Hayır	—
`payment_instructions`	`string`	Hayır	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`	Hayır	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`	Hayır	—
`default_currency`	`string`	Evet	—
`default_payment_terms_days`	`integer`	Hayır	—
`default_footer`	`string`	Hayır	—
`default_notes`	`string`	Hayır	—
`number_prefix`	`string`	Evet	—
`number_padding`	`integer`	Hayır	—
`next_number`	`integer`	Evet	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`	Hayır	What the next invoice will be called, e.g. `INV-0042`.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422 · 429