מוסכמות: סכומים, מזהים, קבצים

איך ה-API מייצג כסף, תאריכים, ספקים וקבצים.

כסף

סכומים הם מספרים שלמים באגורות: 1 ₪ = 100 אגורות, אז 3,500 ₪ הם 350000. אותו כלל לסנטים ב-USD וב-EUR. המטבעות הנתמכים: ILS (ברירת מחדל), USD, EUR.

מזהים

שדה	מה זה	מאיפה לוקחים
paymentId	תשלום לספק	`paymentsList`
docId	חשבונית שהועלתה או יובאה	`invoicesList`
supplierKey	ספק: טלפון בפורמט E.164 (`+9725…`) או אימייל	`suppliersList`
folderId	תיקיית חשבוניות	`foldersList`
accountId	חשבון דפי פירוט (Stripe, Mercury…) או תיבת Gmail	`*ListAccounts`, `gmailListAccounts`
vendorKey	המנפיק של חשבונית, לכללי תשלום וסיווג (`vat:…`, `email:…`)	`invoicesList`, `vendorRulesList`

סטטוסים של תשלום

sent (הלינק נשלח, ממתין לפרטי בנק), awaiting_invoice (פרטי בנק התקבלו, ממתין לחשבונית), ready (מוכן לתשלום), paid (שולם), canceled (בוטל).

תאריכים וחודשים

תאריכים חוזרים כמחרוזות ISO (2026-08-30T17:33:05.853Z). חודשים של דפי פירוט הם YYYY-MM ותמיד חודש סגור. since בייבוא מ-Gmail הוא unix millis.

קבצים

קובץ חוזר כקישור ב-https://files.askpay.co/<מזהה>/<שם הקובץ>. הקישור עצמו הוא ההרשאה: מי שמחזיק אותו יכול לפתוח את הקובץ, כמו לינק תשלום. מוסיפים ?download=1 להורדה כקובץ מצורף.

העלאות (חשבונית, הוכחת תשלום, טופס) נשלחות כשלושה שדות: fileName, mimeType ו-dataBase64 (הגוף ב-base64, בלי הקידומת data:). עד כ-5MB.

דפדוף

רשימות מקבלות limit (ברירת מחדל 50, עד 200) ו-offset, ומחזירות total.

מה מותר למי

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

עדיין תקועים? כתבו לנו ונענה מהר.