reseller

PUT `/v1/reseller/brand/invoice`

Set how your invoices read.

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение 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