reseller

PUT `/v1/reseller/brand/invoice`

Set how your invoices read.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک پارامتر پرس‌وجو می‌پذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجاره‌ای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X PUT https://api.zinndigital.com/v1/reseller/brand/invoice \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Requires `reseller.manage`. ⭐ These are printed on **your** invoices, under your company, your VAT number and your number series — so the payment details are yours. Your clients are charged on your own payment gateway and you are the merchant of record for them. ⛔ **Changing these does not change invoices already issued**, and must not: every value is frozen onto each document when it is raised. Restating where last month's invoice was payable would be a different demand for money under the same number. Refused with 422 when your clients are still invoiced under Zinn Digital®.

پارامترها

نام	نوع	الزامی	چیست
`org_id (query)`	`Uuid`	خیر	The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agen…

بدنه درخواست

نام	نوع	الزامی	چیست
`footer_text`	`string`	خیر	Small print at the foot of the document — typically your registered company name and number.
`payment_terms`	`string`	خیر	When and how you expect to be paid.
`payment_details`	`string`	خیر	Remittance details — account name, IBAN, BIC, a payment link. Line breaks are preserved exactly as you type them.
`support_contact`	`string`	خیر	Where your client asks about this invoice.

پاسخ

نام	نوع	الزامی	چیست
`configured`	`boolean`	بله	False when your clients are still invoiced under Zinn Digital®, in which case there is nothing here to set.
`legal_entity_name`	`string`	بله	The company these invoices are issued by.
`footer_text`	`string`	بله	—
`payment_terms`	`string`	بله	—
`payment_details`	`string`	بله	—
`support_contact`	`string`	بله	—

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 422 · 429

PUT /v1/reseller/brand/invoice