הפקת מסמכים ממערכת אחרת (API)

שלב אחרי שלב

1. מפתח: «הגדרות» ← «חיבור מערכות» ← «הנפקת מפתח». המפתח מוצג פעם אחת. כל קריאה נושאת את הכותרת Authorization: Bearer ואחריה המפתח.
2. לקוח חדש: POST ל-/api/integration/clients, ובגוף name, ואם יש גם email, phone ו-taxId. בתשובה מגיע client.id. חיפוש: GET לאותה כתובת עם q.
3. מסמך: POST ל-/api/integration/documents, ובגוף reference (המזהה של המסמך אצלכם), type, ו-clientId או clientName. התוכן הוא description ו-amountBeforeVat, או lines עם description, quantityMilli ו-unitPrice.
4. התשובה מחזירה id, number, totalAmount ו-shareUrl, קישור למסמך שאפשר לשלוח ללקוח.
5. שליחה במייל עם ה-PDF: POST ל-/api/integration/documents/ ואחריו ה-id ו-/email. בלי to המייל הולך ללקוח השמור. קריאת מסמך: GET ל-/api/integration/documents/ ואחריו ה-id.

כדאי לדעת

• אותו reference לא מפיק פעמיים. שליחה חוזרת מחזירה את המסמך הראשון עם replayed: true, כי מסמך ממוספר אי אפשר למחוק.
• תשובה עם הקוד IN_PROGRESS או UNKNOWN_OUTCOME אומרת שאולי המסמך כבר הופק. בודקים במסך המסמכים לפני ששולחים reference אחר.
• סכומים באגורות: 10000 הם ₪100. amountBeforeVat ו-unitPrice לפני מע״מ, ו-quantityMilli באלפיות: 1000 היא יחידה אחת.
• סוג המסמך: עוסק פטור RECEIPT, עוסק מורשה וחברה TAX_INVOICE או TAX_INVOICE_RECEIPT. אמצעי התשלום ב-paymentMethod: CASH, BANK, CARD, BIT, CHECK או OTHER.
• אותם כללים כמו במסך: תאריך, תקרת מזומן, ופרטי עסק חסרים נדחים עם הודעה שמסבירה מה לתקן, ואז אפשר לשלוח שוב את אותו reference.
• חיבור API כלול במסלול «עסק מלא».

קשור לנושא

• גבייה באתר שלכם, דרך CARDIT