Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте reseller.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде 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®.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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… |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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