agency-invoicing
GET /v1/agency-invoicing/profile
Your agency's invoicing identity — what an invoice says it is FROM.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit agency.invoicing.view ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Tashkilotingiz identifikatori kiritiladigan joy
Bu soʻrovnoma oxiri org_id parametrini soʻrov parametri sifatida qabul qiladi. Uni kiritmasangiz, chaqiruv butun ijarachi quyi daraxtingizni qamrab oladi; uni bitta tashkilotga cheklash uchun yuboring.
Tashkilotingiz identifikatori boshqaruv panelingizdagi API kalitlari ekranida, kalitning o'z yonida joylashgan. Bu siz amalga oshiradigan har bir so'rovda bir xil identifikator hisoblanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…"Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
Your registered name, address, tax number, logo, brand colour, defaults and your OWN invoice number series. ⛔ Separate from your panel branding: an invoice needs a legal entity, and you may bill under a different one from the one on your dashboard. Requires `agency.invoicing.view`.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
org_id (query) | Uuid | Yo'q | 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… |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
business_name | string | Yo'q | — |
address | string | Yo'q | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | Yo'q | — |
phone | string | Yo'q | — |
website | string | Yo'q | — |
tax_number_label | string | Yo'q | 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 | Yo'q | — |
payment_instructions | string | Yo'q | 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 | Yo'q | 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 | Yo'q | — |
default_currency | string | Ha | — |
default_payment_terms_days | integer | Yo'q | — |
default_footer | string | Yo'q | — |
default_notes | string | Yo'q | — |
number_prefix | string | Ha | — |
number_padding | integer | Yo'q | — |
next_number | integer | Ha | 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 | Yo'q | What the next invoice will be called, e.g. `INV-0042`. |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 429