کالا
نام موجودیت :کالا
نام سیستمی : Goods
مسیر api ها : https://accounting.hoofer.cloud/Goods
کلید اصلی : GoodsId
ویژگیها (properties)
لیست فیلدهای موجودیت کالا در زیر آمده است .
ویژگی | عنوان | نوع ثبت | نوع | موجودیت اصلی | شرح |
GoodsId | کد کالا | سیستمی | int | کلید اصلی | |
Code | کد کالا | اجباری | int | برای ایجاد کد کالا باید کد گروه و زیر گروه را قبل از این کد بیاوریم | |
GoodsGroup_GoodsGroupId | شناسه گروه کالا | فقط خواندنی | int | گروه کالا | |
GoodsGroup_Title | عنوان گروه کالا | فقط خواندنی | string | گروه کالا | |
GoodsGroup_Code | کد گروه کالا | فقط خواندنی | int | گروه کالا | |
GoodsSubGroupId | شناسه زیرگروه کالا | اجباری | int | زیرگروه کالا | |
GoodsSubGroup_Title | عنوان زیرگروه کالا | فقط خواندنی | string | زیرگروه کالا | |
GoodsSubGroup_Code | کد زیرگروه کالا | فقط خواندنی | int | زیرگروه کالا | |
UnitId | شناسه واحد | اجباری | int | واحد | |
Unit_Title | عنوان واحد | فقط خواندنی | string | واحد | |
GoodsType | نوع کالا | اجباری | int |
1- کالا 2- خدمات 3- محصول محصول نوعی از کالا است که می توان برای آن اجزا تعریف کرد |
|
CostOrIncome | هزینه یا درآمد | اجباری | int | 1- هزینه 2- درآمد |
|
TechnicalCode | کد فنی | اختیاری | int | ||
Barcode | بارکد | اختیاری | string | ||
ExternalCode | کد خارجی | اختیاری | string | کد مشترک با سی آر ام و ووکامرس | |
HasVAT | مشمول مالیات | اجباری | boolean | ||
OrderPoint | نقطه سفارش کالا | اختیاری | decimal | ||
Locked | مسدود است | اختیاری | boolean | ||
GoodsAmount | موجودی کالا | فقط خواندنی | decimal | ||
LastBuyPrice | آخرین قیمت خرید | فقط خواندنی | decimal | ||
LastSalePrice | آخرین قیمت فروش | فقط خواندنی | decimal | ||
CreatedDate | تاریخ ایجاد | سیستمی | date | ||
CreatedUserID | شناسه کاربر ایجاد کننده | اجباری | int | کاربران | |
ModifiedDate | تاریخ ویرایش | سیستمی | date | ||
ModifiedUserID | شناسه کاربر ویرایش کننده | اجباری | int | کاربران |
متد ایجاد
مسیر : https://accounting.hoofer.cloud/ِGoods/Create
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ایجاد کالا در زیر آمده است .
پارامترهای ورودی ایجاد
// پارامترهای ورودی به صورت Form Data ارسال می شود Code: 3 Title: مانیتور 21 اینچ GoodsSubGroupId: 1 UnitId: 1 OrderPoint: 10 Barcode: ExternalCode: TechnicalCode: GoodsType: 1 CostOrIncome: 2 Locked: false HasVAT: true
پارامترهای خروجی ایجاد
در صورتی که عملیات با موفقیت انجام شود MessageType برابر 3 ، در صورتی که با اخطار انجام شود عدد 2 و در صورتی که با خطا مواجه شده و انجام نشود برابر 1 خواهد بود .
// پارامترهای خروجی به صورت جیسون دریافت می شود { "Message": "آیتم با موفقیت اضافه شد .", "MessageType": 3, "GoodsId": 48, "Code": 3, "Title": "مانیتور 21 اینچ", "UnitId": 1, "GoodsType": 1, "CostOrIncome": 2, "GoodsGroup_GoodsGroupId": 1, "GoodsGroup_Title": "ال جی ", "GoodsGroup_Code": 10, "GoodsSubGroupId": 1, "GoodsSubGroup_Title": "صوتی و تصویری", "GoodsSubGroup_Code": 1, "Unit_Title": "عدد ", "TechnicalCode": null, "Barcode": null, "ExternalCode": null, "HasVAT": true, "Locked": false, "OrderPoint": 10.0, "GoodsAmount": null, "LastBuyPrice": 0.0, "LastSalePrice": 0.0, "CreatedDate": "2019-09-03T14:13:45.5721375+04:30", "CreatedUserID": 2, "ModifiedDate": "2019-09-03T14:13:45.5721464+04:30", "ModifiedUserID": 2 }
متد ویرایش
مسیر : https://accounting.hoofer.cloud/Goods/Update
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ویرایش کالا در زیر آمده است .
در متد ویرایش فقط GoodsId اجباری می باشد .
پارامترهای ورودی ویرایش
// پارامترهای ورودی به صورت Form Data ارسال می شود GoodsId: 48 Code: 3 Title: مانیتور 21 اینچ UnitId: 1 OrderPoint: 10 Barcode: ExternalCode: TechnicalCode: CostOrIncome: 2 Locked: false HasVAT: true
پارامترهای خروجی ویرایش
مشابه متد ایجاد
متد حذف
مسیر : https://accounting.hoofer.cloud/ِGoods/Delete/{GoodsId}
متد ارسال : POST
پارامترهای ورودی حذف
DetailId Ex : https://accounting.hoofer.cloud/GoodsId/Delete/28
پارامترهای خروجی حذف
// پارامترهای خروجی به صورت جیسون دریافت می شود { GoodsId: 28 Message: "آیتم با موفقیت حذف شد ." MessageType: 3 }
متد گرفتن یک آیتم (Get)
مسیر : https://accounting.hoofer.cloudGoods/Get/{GoodsId}
متد ارسال : GET
این متد کلید یک موجودیت را دریافت کرده و مقادیر مربوط با آن را برمی گرداند .
پارامترهای ورودی Get
GoodsId Ex : https://accounting.hoofer.cloud/Goods/Get/24
پارامترهای خروجی Get
مشابه متد ایجاد
متد گرفتن همه آیتم ها (GetSome)
مسیر : https://accounting.hoofer.cloud/Goods/GetSome
روش ارسال : POST
پارامترهای ورودی GetSome
// پارامترهای ورودی به صورت Form Data ارسال می شود MasterId: 0 // استفاده نشده Skip: 0 // استفاده نشده Take: 200 // حداکثر تعداد آیتم برگشتی OrderField: Title // مرتب سازی بر اساس Order: asc // صعودی یا نزولی View: // استفاده نشده Force: false // سیستمی
پارامترهای خروجی GetSome
// پارامترهای خروجی به صورت جیسون دریافت می شود { "itemCount": 1, "values": [ { "CostOrIncomeStr": "درآمد", "GoodsTypeStr": "کالا", "LockedStr": "خیر", "HasVatStr": "بله", "Message": null, "MessageType": 0, "GoodsGroup_GoodsGroupId": 1, "GoodsGroup_Title": "ال جی ", "GoodsGroup_Code": 10, "GoodsSubGroup_Title": "ساید و یخچال", "GoodsSubGroup_Code": 2, "Unit_Title": "دستگاه", "Unit_Lookup": "8;#دستگاه", "GoodsAmount": null, "LastBuyPrice": 0.0, "LastSalePrice": 0.0, "CreatedDate": null, "CreatedUserID": null, "ModifiedDate": null, "ModifiedUserID": null, "GoodsId": 3, "GoodsGroup": null, "GoodsSubGroupId": 2, "GoodsSubGroup": null, "Code": 1, "Title": " ساید 34 فوت", "UnitId": 8, "Unit": null, "GoodsType": 1, "CostOrIncome": 2, "TechnicalCode": "10021001", "Barcode": null, "ExternalCode": null, "HasVAT": true, "Locked": false, "OrderPoint": 10.000 } ], "startTime": "2019-09-03T14:36:22.1797286+04:30", // زمان دریافت درخواست توسط سرور "endTime": "2019-09-03T14:37:22.1797314+04:30", // زمان پاسخ به درخواست "extra": null }
متد جستجو (GetSomeByMasterIdAndParams)
مسیر : https://accounting.hoofer.cloud/Goods/GetSomeByMasterIdAndParams
روش ارسال : POST
از این متد برای جستجوی تفصیلی استفاده می شود .
پارامترهای ورودی GetSomeByMasterIdAndParams
// پارامترهای ورودی به صورت Form Data ارسال می شود MasterId: 0 Skip: 0 Take: 200 OrderField: Title Order: asc View: Force: false parameters: { "params": null, "filter": { "FromCode": "10021", // کد کالا از "ToCode": "10021", // کد کالا تا "Title": "ساید", // عنوان کالا شامل "GoodsGroup_Title": "ال", // عنوان گروه کالا شامل "GoodsSubGroup_Title": "یخچال" // عنوان زیرگروه کالا شامل } }
پارامترهای خروجی GetSomeByMasterIdAndParams
مشابه GetSome