Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar billing.view 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 GET https://api.zinndigital.com/v1/billing/profile \
-H "Authorization: Bearer zdk_live_…"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
Returns the customer's one "Bill to" block — what renders on the next invoice (docs/34 §2.5). An organization that has never saved one gets a **200 with an empty profile** (every field blank, `updated_at` null), not a 404, so the form always has a shape to render. Requires `billing.view`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
org_id (query) | Uuid | Hayır | The organization whose profile to read; defaults to the caller's own. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
org_id | string | Evet | — |
legal_name | string | Evet | — |
company_name | string | Evet | — |
billing_address | BillingAddress | Evet | A billing address. Everything is optional **except** `country`, which tax determination needs (docs/34 §2.2). `country` is an ISO 3166-1 alpha-2 code, uppercased by the server. |
vat_number | string | Evet | — |
vat_status | string<unvalidated, pending, valid, invalid> | Evet | State of the validate-not-trust check on `vat_number` (docs/34 §2.3). Read-only; a change to `vat_number` resets it to `unvalidated`. |
tax_id | LabelValue | Hayır | A free-label secondary tax id (US EIN, AU ABN, …). Null when unset. |
custom_invoice_fields | LabelValue[] | Evet | Up to five customer-defined `{label, value}` lines, rendered verbatim. |
billing_email | string | Evet | Where invoices are delivered; blank means the account email. |
invoice_locale | string | Evet | Preferred invoice language; blank means the account language. |
updated_at | string | Hayır | When the profile was last saved. Null if it has never been saved. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 422 · 429