کالاها و خدمات
URL: https://api.hesabfa.com/v1/item/get
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
code | کد کالای مورد نظر. |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', code: '000001' }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
Code | کد کالا یا خدمات |
Name | نام کالا یا خدمات |
Barcode | بارکد کالا یا خدمات |
ItemType | نوع ( جدول نوع کالا/خدمات) |
Unit | واحد خرید و فروش |
Stock | موجودی |
BuyPrice | قیمت خرید |
SellPrice | قیمت فروش |
PurchasesTitle | عنوان در فاکتور فروش |
SalesTitle | عنوان در فاکتور خرید |
NodeFamily | مسیر دسته بندی |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت کالا: فعال یا غیرفعال |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result:{ Code: '000001', Name: 'Galaxy J7 گوشی موبایل', Barcode: '345345345345', ItemType: 0, Unit: 'عدد', Stock: 10, BuyPrice: 500000, SellPrice: 550000, PurchasesTitle: 'Samsung Galaxy J7', SalesTitle: 'Samsung Galaxy J7', NodeFamily: 'دیجیتال:موبایل:سامسونگ', Tag: '', Active: true } }
URL: https://api.hesabfa.com/v1/item/getByBarcode
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
barcode | بارکد کالای مورد نظر. |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', barcode: '345345345345' }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
Code | کد کالا یا خدمات |
Name | نام کالا یا خدمات |
Barcode | بارکد کالا یا خدمات |
ItemType | نوع ( جدول نوع کالا/خدمات) |
Unit | واحد خرید و فروش |
Stock | موجودی |
BuyPrice | قیمت خرید |
SellPrice | قیمت فروش |
PurchasesTitle | عنوان در فاکتور فروش |
SalesTitle | عنوان در فاکتور خرید |
NodeFamily | مسیر دسته بندی |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت کالا: فعال یا غیرفعال |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result:{ Code: '000001', Name: 'Galaxy J7 گوشی موبایل', Barcode: '345345345345', ItemType: 0, Unit: 'عدد', Stock: 10, BuyPrice: 500000, SellPrice: 550000, PurchasesTitle: 'Samsung Galaxy J7', SalesTitle: 'Samsung Galaxy J7', NodeFamily: 'دیجیتال:موبایل:سامسونگ', Tag: '', Active: true } }
URL: https://api.hesabfa.com/v1/item/getById
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
idList | id کالا یا کالاهای مورد نظر. |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', idList: [1,2,3] }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
Code | کد کالا یا خدمات |
Name | نام کالا یا خدمات |
Barcode | بارکد کالا یا خدمات |
ItemType | نوع ( جدول نوع کالا/خدمات) |
Unit | واحد خرید و فروش |
Stock | موجودی |
BuyPrice | قیمت خرید |
SellPrice | قیمت فروش |
PurchasesTitle | عنوان در فاکتور فروش |
SalesTitle | عنوان در فاکتور خرید |
NodeFamily | مسیر دسته بندی |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت کالا: فعال یا غیرفعال |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result:{ Code: '000001', Name: 'Galaxy J7 گوشی موبایل', Barcode: '345345345345', ItemType: 0, Unit: 'عدد', Stock: 10, BuyPrice: 500000, SellPrice: 550000, PurchasesTitle: 'Samsung Galaxy J7', SalesTitle: 'Samsung Galaxy J7', NodeFamily: 'دیجیتال:موبایل:سامسونگ', Tag: '', Active: true } }
URL: https://api.hesabfa.com/v1/item/getitems
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
پارامترهای اختیاری:
queryInfo | شی فیلتر و مرتب سازی (مشاهده توضیحات) |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', queryInfo:{ SortBy: 'Code', SortDesc: true, Take: 20, Skip: 0, Filters:[{ Property: 'Name', Operator: '*', Value: 'Galaxy' } ] } }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
درون فیلد result آرایه ای از کالاها قرار میگیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: { TotalCount:20, ------> تعداد کل FilteredCount:2, ------> تعداد فیلتر شده From:1, ------> شماره ردیف شروع To:2, ------> شماره ردیف خاتمه List:[{ ------> لیست کالاها Code: '000001', Name: 'Galaxy J7 گوشی موبایل', Barcode: '345345345345', ItemType: 0, Unit: 'عدد', Stock: 10, BuyPrice: 500000, SellPrice: 550000, PurchasesTitle: 'Samsung Galaxy J7', SalesTitle: 'Samsung Galaxy J7', NodeFamily: 'دیجیتال:موبایل:سامسونگ', Tag: '', Active: true },{ Code: '000002', Name: 'Galaxy S7 گوشی موبایل', Barcode: '8465456742345', ItemType: 0, Unit: 'عدد', Stock: 12, BuyPrice: 700000, SellPrice: 750000, PurchasesTitle: 'Samsung Galaxy S7', SalesTitle: 'Samsung Galaxy S7', NodeFamily: 'دیجیتال:موبایل:سامسونگ', Tag: '', Active: true }] } }
URL: https://api.hesabfa.com/v1/item/save
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
item |
شی نگهدارنده اطلاعات کالا شامل: |
* آیتم های ستاره دار ضروری هستند. | |
Code |
کد کالا در صورتی که کد کالا را وارد نکنید، کالای جدید ذخیره می شود. در صورتی که کد وارد شود و موجود باشد، اطلاعات ویرایش می شود. در صورتی که کد وارد شود و موجود نباشد، کالا با آن کد ذخیره خواهد شد. |
*Name | نام کالا |
*ItemType | نوع ( جدول نوع کالا/خدمات ) |
Barcode | بارکد کالا/خدمات |
Unit | واحد کالا |
BuyPrice | قیمت خرید |
SellPrice | قیمت فروش |
PurchasesTitle | عنوان در فاکتور فروش |
SalesTitle | عنوان در فاکتور خرید |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت کالا: فعال یا غیرفعال |
NodeFamily |
دسته بندی کالا: یک فیلد متنی که به فرمت زیر می توان دسته بندی کالا یا خدمات را در آن تعریف کرد
برای کالا: "کالاها: دسته 1: دسته 2: ..." برای خدمات: "خدمات: دسته 1: دسته 2: ..." |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', item:{ Name: 'Galaxy J7 گوشی موبایل', Barcode: '345345345345', ItemType: 0, Unit: 'عدد', BuyPrice: 500000, SellPrice: 550000, PurchasesTitle: 'Samsung Galaxy J7', SalesTitle: 'Samsung Galaxy J7', Tag: '', Active: true, NodeFamily: 'کالاها : موبایل : سامسونگ' } }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن، شی کالای ذخیره شده یا ویرایش شده درون Result قرار می گیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: { Code: '000001', Name: 'Galaxy J7 گوشی موبایل', Barcode: '345345345345', ItemType: 0, Unit: 'عدد', Stock: 10, BuyPrice: 500000, SellPrice: 550000, PurchasesTitle: 'Samsung Galaxy J7', SalesTitle: 'Samsung Galaxy J7', Tag: '', Active: true, NodeFamily: 'کالاها : موبایل : سامسونگ' } }
URL: https://api.hesabfa.com/v1/item/batchsave
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
items |
لیستی از اشیاء نگهدارنده اطلاعات کالاها شامل: |
* آیتم های ستاره دار ضروری هستند. | |
Code |
کد کالا در صورتی که کد کالا را وارد نکنید، کالای جدید ذخیره می شود. در صورتی که کد وارد شود و موجود باشد، اطلاعات ویرایش می شود. در صورتی که کد وارد شود و موجود نباشد، کالا با آن کد ذخیره خواهد شد. |
*Name | نام کالا |
*ItemType | نوع ( جدول نوع کالا/خدمات ) |
Barcode | بارکد کالا/خدمات |
Unit | واحد کالا |
BuyPrice | قیمت خرید |
SellPrice | قیمت فروش |
PurchasesTitle | عنوان در فاکتور فروش |
SalesTitle | عنوان در فاکتور خرید |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت کالا: فعال یا غیرفعال |
NodeFamily |
دسته بندی کالا: یک فیلد متنی که به فرمت زیر می توان دسته بندی کالا یا خدمات را در آن تعریف کرد
برای کالا: "کالاها: دسته 1: دسته 2: ..." برای خدمات: "خدمات: دسته 1: دسته 2: ..." |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', items:[{ Code: '000001', Name: 'Galaxy J7 گوشی موبایل', Barcode: '345345345345', ItemType: 0, Unit: 'عدد', BuyPrice: 500000, SellPrice: 550000, PurchasesTitle: 'Samsung Galaxy J7', SalesTitle: 'Samsung Galaxy J7', Tag: '', Active: '', NodeFamily: 'کالاها : موبایل : سامسونگ' }, { Name: 'Galaxy S7 گوشی موبایل', ItemType: 0, }] }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن، لیستی از کالاهای ذخیره شده یا ویرایش شده درون Result قرار می گیرد. |
مثال:
{
Success: true,
ErrorCode: 0,
ErrorMessage: "",
Result: [{ ------> لیست کالاها
Code: '000001',
Name: 'Galaxy J7 گوشی موبایل',
Barcode: '345345345345',
ItemType: 0,
Unit: 'عدد',
Stock: 10,
BuyPrice: 500000,
SellPrice: 550000,
PurchasesTitle: 'Samsung Galaxy J7',
SalesTitle: 'Samsung Galaxy J7',
NodeFamily: 'دیجیتال/موبایل/سامسونگ',
Tag: '',
Active: true
},{
Code: '000002',
Name: 'Galaxy S7 گوشی موبایل',
Barcode: '',
ItemType: 0,
Unit: '',
Stock: 0,
BuyPrice: 0,
SellPrice: 0,
PurchasesTitle: '',
SalesTitle: '',
NodeFamily: '',
Tag: '',
Active: true
}]
}
}
URL: https://api.hesabfa.com/v1/item/delete
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
code | کد کالای مورد نظر. |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', code: '00001' }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: true }
URL: https://api.hesabfa.com/v1/item/GetQuantity
با فراخوانی این متد لیست موجودی کلیه کالاهای ثبت شده در سیستم ارسال خواهد شد.
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
پارامترهای اختیاری:
warehouseCode | کد انبار |
codes | کد کالاها |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456', warehouseCode: 12, // اختیاری codes: ['000005','6','7'] // اختیاری }
نکته ها:
- در صورتی که پارامتر warehouseCode وجود داشته باشد و سیستم انبارداری هم فعال باشد، موجودی و کالاهای ثبت شده در انبار ذکر شده ارسال خواهد شد. در صورت عدم وجود پارامتر warehouseCode یا عدم فعال بودن سیستم انبارداری، کل کالاها و موجودی کلی کالا ارسال خواهد شد.
- در صورتی که پارامتر codes وجود داشته باشد، فقط کالاهایی که کد آنها در آرایه codes وجود داشته باشند، ارسال خوهند شد. در صورت عدم وجود پارامتر codes کلیه کالاها ارسال خواهند شد.
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: [ { "Code": "000001", "Tag": "115", "Quantity": 0.000000, "Barcode": "650077842", "SellPrice": 1570000.000, "ProductCode": "PCS-873300" }, { "Code": "000002", "Tag": "230", "Quantity": 16.000000, "Barcode": "89504564", "SellPrice": 275000.0000, "ProductCode": "PCS-873301" }, { "Code": "000003", "Tag": "227", "Quantity": 2.000000, "Barcode": "78900877", "SellPrice": 442500.0000, "ProductCode": "PCS-873302" }, { "Code": "000004", "Tag": "112", "Quantity": 30.000000, "Barcode": "87554698", "SellPrice": 3789200.0000, "ProductCode": "PCS-873303" }, {…}, {…} ] }
URL: https://api.hesabfa.com/v1/item/UpdateOpeningQuantity
با فراخوانی این متد موجودی اول دوره کالاها در تراز افتتاحیه ثبت خواهد شد. همچنین سند افتتاحیه به تناسب اطلاعات ویرایش خواهد شد. بنابراین پیش از فراخوانی این متد مطمئن باشید که سهامداران در سیستم تعریف شده باشند.
نکات مهم:
- این عمل فقط در اولین سال مالی امکان پذیر است.
- فقط موجودی کالاهایی که ارسال می شوند به روز خواهند شد و موجودی سایر کالاهایی که هم اکنون در تراز افتتاحیه ثبت شده اند تغییری نخواهند کرد.
- تعداد و قیمت واحد باید بزرگتر از صفر باشند. در غیر اینصورت ثبت نخواهند شد.
- دقت شود که این متد فقط در شروع سال مالی فراخوانی شود. فراخوانی این متد در اواسط سال مالی ممکن است باعث بروز اختلال در موجودی سیستم شود.
ورودی
پارامترهای اجباری:
apiKey userId password |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
items |
لیستی از اشیاء نگهدارنده اطلاعات کالاها شامل: |
* آیتم های ستاره دار ضروری هستند. | |
*Code | کد کالا |
*Quantity | تعداد (باید بزرگتر از صفر باشد) |
*UnitPrice | مبلغ واحد (باید بزرگتر از صفر باشد) |
WarehouseCode | کد انبار |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: 'mail@example.com', password: '123456' items: [{ Code: ‘000001’, Quantity: 3, UnitPrice: 250000, WarehouseCode: 12 }, { Code: ‘000002’, Quantity: 5, UnitPrice: 378000 }] }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: null }