Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran reseller.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X PUT https://api.zinndigital.com/v1/reseller/brand/invoice \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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®.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
org_id (query) | Uuid | Tidak | 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… |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
footer_text | string | Tidak | Small print at the foot of the document — typically your registered company name and number. |
payment_terms | string | Tidak | When and how you expect to be paid. |
payment_details | string | Tidak | Remittance details — account name, IBAN, BIC, a payment link. Line breaks are preserved exactly as you type them. |
support_contact | string | Tidak | Where your client asks about this invoice. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
configured | boolean | Ya | False when your clients are still invoiced under Zinn Digital®, in which case there is nothing here to set. |
legal_entity_name | string | Ya | The company these invoices are issued by. |
footer_text | string | Ya | — |
payment_terms | string | Ya | — |
payment_details | string | Ya | — |
support_contact | string | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 422 · 429