سند

نام موجودیت: سند
نام سیستمی: Document
مسیر api ها: https://app.samyarcloud2.ir/Document
کلید اصلی: DocumentId

ویژگیها: (properties)

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

ویژگی	عنوان	نوع ثبت	نوع	موجودیت اصلی	شرح
DocumentId	شناسه سند	سیستمی	int		کلید اصلی
DocumentCode	شماره سند	اختیاری	int
DocumentBaseCode	عطف	سیستمی	int
DocumentDate	تاریخ سند	اجباری	DateTime
Status	وضعیت سند	اجباری	int		1- موقت   2- دائم
Type	نوع سند	اجباری	int		1- افتتاحیه 2- عادی 3- بستن حسابها 4- اختتامیه
FinancialYearId	شناسه سال مالی	اجباری	int	سال مالی
DebtPrice	مبلغ بستانکار	فقط خواندنی	decimal		مجموع اقلام سند
CreditPrice	مبلغ بدهکار	فقط خواندنی	decimal		مجموع اقلام سند
CreatedDate	تاریخ ایجاد	سیستمی	date
CreatedUserID	شناسه کاربر ایجاد کننده	اجباری	int	کاربران
ModifiedDate	تاریخ ویرایش	سیستمی	date
ModifiedUserID	شناسه کاربر ویرایش کننده	اجباری	int	کاربران

متد ایجاد سند عادی

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

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

پارامترهای ورودی به صورت queryString ارسال می شود.

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

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

پارامترهای خروجی به صورت جیسون دریافت می شود.

“error”: false }

متد ایجاد سند اختتامیه

مسیر: https://app.samyarcloud2.ir/Document/CreateEndDocument
متد ارسال: GET
نمونه پارامترهای ارسالی جهت ایجاد سند در زیر آمده است.

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

پارامترهای ورودی به صورت queryString ارسال می شود:

DocumentDate: 2019-09-12T00:00:00-07:00
FinancialYearId: 4

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

در صورتی که عملیات با موفقیت انجام شود error برابر false و در صورتی که با خطا مواجه شده و انجام نشود برابر true خواهد بود.

پارامترهای خروجی به صورت جیسون دریافت می شود.

“error”: false

متد ایجاد سند اختتامیه

مسیر : https://app.samyarcloud2.ir/Document/CreateEndDocument
متد ارسال : GET
نمونه پارامترهای ارسالی جهت ایجاد سند در زیر آمده است .

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

پارامترهای ورودی به صورت queryString ارسال می شود.

DocumentDate: 2019-09-12T00:00:00-07:00
FinancialYearId: 4

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

در صورتی که عملیات با موفقیت انجام شود error برابر false و در صورتی که با خطا مواجه شده و انجام نشود برابر true خواهد بود.

پارامترهای خروجی به صورت جیسون دریافت می شود.

“error”: false

متد ایجاد سند بستن حساب ها

مسیر : https://app.samyarcloud2.ir/Document/CreateCloseAccountsDocument
متد ارسال : GET
نمونه پارامترهای ارسالی جهت ایجاد سند در زیر آمده است .

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

پارامترهای ورودی به صورت queryString ارسال می شود.

DocumentDate: 2019-09-12T00:00:00-07:00
FinancialYearId: 4

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

در صورتی که عملیات با موفقیت انجام شود error برابر false و در صورتی که با خطا مواجه شده و انجام نشود برابر true خواهد بود .

پارامترهای خروجی به صورت جیسون دریافت می شود.

“error”: false

متد تغییر تاریخ

مسیر : https://app.samyarcloud2.ir/Document/Update
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ویرایش در زیر آمده است .

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

پارامترهای ورودی به صورت Form Data ارسال می شود.

DocumentDate: 2019-07-11
DocumentId: 6818

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

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

متد تغییر شماره

مسیر : https://app.samyarcloud2.ir/Document/Update
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ویرایش در زیر آمده است .

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

پارامترهای ورودی به صورت Form Data ارسال می شود.

DocumentCode: 142
DocumentId: 6818

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

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

متد حذف

مسیر : https://app.samyarcloud2.ir/Document/LogicalDelete/{DocumentId}
متد ارسال : POST

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

DocumentId Ex : https://app.samyarcloud2.ir/Document/LogicalDelete/28

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

پارامترهای خروجی به صورت جیسون دریافت می شود.

  “DocumentId”: 5750,
  “Message”: “آیتم با موفقیت حذف شد .”,
  “MessageType”: 3
  “Status”: 1
  “StatusName”: “موقت”
  “Type”: 2
  “TypeName”: “عادی”

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

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

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

DocumentId Ex : https://app.samyarcloud2.ir/Document/Get/24

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

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

متد گرفتن همه اقلام یک سند(GetSomeByMasterId)

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

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

پارامترهای ورودی به صورت Form Data ارسال می شود.

   MasterId: 4 // سال مالی
    Skip: 0 // استفاده نشده
    Take: 10000 // حداکثر تعداد آیتم برگشتی
    OrderField: // استفاده نشده
    Order: // استفاده نشده
    View: 1  // 1- همه اسناد // 2- اسناد حذف شده // 3- اسناد ناقص
    Force: false // سیستمی

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

{ “itemCount”: 130, “values”: [ { “StatusName”: “موقت”, “TypeName”: “عادی”, “DebtPrice”: 0.0, “CreditPrice”: 0.0, “Locked”: 0, “User_Title”: “مدیر سیستم”, “FinancialYear_Title”: null, “AttachmentsEnabled”: false, “Message”: null, “MessageType”: 0, “CreatedDate”: “2019-09-13T22:07:17.343903”, “CreatedUserID”: 2, “ModifiedDate”: “2019-09-13T22:07:27.2510926”, “ModifiedUserID”: 2, “DocumentId”: -4602, “DocumentCode”: 142, “DocumentBaseCode”: 603, “DocumentDate”: “2019-09-13T00:00:00”, “Status”: 1, “Type”: 2, “FinancialYearId”: 4, “FinancialYear”: null }, … ], “startTime”: “2019/09/13 10: 22:32.6341”, “endTime”: “2019/09/13 10: 22:32.8152”, “extra”: “{\”OverallCount\”:130}” }