1. יצירת מסמך
נתונים שהמתממשק אמור לשמור ברמת הלקוח
א. מפתח זיהוי של החברה שיסופק ע"י CloudERP (טקסטואלי באורך עד 100 תווים)
ב. webServerUrl כתובת שרת יעד (עבור לקוחות עם סביבה משלהם)
בד"כ יהיה:
פורמט :
הRequest שמפורט למטה יהיה "עטוף" באובייקט שמכיל מפתח מזהה ללקוח (token), כל הבקשה עצמה וחתימה של הבקשה.
פרמטר |
ערך |
||||||||||||
Url |
[webServerUrl]/api/Documents/SyncDocument |
||||||||||||
Method |
POST |
||||||||||||
Headers |
Content-Type:application/json; charset=utf-8 |
||||||||||||
Post body |
Json
|
| פרמטר | פרמטר במערך | סוג | חובה | ערך |
| DocumentNumber | מספרי | X | מספר מסמך | |
| BudgetId | מספרי | V | מזהה תקציב | |
| CreatingUserEmail | טקסטואלי | V | כתובת דוא"ל של המשתמש שיוצר את המסמך חובה שיהיה לו משתמש במערכת CloudERP |
|
| DocumentTypeId | מספרי | V | סוג מסמך (מספר מזהה כמו שסופק ע"י CloudERP) | |
| CustomerExternalId | טקסטואלי | V | מספר חיצוני של הלקוח | |
| ValueDate | תאריך (טקסט בפורמט yyyy-mm-dd) | X | תאריך ערך | |
| ExternalDocumentExternalId | מספרי | X | מספר מסמך חיצוני | |
| ReferenceDate | תאריך (טקסט בפורמט yyyy-mm-dd) | V | תאריך אסמכתא | |
| ExtraDate | תאריך ושעה (טקסט בפורמט yyyy-mm-ddThh:mm:ss) | X | תאריך פנימי/נוסף | |
| CustomerVatNumber | טקסטואלי | X | מספר ח.פ | |
| CustomerPhone | טקסטואלי | X | טלפון | |
| CustomerName | טקסטואלי | X | שם לקוח | |
| CustomerDetails | טקסטואלי | X | פרטי לקוח | |
| CustomerAddress | טקסטואלי | X | כתובת | |
| CustomerSortCode |
מספרי | X | קוד מיון לקוח | |
| Notes | טקסטואלי | X | הערות | |
| DeductionAmount |
מספרי | X | סכום ניכוי מס במקור (קבלה/מס קבלה/קבלה על תרומה בלבד) | |
| Items(Array) | V |
[לא להזנה בקבלה/קבלה על תרומה] |
||
| ExternalId | טקסטואלי | V | מספר מזהה חיצוני לפריט (קוד פריט) | |
| ItemName | טקסטואלי | V | שם פריט | |
| ItemDesc | טקסטואלי | X | תאור הפריט | |
| Quantity | מספרי | V | כמות פריטים | |
| SingleItemPrice | מספרי | V | סכום לפריט בודד (ללא מע"מ) | |
| VatExempt | בוליאני | X | פטור ממע"מ | |
| SingleItemPriceWithVat |
מספרי | V | סכום כולל מע"מ | |
| ApprovalRouteId | מספרי | X | מספר מזהה למסלול אישורים לפריט (מתוך מזהים שיסופקו ע"י CloudERP) | |
| DiscountPercent | מספרי | X | אחוז הנחה לפריט | |
| Ordinal | מספרי | X | מספר שורה | |
| CurrencyRate | מספרי | X | שער מטבע נוכחי | |
| CurrencyCode | טקסטואלי | X | קוד מטבע | |
| Notes | טקסטואלי | X | הערות על הרכישה ברמת הפריט | |
| Accounts(Array) | V |
[לא להזנה בקבלה/קבלה על תרומה] |
||
| ExternalId | מספרי |
V | מספר מזהה חיצוני לסעיף | |
| CostCode | טקסטואלי | X | מספר מזהה חיצוני לקוד תמחיר | |
| Amount | מספרי | V | סכום (ללא מע"מ) | |
| ValueDate | תאריך (טקסט בפורמט yyyy-mm-dd) |
X | תאריך ערך |
|
| ReferenceDate |
תאריך (טקסט בפורמט yyyy-mm-dd) |
X | תאריך אסמכתא |
|
| Recipts(Array) |
[לא להזנה במסמכים שהם לא קבלה/מס קבלה/קבלה על תרומה](בתשלומים - שורה לכל תשלום) |
|||
| BankNumber |
מספרי |
X | מספר בנק | |
| BankBranchNumber |
מספרי |
X | מספר סניף בנק | |
| AccountNumber |
מספרי |
X | מספר חשבון בנק | |
| ChequeNumber |
מספרי |
X | מספר צק | |
| DueDate |
תאריך (טקסט בפורמט yyyy-mm-dd) |
X | תאריך פירעון/ערך | |
| Amount |
מספרי |
V | סכום (כולל מע"מ) | |
| CreditCardCode |
X | IsraCard = 1, Cal = 2, Dyners = 3, American express = 4, Leumi card = 6, |
||
| CardName |
מספרי |
X | שם בעל כרטיס האשראי | |
| CreditPaymentType |
מספרי |
X | רגיל = 1, תשלומים = 2, קרדיט = 3, |
|
| PaymentMethodId |
מספרי |
X | מתוך הגדרות מערכת -> אמצעי תשלום |
מבנה ה Json של המסמך:
מבנה מהאקסל
Request Body Example:
{
"token":"jy8ConoZgQJHdcfu7oa1237tj0hv3LCMejsHm5HTwjaPGchgfv",
"sign":"09ce98789a89d15b2e60ab49b4ed74e868f41f34259009d36173f58babb8f25d",
"data":"{
\"DocumentNumber\": 800,
\"BudgetId\": 150,
\"CreatingUserEmail\": \"asd@asd.asd\",
\"DocumentTypeId\": 55,
\"CustomerExternalId\": \"12345678\",
\"ValueDate\": \"2016-05-25\",
\"Items\": [
{
\"ExternalId\": \"100\",
\"ItemName\": \"Item1\",
\"SingleItemPrice\": 10,
\"SingleItemPriceWithVat\": 10,
\"Quantity\": 4,
\"Notes\": \"asd\"
},
{
\"ExternalId\": \"101\",
\"ItemName\": \"Item2\",
\"ItemDesc\": \"Some desc\",
\"SingleItemPrice\": 100,
\"SingleItemPriceWithVat\": 117,
\"Quantity\": 2,
\"Notes\": \"asd2\"
}
],
\"Accounts\": [
{
\"ExternalId\": \"100\",
\"Amount\": 240
}
],
\"Recipts\": [
{
\"BankNumber\": 100,
\"BankBranchNumber\": 100,
\"AccountNumber\": 100,
\"ChequeNumber\": 100,
\"DueDate\": \"2016-05-25\",
\"Amount\": 240,
\"DeductionAmount\": 34,
\"CreditCardCode\": 100,
\"CardName\": \"Card name\",
\"CreditPaymentType\": 1,
\"PaymentMethodId\": 999
}
]
}"
}
Response ליצירת מסמך:
פרמטר |
סוג |
ערך |
DocumentId |
UUID |
מפתח מזהה של המסמך לצורך הפניה אליו |
דוגמא:
{DocumentId:9999}
קבלת סטטוס מסמך
פורמט:
פרמטר |
ערך |
|
Url |
[webServerUrl]/api/Documents/{DocumentTypeId}/{DocumentNumber}?token={token} |
|
Method |
GET |
|
DocumentTypeId |
מספרי |
מפתח מזהה של סוג המסמך לצורך הפניה אליו |
DocumentNumber |
מספרי |
מספר המסמך |
Response לסטטוס מסמך:
פרמטר |
ערך |
|
id |
מספרי |
מפתח מזהה של סוג המסמך לצורך הפניה אליו |
DocumentNumber |
מספרי |
מספר המסמך |
creationDate |
||
creatorEmail |
||
documentNumber |
||
customerName |
||
totalAmount |
||
associations |
||
דוגמא:
{
"id": 4920,
"creationDate": "2016-12-04T19:00:29.5186991",
"creatorEmail": "SomeUser@pqdev.com",
"documentNumber": 701,
"customerName": "אבג פרסום",
"totalAmount": 100.5,
"associations": [
{
"documentTypeAssociationId": 5,
"sourceDocumentCreator": "Some user",
"sourceDocumentType": "מס קבלה",
"associationCreator": "Some user",
"targetDocumentCreator": "Some user",
"documentTypeAssociation": "מס לעסקה",
"sourceDocumentNumber": 701,
"targetDocumentNumber": 1,
"targetDocumentType": "חשבון עסקה",
"sourceDocumentTotalAmount": 100.5,
"targetDocumentTotalAmount": 450652.05,
"associationAmount": 100.5
}
]
}
קבלת קובץ מסמך
פורמט:
פרמטר |
ערך |
|
Url |
[webServerUrl]/api/Documents/Download/{DocumentId}?token={token} |
|
Method |
GET |
|
DocumentId |
UUID |
מפתח מזהה של המסמך כמו שהתקבל מיצירת המסמך (SyncDocument) |
Token |
טקסטואלי חובה |
מפתח זיהוי מתוך הנתונים ברמת הלקוח |