برگه دریافت



نام موجودیت : برگه دریافت
نام سیستمی: Receipt
مسیر api ها : https://app.samyarcloud2.ir/Receipt
کلید اصلی : ReceiptId

ویژگیها (properties) #

لیست فیلدهای موجودیت هدر برگه دریافت در زیر آمده است .

ویژگیعنواننوع ثبتنوعموجودیت اصلیشرح
ReceiptIdشناسهسیستمیint کلید اصلی (داخلی)
ReceiptNumberشماره برگهسیستمیint  
ReceiptDateتاریخ برگهاجباریdate  
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معین 
IsFirstچک اول دورهاجباریboolean  
IsCurrencyبرگه ارزیاجباریboolean  
CurrencyIdشناسه ارزاجباری مشروطintارزدر صورتی که برگه ارزی باشد اجباری است
ExchangeRateنرخ تبدیل ارزاجباریdecimal برای ریال برابر 1 خواهد بود
Currency_Titleعنوان ارزفقط خواندنیstring  
DocumentStatusوضعیت برگهسیستمیint سند نداردسند دارد
DocumentIdشناسه سندسیستمیintسند 
Document_Codeشماره سندفقط خواندنیstringسند 
ItemsTotalPriceجمع ریالی اقلامفقط خواندنیDecimal  
InvoiceIdشناسه فاکتور فروشسیستمیintفاکتور فروش 
InvoiceNumberشماره  فاکتور فروشفقط خواندنیintفاکتور فروش 
RetBuyIdشناسه فاکتور برگشت از خریدسیستمیintبرگشت از خرید 
RetBuyNumberشماره  فاکتور برگشت از خریدفقط خواندنیintبرگشت از خرید 
ProformaIdشناسه پیش فاکتورسیستمیintپیش فاکتور 
ProformaNumberشماره  پیش فاکتورفقط خواندنیintپیش فاکتور 
ReferenceIdشناسه برگه مرجعفقط خواندنیint  
ReferenceNumberشماره برگه مرجعفقط خواندنیint  
ReferenceTypeنوع برگه مرجعفقط خواندنیint  
ReferenceTitleعنوان برگه مرجعفقط خواندنیstring  
CreatedDateتاریخ ایجادسیستمیdate  
CreatedUserIDشناسه کاربر ایجاد کنندهاجباریintکاربران 
ModifiedDateتاریخ ویرایشسیستمیdate  
ModifiedUserIDشناسه کاربر ویرایش کنندهاجباریintکاربران 
Descriptionشرح برگهاختیاریstring  


متد گرفتن یک آیتم (Get) #

مسیر:  https://app.samyarcloud2.ir/Receipt /Get/{ReceiptId}
متد ارسال: GET
این متد کلید یک موجودیت را دریافت کرده و مقادیر مربوط با آن را برمی گرداند .

پارامترهای ورودی متد Get #

ReceiptId

Ex : https://app.samyarcloud1.ir/Receipt/Get/24

پارامترهای خروجی متد Get #

خروجی در صورت بروز خطا

{"Message":"شما دسترسی به این آیتم ندارید","MessageType":1}


خروجی در صورت موفقیت

{
  "MessageType": 0,
  "Message" :  null ,
  ReceiptId: 13
  ReceiptNumber: 11
  ReceiptDate: "2019-06-27T15:03:25.513"
  DetailId: 89
  Detail_Title: "مهدی علیزاده ثانی ..."
  Detail_FullCode: "1154"
  LedgerId: 95
  Ledger_Title: "جاری اشخاص"
  Ledger_FullCode: "617201"
  Level5Id: 257
  Level5_Title: "اشخاص - مشتریان اعتباری"
  Level5_FullCode: "8110"
  IsFirst: false
  IsCurrency: false
  CurrencyId: null
  ExchangeRate: 1
  Currency_Title: null
  DocumentStatus: 1
  DocumentStatusName: "پیش نویس"
  DocumentId: null
  Document_Code: null
  ItemsTotalPrice: 1000
  InvoiceId: null
  InvoiceNumber: null
  RetBuyId: null
  RetBuyNumber: null
  ProformaId: 4
  ProformaNumber: 3
  ReferenceId: 4
  ReferenceNumber: 3
  ReferenceType: "proforma"
  ReferenceTitle: "پیش فاکتور"
  CreatedDate: "2019-06-27T15:03:25.53"
  CreatedUserID: 2
  ModifiedDate: "2019-06-27T15:03:25.53"
  ModifiedUserID: 2
  Description: null
}


متد گرفتن همه آیتم ها (GetSome) #

مسیر:  https://app.samyarcloud2.ir/Proforma/GetSome
روش ارسال: POST

پارامترهای ورودی GetSome #

MasterId: 0 // استفاده نشده
Skip: 0 // استفاده نشده
Take: 200 // حداکثر تعداد آیتم های برگشتی
OrderField: SheetNumber // مرتب سازی بر اساس
Order: asc // صعودی یا نزولی
View: 1 // استفاده نشده


پارامترهای خروجی GetSome

{
  "itemCount": 23,
  "startTime": "2019/09/01 10: 00:11.1135", // زمان دریافت درخواست در سرور
  "endTime": "2019/09/01 10: 00:11.7785", // زمان پاسخ به درخواست در سرور
  "extra": ""
  "values": [
    {
      "MessageType": 0,
      "Message" :  null ,
      ReceiptId: 13
      ReceiptNumber: 11
      ReceiptDate: "2019-06-27T15:03:25.513"
      DetailId: 89
      Detail_Title: "مهدی علیزاده ثانی ..."
      Detail_FullCode: "1154"
      LedgerId: 95
      Ledger_Title: "جاری اشخاص"
      Ledger_FullCode: "617201"
      Level5Id: 257
      Level5_Title: "اشخاص - مشتریان اعتباری"
      Level5_FullCode: "8110"
      IsFirst: false
      IsCurrency: false
      CurrencyId: null
      ExchangeRate: 1
      Currency_Title: null
      DocumentStatus: 1
      DocumentStatusName: "پیش نویس"
      DocumentId: null
      Document_Code: null
      ItemsTotalPrice: 1000
      InvoiceId: null
      InvoiceNumber: null
      RetBuyId: null
      RetBuyNumber: null
      ProformaId: 4
      ProformaNumber: 3
      ReferenceId: 4
      ReferenceNumber: 3
      ReferenceType: "proforma"
      ReferenceTitle: "پیش فاکتور"
      CreatedDate: "2019-06-27T15:03:25.53"
      CreatedUserID: 2
      ModifiedDate: "2019-06-27T15:03:25.53"
      ModifiedUserID: 2
      Description: null
    },
    { "رکورد بعدی" },
    ...,
    { "رکورد آخر" }
  ]


متد جستجو #

مسیر :  https://app.samyarcloud2.ir/Receipt/GetSomeByMasterIdAndParams
روش ارسال:  POST
از این متد برای جستجوی چند برگه دریافت استفاده می شود .

پارامترهای ورودی #

MasterId: 0 // استفاده نشده
Skip: 0 // استفاده نشده
Take: 200 // حد اکثر تعداد آیتم خروجی
OrderField: 
SheetNumber // مرتب سازی بر اساس فیلد
Order: asc // صعودی یا نزولی
View: 1 // استفاده نشده
Force: false // استفاده نشده
parameters: // پارامترهای جستجو
{
  "params": null, // استفاده نشده
  "filter": {
	"FromReceiptNumber":"1",
	"ToReceiptNumber":"1",
	"FromReceiptDate":"2018-03-21",
	"ToReceiptDate":"2019-03-20",
	"Detail_Title":"آریا",
	"Level5_Title":"اشخاص",
	"Description":"بابت",
	"FromItemsTotalPrice":"1",
	"ToItemsTotalPrice":"100000000",
	"FromDocument_Code":"1",
	"ToDocument_Code":"1000",
	"ShowBlanksDocument_Code":true
   {     
}


پارامترهای خروجی #

مشابه GetSome

متد ایجاد #

مسیر : https://app.samyarcloud2.ir/Receipt/Create
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ایجاد هدر برگه دریافت در زیر آمده است .

پارامترهای ورودی متد ایجاد #


ReceiptDate: 2020-10-13T00:00:00+03:30
DetailId: 0
Detail_Lookup: 201;#1110 - فرهاد صولتی;#
LedgerId: 0
Ledger_Lookup: 99;#111204 - بدهکاران تجاری *;#{"HasDetail":true,"HasLevel5":false}
Level5Id: 0
Description: 
IsCurrency: false
ExchangeRate: 1
CurrencyId: 0
Currency_Lookup: 


پارامترهای خروجی متد ایجاد #

در صورتی که عملیات با موفقیت انجام شود MessageType برابر 3 و در صورتی که با خطا مواجه شود برابر 1 می باشد .

{
   "Detail_FullCode":"1110",
   "Detail_Title":"فرهاد صولتی",
   "Detail_Lookup":"201;#1110 - فرهاد صولتی",
   "Ledger_FullCode":"111204",
   "Ledger_Title":"بدهکاران تجاری",
   "Ledger_Lookup":"99;#111204 - بدهکاران تجاری",
   "Level5_FullCode":"",
   "Level5_Title":"",
   "Level5_Lookup":"",
   "DocumentStatusName":"پیش نویس",
   "Document_Code":null,
   "ItemsTotalPrice":0.0,
   "InvoiceId":null,
   "InvoiceNumber":null,
   "RetBuyId":null,
   "RetBuyNumber":null,
   "ProformaId":null,
   "ProformaNumber":null,
   "ReferenceId":null,
   "ReferenceNumber":null,
   "ReferenceType":null,
   "ReferenceTitle":null,
   "Currency_Title":null,
   "Currency_Lookup":"",
   "SuccessCount":0,
   "Message":"آیتم با موفقیت اضافه شد .",
   "MessageType":3,
   "CreatedDate":"2020-10-13T13:25:26.3409295",
   "CreatedUserID":2,
   "ModifiedDate":"2020-10-13T13:25:26.340945",
   "ModifiedUserID":2,
   "ReceiptId":40,
   "ReceiptNumber":30,
   "ReceiptDate":"2020-10-13T00:00:00",
   "DetailId":201,
   "Detail":null,
   "Level5Id":0,
   "Level5":null,
   "DocumentStatus":1,
   "DocumentId":null,
   "Description":null,
   "PricesHead":null,
   "IsFirst":false,
   "IsCurrency":false,
   "CurrencyId":null,
   "ExchangeRate":1.000,
   "LedgerId":99,
   "Ledger":null
}


متد ویرایش #

مسیر : https://app.samyarcloud2.ir/Receipt/Update
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ویرایش هدر یک فاکتور جدید در زیر آمده است .
برای به روز رسانی فقط ReceiptId اجباری می باشد .

پارامترهای ورودی ویرایش #

ReceiptDate: 2020-10-13T00:00:00
DetailId: 201
Detail_Lookup: 201;#1110 - فرهاد صولتی
LedgerId: 99
Ledger_Lookup: 99;#111204 - بدهکاران تجاری
Level5Id: 0
Description: 
IsCurrency: false
ExchangeRate: 1
CurrencyId: 
Currency_Lookup: 
ReceiptId: 40
Message: 


پارامترهای خروجی ویرایش

مشابه متد ایجاد

متد حذف #

مسیر : https://app.samyarcloud2.ir/Receipt/Delete/{ReceiptId}
متد ارسال : POST

پارامترهای ورودی متد حذف #

ReceiptId
Ex : https://app.samyarcloud2.ir/Receipt/Delete/24


پارامترهای خروجی متد حذف #

در صورتی که عملیات با موفقیت انجام شود MessageType برابر 3 و در صورتی که با خطا مواجه شود برابر 1 می باشد .

{
  "MessageType": 1,
  "Message": "به دلیل وجود اطلاعات وابسته امکان حذف وجود ندارد.",
  "ReceiptId": 24
}

Powered by BetterDocs