agency-invoicing

POST /v1/agency-invoicing/preview

Total a set of lines without saving anything.

Semua titik akhir agency-invoicing

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran agency.invoicing.view; 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 POST https://api.zinndigital.com/v1/agency-invoicing/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "lines": <AgencyInvoiceLineWrite[]> }'

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

Backs the live preview in the invoice builder. ⭐ It calls the SAME arithmetic the save path uses — a preview computed by a second implementation is one that can disagree with the invoice, and you would find out after you had sent it. Requires `agency.invoicing.view`.

Parameter

NamaJenisDiperlukanApakah ia
org_id (query)UuidTidakWhich 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…

Badan permintaan

NamaJenisDiperlukanApakah ia
linesAgencyInvoiceLineWrite[]Ya

Respons

NamaJenisDiperlukanApakah ia
line_totals_minorinteger[]Tidak
subtotal_minorintegerYa
discount_minorintegerTidak
tax_minorintegerYa
total_minorintegerYa
tax_groupsAgencyInvoiceTaxGroup[]Tidak

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429