مرکز واسط برنامه نویسی

کالاها و خدمات


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 مسیر دسته بندی
مثال:
{
     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',
                NodePath: 'دیجیتال/موبایل/سامسونگ'
            }
 }
 
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 مسیر دسته بندی
مثال:
{
     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',
                NodePath: 'دیجیتال/موبایل/سامسونگ'
            }
 }
 
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',
			NodePath: 'دیجیتال/موبایل/سامسونگ'
		},{
			Code: '000002',
			Name: 'Galaxy S7 گوشی موبایل',
			Barcode: '8465456742345',
			ItemType: 0,
			Unit: 'عدد',
			Stock: 12,
			BuyPrice: 700000,
			SellPrice: 750000,
			PurchasesTitle: 'Samsung Galaxy S7',
			SalesTitle: 'Samsung Galaxy S7',
			NodePath: 'دیجیتال/موبایل/سامسونگ'
		}]
	}
}
 
URL: https://api.hesabfa.com/v1/item/save

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
item شی نگهدارنده اطلاعات کالا
شامل:
* آیتم های ستاره دار ضروری هستند.
Code کد کالا
در صورتی که کد کالا را وارد نکنید، کالای جدید ذخیره می شود.
در صورتی که کد وارد شود و موجود باشد، اطلاعات ویرایش می شود.
در صورتی که کد وارد شود و موجود نباشد، کالا با آن کد ذخیره خواهد شد.
*Name نام کالا
*ItemType نوع ( جدول نوع کالا/خدمات )
Barcode بارکد کالا/خدمات
Unit واحد کالا
BuyPrice قیمت خرید
SellPrice قیمت فروش
PurchasesTitle عنوان در فاکتور فروش
SalesTitle عنوان در فاکتور خرید
مثال:
{
	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',
	}
 }
 
خروجی
آیتم های موجود در پاسخ:
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',
		NodePath: 'دیجیتال/موبایل/سامسونگ'
	}
 }
 
URL: https://api.hesabfa.com/v1/item/batchsave

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
items لیستی از اشیاء نگهدارنده اطلاعات کالاها
شامل:
* آیتم های ستاره دار ضروری هستند.
Code کد کالا
در صورتی که کد کالا را وارد نکنید، کالای جدید ذخیره می شود.
در صورتی که کد وارد شود و موجود باشد، اطلاعات ویرایش می شود.
در صورتی که کد وارد شود و موجود نباشد، کالا با آن کد ذخیره خواهد شد.
*Name نام کالا
*ItemType نوع ( جدول نوع کالا/خدمات )
Barcode بارکد کالا/خدمات
Unit واحد کالا
BuyPrice قیمت خرید
SellPrice قیمت فروش
PurchasesTitle عنوان در فاکتور فروش
SalesTitle عنوان در فاکتور خرید
مثال:
{
	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',
	}, {
		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',
			NodePath: 'دیجیتال/موبایل/سامسونگ'
		},{
			Code: '000002',
			Name: 'Galaxy S7 گوشی موبایل',
			Barcode: '',
			ItemType: 0,
			Unit: '',
			Stock: 0,
			BuyPrice: 0,
			SellPrice: 0,
			PurchasesTitle: '',
			SalesTitle: '',
			NodePath: ''
		}]
	}
 }
 
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
}