نام موجودیت : آیتم برگه دریافت
نام سیستمی : ReceiptItem
مسیر api ها : https://app.samyarcloud1.ir/ ReceiptItem
کلید اصلی : ReceiptItemId
ویژگیها (properties)
لیست فیلدهای موجودیت آیتم برگه دریافت در زیر آمده است .
ویژگی | عنوان | نوع ثبت | نوع | موجودیت اصلی | شرح |
ReceiptItemId | شناسه | سیستمی | int | کلید اصلی (داخلی) | |
ReceiptId | شناسه برگه دریافت | اجباری | int | برگه دریافت | |
Receipt_DocumentStatus | وضعیت صدور سند برگه دریافت | سیستمی | int | برگه دریافت | سند نداردسند دارد |
Receipt_Number | شماره برگه دریافت | سیستمی | int | برگه دریافت | |
Type | نوع | اجباری | int | نقدچک | |
TypeName | نام نوع | فقط خواندنی | string | ||
ReceiptItemNumber | شماره چک یا نقد | اجباری مشروط | string | در صورتی که چک باشد اجباری است | |
ReceiptItemDate | تاریخ سررسید چک | اجباری | date | ||
Price | مبلغ نقد یا چک | اجباری | decimal | ||
DetailId | شناسه حساب دریافت کننده | اجباری | int | تفصیلی | |
Detail_FullCode | کد کامل حساب دریافت کننده | فقط خواندنی | string | تفصیلی | |
Detail_Title | عنوان حساب دریافت کننده | فقط خواندنی | string | تفصیلی | سیستمی و فقط خواندنی |
Level5Id | شناسه تفصیلی 2 دریافت کننده | اجباری مشروط | int | تفصیلی | اگر معین تفصیلی 2 پذیر باشد اجباری می باشد |
Level5_FullCode | کد کامل تفصیلی 2 دریافت کننتده | فقط خواندنی | string | تفصیلی | |
Level5_Title | عنوان تفصیلی 2 دریافت کننده | فقط خواندنی | string | تفصیلی | فقط خواندنی |
Ledger_FullCode | کد کامل معین دریافت کننده | فقط خواندنی | string | معین | |
Ledger_Title | عنوان معین دریافت کننده | فقط خواندنی | string | معین | |
Ledger_Id | شناسه معین دریافت کننده | اجباری | int | معین | |
ChequeBankId | شناسه بانک چک | اختیاری | int | ||
ChequeBank_Title | عنوان بانک چک | فقط خواندنی | string | ||
ChequeAccountNumber | شماره حساب چک | اختیاری | string | ||
ChequeAccountOwner | نام صاحب چک | اختیاری | string | ||
CashPaymentType | نوع پرداخت | اختیاری | int | 1 = آنلاین 2 = فیش یا کارت به کارت | |
CashPaymentSubType | ریز نوع پرداخت | اختیاری | int | null = پرداخت نشده آنلاین = 1 کارت به کارت = 2, POS = 3, فیش = 4, USSD = 5, انتقال = 6 | |
CashTransferType | نوع انتقال | اختیاری | int | 1 = عادی 2 = ساتنا 3 = پایا | |
ChequeCity | شهر چک | اختیاری | string | ||
CashPayer | پرداخت کننده | اختیاری | string | ||
CashCardNumber | شماره کارت پرداخت کننده | اختیاری | string | ||
CashReferenceNumber | شماره مرجع | اختیاری | string | ||
CashFichNumber | شماره فیش واریزی | اختیاری | string | ||
CashReceiverNumber | شماره دریات کننده | اختیاری | string | ||
CashTrackingNumber | شناسه ردگیری | اختیاری | string | ||
CashTerminalNumber | شماره پایانه | اختیاری | string | ||
CashAccountNumber | شماره حساب پرداخت آنلاین | اختیاری | string | ||
CashMobile | شماره موبایل پرداخت آنلاین(ussd) | اختیاری | string | ||
LatestChequeHistoryId | شناسه آخرین سابقه چک | سیستمی | Int | ||
CreatedDate | تاریخ ایجاد | سیستمی | date | ||
CreatedUserID | شناسه کاربر ایجاد کننده | اجباری | int | کاربران | |
ModifiedDate | تاریخ ویرایش | سیستمی | date | ||
ModifiedUserID | شناسه کاربر ویرایش کننده | اجباری | int | کاربران |
متد گرفتن همه آیتم های یک برگه دریافت
مسیر: https://app.samyarcloud1.ir/ReceiptItem/GetSomeByMasterId
روش ارسال: POST
نکته : پارامتر MasterId بایستی با ReceiptId پر شود
پارامترهای ورودی
MasterId: 25 // شناسه برگه دریافت
Skip: 0 // استفاده نشده
Take: 10000 // حداکثر تعداد آیتم برگشتی
OrderField: // استفاده نشده
Order: // استفاده نشده
View: 1 // استفاده نشده
Force: false // استفاده نشده
parameters:
پارامترهای خروجی
{
"itemCount": 1,
"values": [
{
ReceiptItemId: 9
ReceiptId: 7
Receipt_Number: 5
Receipt_DocumentStatus: 2
Type: 2
TypeName: "چک"
ReceiptItemNumber: "12453"
ReceiptItemDate: "2019-01-21T00:00:00"
DetailId: 88
Detail_FullCode: "121"
Detail_Title: "اسناد دریافتنی نزد صندوق ..."
Level5Id: 0
Level5_FullCode: "01"
Level5_Title: ""
LedgerId: 41
Ledger_FullCode: "111202"
Ledger_Title: "اسناد دریافتنی"
PaymentId : null
Price: 10900000
ChequeBankId: null
ChequeBank_Title: null
ChequeAccountNumber: null
ChequeAccountOwner: null
ChequeCity: null
LatestChequeHistoryId: null
CashPayer: null
CashCardNumber: null
CashReferenceNumber: null
CashFichNumber: null
CashReceiverNumber: null
CashTrackingNumber: null
CashTerminalNumber: null
CashAccountNumber: null
CashPaymentSubType: null
CashMobile: null
CashTransferType: null
CashPaymentType: null
CreatedDate: "2018-09-05T15:23:10.4743376"
CreatedUserID: 2
ModifiedDate: "2018-09-05T15:23:10.4743376"
ModifiedUserID: 2
Message: null
MessageType: 0
}
],
"startDate": "2019-09-01T13:41:43.442497+04:30",
"endDate": "2019-09-01T13:41:44.7235019+04:30",
"extra": null
}
متد ایجاد
مسیر : https://app.samyarcloud2.ir/ReceiptItem/Create
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ایجاد هدر برگه دریافت در زیر آمده است .
پارامترهای ورودی متد ایجاد
Type: 1
ReceiptId: 0
Receipt_Lookup: 39
ReceiptItemNumber: 10
ReceiptItemDate:
Price: 850000
ChequeBankId: 0
ChequeBank_Lookup:
ChequeAccountNumber:
ChequeAccountOwner:
ChequeCity:
DetailId: 0
Detail_Lookup: 1;#131 - صندوق مرکزی ;#
Level5Id: 0
LedgerId: 0
Ledger_Lookup: 1;#111001 - صندوق ها;#{"HasDetail":true,"HasLevel5":false}
CashPayedPrice: 0
CashPayer:
CashCardNumber:
CashReferenceNumber:
CashFichNumber:
CashReceiverNumber:
CashTrackingNumber:
CashTerminalNumber:
CashAccountNumber:
CashPaymentSubType: -1
CashMobile:
CashTransferType:
پارامترهای خروجی متد ایجاد
در صورتی که عملیات با موفقیت انجام شود MessageType برابر 3 و در صورتی که با خطا مواجه شود برابر 1 می باشد .
{
CashAccountNumber: null,
CashCardNumber: null,
CashFichNumber: null,
CashMobile: null,
CashPayer: null,
CashPaymentSubType: -1,
CashPaymentSubTypeStr: "",
CashPaymentType: null,
CashReceiverNumber: null,
CashReferenceNumber: null,
CashTerminalNumber: null,
CashTrackingNumber: null,
CashTransferType: null,
ChequeAccountNumber: null,
ChequeAccountOwner: null,
ChequeBank: null,
ChequeBankId: null,
ChequeBank_Lookup: "",
ChequeBank_Title: null,
ChequeCity: null,
CreatedDate: "2020-10-13T10:10:02.6785505",
CreatedUserID: 2,
Detail: null,
DetailId: 1,
Detail_FullCode: "131",
Detail_Lookup: "1;#131 - صندوق مرکزی ",
Detail_Title: "صندوق مرکزی ",
LatestChequeHistoryId: null,
Ledger: null,
LedgerId: 1,
Ledger_FullCode: "111001",
Ledger_Lookup: "1;#111001 - صندوق ها",
Ledger_Title: "صندوق ها",
Level5: null,
Level5Id: 0,
Level5_FullCode: "",
Level5_Lookup: "",
Level5_Title: "",
Message: "آیتم با موفقیت اضافه شد .",
MessageType: 3,
ModifiedDate: "2020-10-13T10:10:02.6785711",
ModifiedUserID: 2,
PaymentId: null,
Price: 850000,
Receipt: null,
ReceiptId: 39,
ReceiptItemDate: null,
ReceiptItemId: 25,
ReceiptItemNumber: "10",
Receipt_DocumentStatus: 1,
Receipt_Lookup: "39;#29",
Receipt_Number: 29,
Type: 1,
TypeName: "نقد"
}
متد ویرایش
مسیر : https://app.samyarcloud2.ir/ReceiptItem/Update
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ویرایش هدر آیتم دریافت در زیر آمده است .
پارامترهای ورودی متد ویرایش
Type: 1
ReceiptId: 39
Receipt_Lookup: 39;#29
ReceiptItemNumber: 10
ReceiptItemDate:
Price: 860000
ChequeBankId:
ChequeBank_Lookup:
ChequeAccountNumber:
ChequeAccountOwner:
ChequeCity:
DetailId: 1
Detail_Lookup: 1;#131 - صندوق مرکزی
Level5Id: 0
LedgerId: 1
Ledger_Lookup: 1;#111001 - صندوق ها
CashPayedPrice: 0
CashPayer:
CashCardNumber:
CashReferenceNumber:
CashFichNumber:
CashReceiverNumber:
CashTrackingNumber:
CashTerminalNumber:
CashAccountNumber:
CashPaymentSubType: -1
CashMobile:
CashTransferType:
CashPaymentType:
ReceiptItemId: 25
Message:
پارامترهای خروجی متد ویرایش
در صورتی که عملیات با موفقیت انجام شود MessageType برابر 3 و در صورتی که با خطا مواجه شود برابر 1 می باشد .
مشابه ایجاد
متد حذف
مسیر : https://app.samyarcloud2.ir/Receipt/Delete/{ReceiptId}
متد ارسال : POST
پارامترهای ورودی متد حذف
ReceiptId
Ex : https://app.samyarcloud2.ir/ReceiptItem/Delete/24
پارامترهای خروجی متد حذف
در صورتی که عملیات با موفقیت انجام شود MessageType برابر 3 و در صورتی که با خطا مواجه شود برابر 1 می باشد .
{
مشابه ایجاد (با مقادیر خالی) حاوی شناسه آیتم حذف شده
}