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

فاکتور


URL: https://api.hesabfa.com/v1/invoice/get

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
مثال:
{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	number: 1001,
	type: 0
}
 
خروجی
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
Result
(مشاهده توضیحات)
Number شماره فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور)
Date تاریخ فاکتور
DueDate تاریخ سررسید فاکتور
ContactCode کد شخص
Contact شی مشخصات شخص
ContactTitle عنوان شخص در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Reference شماره ارجاع
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه نویس
InvoiceItems آرایه ای از اقلام موجود در فاکتور. هر قلم شامل ساختار زیر می باشد:
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
مثال:
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: '',
	Result:{
		Number: '1001',
		Reference: '',
		Date: '2018-07-17 17:30:12',
		DueDate: '2018-07-17 17:30:12',
		ContactCode: '000001',
		Contact: {...}
		ContactTitle: 'سعید محمدی',
		Sum: '109000',
		Payable: '109000',
		Paid: 0,
		Rest: 109000,
		Note: '',
		Sent: false,
		Returned: false,
		InvoiceType: 0,
		Status: 2,
		Tag: '',
		InvoiceItems: [{
			RowNumber: 1,
			Description: 'Galaxy J7 گوشی سامسونگ',
			ItemCode: '0000001',
			Item: {...}
			Unit: 'عدد',
			Quantity: 1,
			UnitPrice: 100000,
			Sum: 100000,
			Discount: 0,
			Tax: 9000,
			TotalAmount: 109000
		}]
	}
}
 
URL: https://api.hesabfa.com/v1/invoice/getinvoices

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
type نوع فاکتور ( جدول نوع فاکتور )
پارامترهای اختیاری:
queryInfo شی فیلتر و مرتب سازی (مشاهده توضیحات)
مثال:
{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	type: 0,
	queryInfo:{
		SortBy: 'Date',
		SortDesc: true,
		Take: 20,
		Skip: 0
	}
}
 
خروجی
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
Result
(مشاهده توضیحات)
درون فیلد result آرایه ای از فاکتورها قرار میگیرد.
مثال:
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: {
		TotalCount:2,          ------> تعداد کل 
		FilteredCount:2,        ------> تعداد فیلتر شده 
		From:1,                 ------> شماره ردیف شروع 
		To:2,                   ------> شماره ردیف خاتمه 
		List:[{                 ------> لیست فاکتورها 
			Number: '1002',
			Reference: '',
			Date: '2018-07-19 14:22:50',
			DueDate: '2018-07-19 14:22:50',
			ContactCode: '000001',
			Contact: {...}
			ContactTitle: 'سعید محمدی',
			Sum: '228000',
			Payable: '228000',
			Paid: 0,
			Rest: 228000,
			Note: '',
			Sent: false,
			Returned: false,
			InvoiceType: 0,
			Status: 2,
			Tag: '',
		},{
			Number: '1001',
			Reference: '',
			Date: '2018-07-17 17:30:12',
			DueDate: '2018-07-17 17:30:12',
			ContactCode: '000001',
			Contact: {...}
			ContactTitle: 'سعید محمدی',
			Sum: '109000',
			Payable: '109000',
			Paid: 0,
			Rest: 109000,
			Note: '',
			Sent: false,
			Returned: false,
			InvoiceType: 0,
			Status: 2,
			Tag: '',
		}]
	}
}
 
URL: https://api.hesabfa.com/v1/invoice/save

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
invoice شی نگهدارنده اطلاعات فاکتور
شامل:
* آیتم های ستاره دار ضروری هستند.
Number شماره فاکتور
در صورتی که شماره فاکتور را وارد نکنید، فاکتور با شماره اتوماتیک ذخیره می شود.
در صورتی که شماره فاکتور وارد شود و موجود باشد، اطلاعات ویرایش می شود.
در صورتی که شماره فاکتور وارد شود و موجود نباشد، فاکتور با آن شماره ذخیره خواهد شد.
*InvoiceType نوع فاکتور ( جدول نوع فاکتور )
*ContactCode کد شخص
ContactTitle عنوان مشتری/فروشنده در فاکتور
*Date تاریخ فاکتور
*DueDate تاریخ سر رسید فاکتور
Note یادداشت و توضیحات
Reference شماره ارجاع
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه نویس
InvoiceItems آرایه ای از اقلام فاکتور، شامل ساختار زیر:
RowNumber شماره ردیف
*ItemCode کد کالا یا خدمات
*Description شرح کالا یا خدمات
Unit واحد کالا
*Quantity تعداد یا مقدار
*UnitPrice قیمت واحد
*Discount تخفیف
*Tax مالیات
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     invoice:{
		Number: '1001',
		Reference: '',
		Date: '2018-07-17 17:30:12',
		DueDate: '2018-07-17 17:30:12',
		ContactCode: '000001',
		ContactTitle: 'سعید محمدی',
		Note: '',
		InvoiceType: 0,
		Status: 2,
		Tag: '',
		InvoiceItems: [{
			RowNumber: 1,
			Description: 'Galaxy J7 گوشی سامسونگ',
			ItemCode: '0000001',
			Unit: 'عدد',
			Quantity: 1,
			UnitPrice: 100000,
			Discount: 0,
			Tax: 9000
		}]
	}
}
 
خروجی
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
Result
(مشاهده توضیحات)
در صورت موفقیت آمیز بودن، شی فاکتور ذخیره شده یا ویرایش شده درون Result قرار می گیرد.
مثال:
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: {
		Number: '1001',
		Reference: '',
		Date: '2018-07-17 17:30:12',
		DueDate: '2018-07-17 17:30:12',
		ContactCode: '000001',
		Contact: {...}
		ContactTitle: 'سعید محمدی',
		Sum: '109000',
		Payable: '109000',
		Paid: 0,
		Rest: 109000,
		Note: '',
		Sent: false,
		Returned: false,
		InvoiceType: 0,
		Status: 2,
		Tag: '',
		InvoiceItems: [{
			RowNumber: 1,
			Description: 'Galaxy J7 گوشی سامسونگ',
			ItemCode: '0000001',
			Item: {...}
			Unit: 'عدد',
			Quantity: 1,
			UnitPrice: 100000,
			Sum: 100000,
			Discount: 0,
			Tax: 9000,
			TotalAmount: 109000
		}]
	}
}
 
URL: https://api.hesabfa.com/v1/invoice/delete

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
مثال:
{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	number: 1001,
	type: 0
}
 
خروجی
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
Result
(مشاهده توضیحات)
در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد.
مثال:
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: true
}
 
URL: https://api.hesabfa.com/v1/invoice/savepayment
توجه
  1. این متد در حال حاظر صرفا برای فاکتورهای فروش فعال است.
  2. ثبت پرداخت فقط به صورت واریز به بانک امکان پذیر است. لذا باید کد بانک تعریف شده در پنل حسابفای کاربر مشخص باشد.

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
number شماره فاکتور فروش
bankCode کد بانک
date تاریخ تراکنش
amount مبلغ تراکنش
transactionNumber شماره تراکنش
description توضیحات تراکنش
مثال:
{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	number: 1001,
	bankCode: '0001',
	date: '2018-07-17 17:32:11',
	amount: 109000,
	transactionNumber: '255496387',
	description: 'پرداخت آنلاین'
}
 
خروجی
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
Result
(مشاهده توضیحات)
در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد.
مثال:
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: true
}
 
URL: https://api.hesabfa.com/v1/invoice/getonlineinvoiceurl
توجه
  1. این متد در حال حاظر صرفا برای فاکتورهای فروش فعال است.
  2. در صورتی که درگاه پرداختی اینترنتی فعال نشده باشد، امکان دریافت URL فاکتور آنلاین وجود ندارد.
  3. برای فعالسازی درگاه پرداختی اینترنتی از منوی تنظیمات، تنظیمات فاکتور آنلاین را انتخاب کنید.

ورودی
پارامترهای اجباری:
apiKey
userId
password
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
مثال:
{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	number: 1001,
	type: 0
}
 
خروجی
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
Result
(مشاهده توضیحات)
در صورت موفقیت آمیز بودن مقدار URL فاکتور آنلاین درون Result قرار می گیرد.
مثال:
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: '',
	Result: "https://app.hesabfa.com/public/invoice?token=FT2bEEe134vmseXMK"
}