آیتم پیش فاکتور

نام موجودیت :آیتم پیش فاکتور
نام سیستمی : ProformaItem
مسیر api ها : https://accounting.samyar.cloud/ProformaItem
کلید اصلی : ProformaItemId

ویژگیها (properties)

لیست فیلدهای موجودیت آیتم پیش فاکتور در زیر آمده است.

ویژگی	عنوان	نوع ثبت	نوع	موجودیت اصلی	شرح
ProformaItemId	شناسه	سیستمی	int		کلید اصلی (داخلی)
ProformaId	شناسه پیش فاکتور	اجباری	int	پیش فاکتور
Proforma_Number	شماره پیش فاکتور	سیستمی	int	پیش فاکتور
WarehouseId	شناسه انبار	اجباری	int	انبار
Warehouse_Code	شماره انبار	فقط خواندنی	int	انبار
Warehouse_Title	عنوان انبار	فقط خواندنی	string	انبار
GoodsId	شناسه کالا	اجباری	int	کالا
Goods_FullCode	کد کالا	فقط خواندنی	string	کالا
Goods_Title	عنوان کالا	فقط خواندنی	string	کالا
HasVAT	مشمول مالیات	سیستمی	boolean		کالا مشمول مالیات است
BaseUnitId	شناسه واحد اصلی	سیستمی	int	واحد کالا
BaseUnit_Title	عنوان واحد اصلی	فقط خواندنی	string	واحد کالا
BaseAmount	مقدار بر اساس واحد اصلی	سیستمی	decimal		مثال : 1200 گرم معادل 1.2 کیلوگرم می باشد . در این مثال واحد اصلی کیلوگرم و واحد فرعی گرم است . مقدار بر اساس واحد اصلی 1.2 می باشد
UnitId	شناسه واحد	اجباری	int	واحد کالا
Unit_Title	عنوان واحد	فقط خواندنی	string	واحد کالا
Amount	مقدار کالا	اجباری	int	واحد کالا
DiscountPrice	مبلغ تخفیف قلم	اختیاری	decimal		از درصد و مبلغ فقط یکی باید پر شود
DiscountPrice	درصد تخفیف قلم	اختیاری	decimal		از درصد و مبلغ فقط یکی باید پر شود
PureDiscount	درصد یا مبلغ تخفیف	فقط خواندنی	decimal		جهت استفاده داخلی
Price	مبلغ	اجباری	decimal		مبلغ یک واحد از کالا
PriceList DiscountPrice	تخفیف لیست قیمت	فقط خواندنی	decimal	لیست قیمت
PriceLocked	قفل قیمت	فقط خواندنی	boolean	لیست قیمت
PriceLocked	قفل قیمت	فقط خواندنی	boolean	لیست قیمت
Description	شرخ آیتم	اختیاری	string
CreatedDate	تاریخ ایجاد	سیستمی	date
CreatedUserID	شناسه کاربر ایجاد کننده	اجباری	int	کاربران
ModifiedDate	تاریخ ویرایش	سیستمی	date
ModifiedUserID	شناسه کاربر ویرایش کننده	اجباری	int	کاربران

---

متد ایجاد

مسیر : https://accounting.samyar.cloud/ProformaItem/Create
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ایجاد هدر یک فاکتور جدید در زیر آمده است .

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

ProformaItemId: -1 // برای ایجاد باید -1 باشد
ProformaId: 25 // شناسه هدر
WarehouseId: 5
GoodsId: 7
UnitId: 8
Amount: 2
Price: 100000000
DiscountPrice: 6000000
DiscountPercent: 3
Description: تخفیف بابت خوش حسابی

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

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

{
  "Message": "متن خطا",
  "MessageType": 2,
  "ProformaItemId": 28,
  "ProformaId": 25,
  "Proforma_Number": 22,
  "Warehouse_Code": 1,
  "Warehouse_Title": "انبار مرکزی",
  "Goods_FullCode": "10031",
  "Goods_Title": " لباس شویی 1200 دور",
  "Goods_Lookup": "7;#10031 -  لباس شویی 1200 دور;#8",
  "Unit_Title": "دستگاه",
  "BaseUnitId": 8,
  "BaseUnit_Title": "دستگاه",
  "BaseAmount": 2.000000000000,
  "PureDiscount": 3.00,
  "PriceLocked": false,
  "PriceListDiscountPrice": 0.0,
  "CreatedDate": "2019-09-01T12:58:02.907481",
  "CreatedUserID": 2,
  "ModifiedDate": "2019-09-01T12:58:02.9074918",
  "ModifiedUserID": 2,
  "Amount": 2.000000,
  "WarehouseId": 5,
  "GoodsId": 7,
  "UnitId": 8,
  "Price": 100000000.00000000,
  "DiscountPrice": 6000000.00000000,
  "DiscountPercent": 3.00,
  "HasVAT": true,
  "Description": null
}

---

متد ویرایش

مسیر : https://accounting.samyar.cloud/ProformaItem/Update
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ویرایش آیتم فاکتور جدید در زیر آمده است .
نکته : در صورتی که DiscountPercent خالی باشد تخفیف ریالی و در صورتی که پر باشد تخفیف درصدی در نظر گرفته می شود .

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

ProformaItemId: 28
ProformaId: 25
WarehouseId: 5
GoodsId: 7
UnitId: 8
Amount: 1
Price: 100000000
DiscountPrice: 3000000
DiscountPercent: 3
PureDiscount: 3
DiscountType: 
Description: 

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

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

---

متد حذف

مسیر : https://accounting.samyar.cloud/ProformaItem/Delete/{ProformaItemId}
متد ارسال : POST

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

ProformaItemId
Ex : https://accounting.samyar.cloud/ProformaItem/Delete/28

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

{
ProformaItemId: 28
Message: "آیتم با موفقیت حذف شد ."
MessageType: 3
}

---

متد گرفتن همه آیتم های یک فاکتور

مسیر : https://accounting.samyar.cloud/ProformaItem/GetSomeByMasterId
روش ارسال : POST
نکته : پارامتر MasterId بایستی با ProformaId پر شود

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

MasterId: 25 // شناسه فاکتور
Skip: 0 // استفاده نشده
Take: 10000 // حداکثر تعداد آیتم برگشتی
OrderField: // استفاده نشده
Order: // استفاده نشده
View: 1 // استفاده نشده
Force: false // استفاده نشده
parameters:

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

{
  "itemCount": 1,
  "values": [
    {
      "Proforma_Number": 22,
      "Warehouse_Code": 5,
      "Warehouse_Title": "انبار مواد اولیه",
      "Goods_FullCode": "14012",
      "Goods_Title": "قفل",
      "Unit_Title": "عدد ",
      "BaseUnitId": 1,
      "BaseUnit_Title": "عدد ",
      "BaseAmount": 500.000000000000,
      "PureDiscount": 120.00000000,
      "PriceLocked": false,
      "PriceListDiscountPrice": 0.0,
      "CreatedDate": "2018-09-08T10:04:50.7163061",
      "CreatedUserID": 2,
      "ModifiedDate": "2019-09-01T11:58:03.9605961",
      "ModifiedUserID": 2,
      "ProformaItemId": 27,
      "ProformaId": 25,
      "Amount": 500.000000,
      "WarehouseId": 9,
      "GoodsId": 36,
      "UnitId": 1,
      "Price": 10000.00000000,
      "DiscountPrice": 120.00000000,
      "DiscountPercent": null,
      "HasVAT": true,
      "Description": null
    }
  ],
  "startDate": "2019-09-01T13:41:43.442497+04:30",
  "endDate": "2019-09-01T13:41:44.7235019+04:30",
  "extra": null
}