agency-invoicing
GET /v1/agency-invoicing/profile
Your agency's invoicing identity — what an invoice says it is FROM.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز agency.invoicing.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
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`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id (query) | Uuid | خیر | 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… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
business_name | string | خیر | — |
address | string | خیر | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | خیر | — |
phone | string | خیر | — |
website | string | خیر | — |
tax_number_label | string | خیر | 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 | خیر | — |
payment_instructions | string | خیر | 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 | خیر | 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 | خیر | — |
default_currency | string | بله | — |
default_payment_terms_days | integer | خیر | — |
default_footer | string | خیر | — |
default_notes | string | خیر | — |
number_prefix | string | بله | — |
number_padding | integer | خیر | — |
next_number | integer | بله | 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 | خیر | What the next invoice will be called, e.g. `INV-0042`. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429