agency-invoicing

POST `/v1/agency-invoicing/preview`

Total a set of lines without saving anything.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה agency.invoicing.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X POST https://api.zinndigital.com/v1/agency-invoicing/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "lines": <AgencyInvoiceLineWrite[]> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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`.

פרמטרים

שם	סוג	נדרש	מה זה
`org_id (query)`	`Uuid`	לא	Which 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…

גוף הבקשה

שם	סוג	נדרש	מה זה
`lines`	`AgencyInvoiceLineWrite[]`	כן	—

תשובה

שם	סוג	נדרש	מה זה
`line_totals_minor`	`integer[]`	לא	—
`subtotal_minor`	`integer`	כן	—
`discount_minor`	`integer`	לא	—
`tax_minor`	`integer`	כן	—
`total_minor`	`integer`	כן	—
`tax_groups`	`AgencyInvoiceTaxGroup[]`	לא	—

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429