متدهای فاکتور در API نرم افزار حسابداری آنلاین حسابفا

دریافت

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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

number	شماره فاکتور مورد نظر
type	نوع فاکتور ( جدول نوع فاکتور)

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',	
	loginToken: 'f6b912...45fdc',
	number: 1001,
	type: 0
}

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result Object اطلاعات فاکتور مورد نظر

Number	شماره فاکتور
Reference	شماره ارجاع
Date	تاریخ فاکتور
DueDate	تاریخ سررسید فاکتور
ContactCode	کد شخص
Contact	Object مشخصات شخص
ContactTitle	عنوان شخص در فاکتور
Sum	جمع مبلغ فاکتور
Payable	مبلغ قابل پرداخت فاکتور
Paid	مبلغ پرداخت شده فاکتور
Rest	مبلغ باقیمانده فاکتور
Note	یادداشت
Sent	وضعیت ارسال فاکتور
Returned	وضعیت برگشتی فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور)
Status	وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag	فیلد متنی قابل استفاده توسط برنامه نویس
Freight	هزینه حمل
WarehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
Project	پروژه
SalesmanCode	کد فروشنده
SalesmanPercent	درصد پورسانت فروشنده
Currency	واحد پول
TaxId	کد منحصر به فرد مالیاتی
InvoiceItems	آرایه ای از اقلام موجود در فاکتور. هر قلم شامل ساختار زیر می باشد:

RowNumber	شماره ردیف
ItemCode	کد کالا یا خدمات
Item	شی کالا یا خدمات
Description	شرح کالا یا خدمات
Unit	واحد
Quantity	تعداد یا مقدار
UnitPrice	قیمت واحد
Sum	تعداد * قیمت واحد
Discount	تخفیف
Tax	مالیات
TotalAmount	مبلغ کل
SerialNumbers	شماره سریال

{
	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: '',
		Freight: 0,
		WarehouseReceiptStatus: 1,
		Project: 'پروژه یک',
		SalesmanCode: 10001,
           SalesmanPercent: 30,
           Currency: 'IRR',
           TaxId: '',
       	InvoiceItems: [{
			RowNumber: 1,
			Description: 'Galaxy J7 گوشی سامسونگ',
			ItemCode: '0000001',
			Item: {...}
			Unit: 'عدد',
			Quantity: 1,
			UnitPrice: 100000,
			Sum: 100000,
			Discount: 0,
			Tax: 9000,
			TotalAmount: 109000,
                   SerialNumbers: ['974900098723']
		}]
	}
}

دریافت از طریق Id

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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

id	Id فاکتور مورد نظر
idList	لیست id فاکتورهای مورد نظر

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	loginToken: 'f6b912...45fdc',
	id: 1,
  idList: [3259 , 3273]
}

نکات ضروری

یکی از پارامترهای id یا idList وارد شود.

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result Object اطلاعات فاکتور مورد نظر

Number	شماره فاکتور
Returned	وضعیت برگشتی فاکتور
Date	تاریخ فاکتور
DueDate	تاریخ سررسید فاکتور
ContactCode	کد شخص
Contact	Object مشخصات شخص
ContactTitle	عنوان شخص در فاکتور
Sum	جمع مبلغ فاکتور
Payable	مبلغ قابل پرداخت فاکتور
Paid	مبلغ پرداخت شده فاکتور
Rest	مبلغ باقیمانده فاکتور
Note	یادداشت
Reference	شماره ارجاع
Sent	وضعیت ارسال فاکتور
Returned	وضعیت برگشتی فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور)
Status	وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag	فیلد متنی قابل استفاده توسط برنامه نویس
Freight	هزینه حمل
WarehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
Project	پروژه
SalesmanCode	کد فروشنده
SalesmanPercent	درصد پورسانت فروشنده
Currency	واحد پول
TaxId	کد منحصر به فرد مالیاتی
InvoiceItems	آرایه ای از اقلام موجود در فاکتور. هر قلم شامل ساختار زیر می باشد:

RowNumber	شماره ردیف
ItemCode	کد کالا یا خدمات
Item	شی کالا یا خدمات
Description	شرح کالا یا خدمات
Unit	واحد
Quantity	تعداد یا مقدار
UnitPrice	قیمت واحد
Sum	تعداد * قیمت واحد
Discount	تخفیف
Tax	مالیات
TotalAmount	مبلغ کل
SerialNumbers	شماره سریال

{
	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: '',
		Freight: 0,
		WarehouseReceiptStatus: 1,
		Project: 'پروژه یک',
		SalesmanCode: 10001,
           SalesmanPercent: 30,
           Currency: 'IRR',
           TaxId: '',
		InvoiceItems: [{
			RowNumber: 1,
			Description: 'Galaxy J7 گوشی سامسونگ',
			ItemCode: '0000001',
			Item: {...}
			Unit: 'عدد',
			Quantity: 1,
			UnitPrice: 100000,
			Sum: 100000,
			Discount: 0,
			Tax: 9000,
			TotalAmount: 109000,
                   SerialNumbers: ['974900098723']
		}]
	}
}

دریافت لیست

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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

type	نوع فاکتور ( جدول نوع فاکتور )

queryInfo Object فیلتر و مرتب سازی (مشاهده توضیحات)

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	loginToken: 'f6b912...45fdc',
	type: 0,
  	queryInfo:{
		sortBy: 'Date',
		sortDesc: true,
		take: 20,
		skip: 0
	}
}

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result درون فیلد result آرایه ای از فاکتورها قرار میگیرد.

TotalCount	تعداد کل
FilteredCount	تعداد فیلتر شده
From	شماره ردیف شروع
To	شماره ردیف خاتمه
List	لیستی از Object های نگهدارنده اطلاعات فاکتور می باشد.هر Object شامل ساختار زیر می باشد:

Number	شماره فاکتور
Reference	شماره ارجاع
Date	تاریخ فاکتور
DueDate	تاریخ سررسید فاکتور
ContactCode	کد شخص
Contact	Object مشخصات شخص
ContactTitle	عنوان شخص در فاکتور
Sum	جمع مبلغ فاکتور
Payable	مبلغ قابل پرداخت فاکتور
Paid	مبلغ پرداخت شده فاکتور
Rest	مبلغ باقیمانده فاکتور
Note	یادداشت
Sent	وضعیت ارسال فاکتور
Returned	وضعیت برگشتی فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور)
Status	وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag	فیلد متنی قابل استفاده توسط برنامه نویس
Freight	هزینه حمل
WarehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
Project	پروژه
SalesmanCode	کد فروشنده
SalesmanPercent	درصد پورسانت فروشنده
Currency	واحد پول
TaxId	کد منحصر به فرد مالیاتی

{
	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: '',
			Freight: 0,
			WarehouseReceiptStatus: 1,
			Project: 'پروژه یک',
			SalesmanCode: 10001,
                   SalesmanPercent: 30,
                   Currency: 'IRR',
                   TaxId: '',

		},{
			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: '',
			Freight: 0,
			WarehouseReceiptStatus: 1,
			Project: 'پروژه یک',
			SalesmanCode: 10001,
                   SalesmanPercent: 30,
                   Currency: 'IRR',
                   TaxId: '',

		}]
	}
}

ذخیره

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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

invoice

Object نگهدارنده اطلاعات فاکتور می باشد.هر Object شامل ساختار زیر می باشد:

* آیتم های ستاره دار ضروری هستند.

number	شماره فاکتور در صورتی که شماره فاکتور را وارد نکنید، فاکتور با شماره اتوماتیک ذخیره می شود. در صورتی که شماره فاکتور وارد شود و موجود باشد، اطلاعات ویرایش می شود. در صورتی که شماره فاکتور وارد شود و موجود نباشد، فاکتور با آن شماره ذخیره خواهد شد.
reference	شماره ارجاع
*date	تاریخ فاکتور
*dueDate	تاریخ سر رسید فاکتور
*contactCode	کد شخص
contactTitle	عنوان مشتری/فروشنده در فاکتور
note	یادداشت
sent	وضعیت ارسال فاکتور
*invoiceType	نوع فاکتور ( جدول نوع فاکتور )
status	وضعیت فاکتور ( جدول وضعیت فاکتور )
tag	فیلد متنی قابل استفاده توسط برنامه نویس
freight	هزینه حمل
warehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
project	پروژه
salesmanCode	کد فروشنده
salesmanPercent	درصد پورسانت فروشنده
invoiceItems	آرایه ای از اقلام فاکتور، شامل ساختار زیر:

rowNumber	شماره ردیف
*description	توضیحات کالا یا خدمات
*itemCode	کد کالا یا خدمات
unit	واحد کالا
*quantity	تعداد یا مقدار
*unitPrice	قیمت واحد
*discount	تخفیف
*tax	مالیات
serialNumbers	شماره سریال

others آرایه ای از اضافات و کسورات فاکتور، شامل ساختار زیر:

title	عنوان اضافات و کسورات
amount	مقدار اضافات و کسورات
add	true:اضافات false:کسورات

currency	واحد پول
taxId	کد منحصر به فرد مالیاتی
currencyRate	نرخ برابری ارز به ارز پایه

{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    invoice:{
       number: '1001',
       reference: '',
       date: '2018-07-17 17:30:12',
       dueDate: '2018-07-17 17:30:12',
       contactCode: '000001',
       contactTitle: 'سعید محمدی',
       note: '',
       sent: false,
       invoiceType: 0,
       status: 2,
       tag: '',
       freight: 0,
       warehouseReceiptStatus: 1,
       project: 'پروژه یک',
       salesmanCode: 10001,
       salesmanPercent: 30,
       currency: 'IRR',
       invoiceItems: [{
           rowNumber: 1,
           description: 'Galaxy J7 گوشی سامسونگ',
           itemCode: '0000001',
           unit: 'عدد',
           quantity: 1,
           unitPrice: 100000,
           discount: 0,
           tax: 9000,
           serialNumbers: ['974900098723']
       }],
     others : [
        {
           "title": "هزینه های گمرکی",
           "amount": 1540000.0,
           "add": true 
        }
    ],
     currency: "IRR",
     taxId: "",
     currencyRate: 1.0000000000
   }
}

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن، Object فاکتور ذخیره شده یا ویرایش شده درون Result قرار می گیرد.

Number	شماره فاکتور
Reference	شماره ارجاع
Date	تاریخ فاکتور
DueDate	تاریخ سر رسید فاکتور
ContactCode	کد شخص
ContactTitle	عنوان مشتری/فروشنده در فاکتور
Sum	جمع مبلغ فاکتور
Payable	مبلغ قابل پرداخت فاکتور
Paid	مبلغ پرداخت شده فاکتور
Rest	مبلغ باقیمانده فاکتور
Note	یادداشت
Sent	وضعیت ارسال فاکتور
Returned	وضعیت برگشتی فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور )
Status	وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag	فیلد متنی قابل استفاده توسط برنامه نویس
Freight	هزینه حمل
WarehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
Project	پروژه
SalesmanCode	کد فروشنده
SalesmanPercent	درصد پورسانت فروشنده
InvoiceItems	آرایه ای از اقلام فاکتور، شامل ساختار زیر:

RowNumber	شماره ردیف
Description	شرح کالا یا خدمات
ItemCode	کد کالا یا خدمات
Unit	واحد کالا
Quantity	تعداد یا مقدار
UnitPrice	قیمت واحد
Sum	سرجمع قیمت بدون تخفیف و مالیات
Discount	تخفیف
Tax	مالیات
TotalAmount	مبلغ کل با احتساب تخفیف و مالیات
SerialNumbers	شماره سریال

مثال:

{
	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: '',
		Freight: 0,
		WarehouseReceiptStatus: 1,
		Project: 'پروژه یک',
           SalesmanCode: 10001,
           SalesmanPercent: 30,
           Currency: 'IRR',
		InvoiceItems: [{
			RowNumber: 1,
			Description: 'Galaxy J7 گوشی سامسونگ',
			ItemCode: '0000001',
			Item: {...}
			Unit: 'عدد',
			Quantity: 1,
			UnitPrice: 100000,
			Sum: 100000,
			Discount: 0,
			Tax: 9000,
			TotalAmount: 109000,
           SerialNumbers: ['974900098723']
		}]
	}
}

حذف

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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

number	شماره فاکتور مورد نظر
type	نوع فاکتور ( جدول نوع فاکتور)

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	loginToken: 'f6b912...45fdc',
	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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

type	نوع فاکتور ( جدول نوع فاکتور)
number	شماره فاکتور فروش
bankCode	کد بانک
cashCode	کد صندوق
pettyCashCode	کد تنخواه گردان
contactCode	کد شخص
accountPath	مسیر حساب
date	تاریخ تراکنش
amount	مبلغ تراکنش
transactionNumber	شماره تراکنش
project	نام پروژه، در صورتی که این فیلد ارسال نشود، رسید با پروژه ثبت شده برای فاکتورذخیره خواهد شد.
description	توضیحات تراکنش
transactionFee	هزینه یا کارمزد تراکنش
currency	واحد پول
currencyRate	نرخ برابری ارز به ارز پایه
cashCode	کد صندوق
pettyCashCode	کد تنخواه گردان

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	loginToken: 'f6b912...45fdc',
	type: 0,
	number: 1001,
	bankCode: '0001',
	date: '2018-07-17 17:32:11',
	amount: 109000,
	transactionNumber: '255496387',
    project: 'فروشگاه آنلاین',
    description: 'پرداخت آنلاین',
	transactionFee: 0
}

نکات ضروری

فقط یکی از پنج فیلد accountPath ، contactCode ،bankCode، cashCode و pettyCashCode باید مقدار داشته باشد.
واحد پول فاکتور با واحد پول بانک، صندوق یا تنخواه گردان باید یکی باشد.
در صورت ذکر نشدن currency و currencyRate از مقادیر ذکر شده در فاکتور استفاده خواهد شد.

accountPath مسیر حساب

مثال: "دارایی ها: دارایی های جاری: موجودی نقد و بانک: وجوه در راه"
اگر حساب تفصیلی نظیر شخص یا بانک داشته باشد، باید کد تفصیل مرتبط هم ارسال شود. مثلا اگر تفصیل حساب شخص باشید باید فیلد contactCode نیز ارسال گردد.

توضیحات فیلد transactionFee:

در صورتی که به ازای پرداخت آنلاین مبلغی بابت هزینه تراکنش از حساب شما کسر می شود این هزینه را
می توانید در این فیلد ثبت کنید تا سند هزینه به طور اتوماتیک صادر شود.

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result Object رسید یا دریافت مورد نظر

Number	شماره رسید
DateTime	تاریخ رسید
Description	شرح
Amount	مبلغ رسید
Currency	واحد پول رسید
Project	پروژه
Items	آرایه ای از طرف های دریافت یا پرداخت کننده. ساختار در مثال نشان داده شده است.

Contact شخص(مشخصات شخص به صورت زیر خواهد بود)

Code	کد شخص
Name	نام شخص

Account	مسیر حساب
Amount	مبلغ
Description	توضیحات

Transactions آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.

Cash	نقدی
Bank	بانکی(مشخصات بانک به صورت زیر خواهد بود)

Code	کد بانک
Name	نام بانک

PettyCash	تنخواه گردان
Contact	اعتباری از شخص
Check	بصورت چکی
Account	مسیر حساب
Type	نوع تراکنش رسید ( جدول نوع تراکنش رسید )
Reference	ارجاع
TransactionFee	کارمزد خدمات بانکی
Amount	مبلغ

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: '',
    Result: {
        "Id": 100,
        "Number": 1009,
        "DateTime": "2020-11-07T00:00:00",
        "Description": "دریافت وجه/چک از محسن کریمی",
        "Amount": 2500000.0000,
        "Currency": "IRR",
        "Project": "",
        "Items": [
            {
                "Contact": {
                    "Id": 3055,
                    "Code": "000009",
                    "Name": " محسن کریمی"
                },
                "Amount": 2500000.0000,
                "Account": null,
                "Description": "دریافت وجه/چک از محسن کریمی"
            },
            {...},
            {...}
        ],
        "Transactions": [
            {
                "Cash": null,
                "Bank": {
                    "Id": 1004,
                    "Code": "0001",
                    "Name": "بانک ملت"
                },
                "PettyCash": null,
                "Contact": null,
                "Check": null,
                "Account": null,
                "Type": "3",
                "Reference": null,
                "TransactionFee": 300.0000,
                "Amount": 25000000.0000
                },
            {...},
            {...}
        ]
    }
}

توضیحات آرایه Transactions:

تراکنش در حسابفا می تواند بصورت نقدی (cash) ، بانکی (bank)، تنخواه گردان (PettyCash)، اعتباری از شخص (Contact) و یا بصورت چکی (Check) باشد که در هر حالت آبجکت مربوطه شامل دیتا خواهد بود و سایر آبجکت ها null خواهند بود.

دریافت URL فاکتور آنلاین

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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

number	شماره فاکتور مورد نظر
type	نوع فاکتور ( جدول نوع فاکتور)

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	loginToken: 'f6b912...45fdc',
	number: 1001,
	type: 0
}

نکات ضروری

این متد در حال حاظر صرفا برای فاکتورهای فروش فعال است.
در صورتی که درگاه پرداختی اینترنتی فعال نشده باشد، امکان دریافت URL فاکتور آنلاین وجود ندارد.
برای فعالسازی درگاه پرداختی اینترنتی از منوی تنظیمات، تنظیمات فاکتور آنلاین را انتخاب کنید.

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن مقدار URL فاکتور آنلاین درون Result قرار می گیرد.

{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: '',
	Result: "https://app.hesabfa.com/public/invoice?token=FT2bEEe134vmseXMK"
}

ذخیره حواله انبار

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

Request
Response

پارامترها :

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

deleteOldReceipts	آیا رسید یا حواله های قدیمی برای این فاکتور حذف شوند؟
receipt	Object نگهدارنده اطلاعات حواله می باشد.هر Objectشامل ساختار زیر می باشد : * آیتم های ستاره دار ضروری هستند.

*warehouseCode	کد انبار
*invoiceNumber	شماره فاکتور
*invoiceType	نوع فاکتور ( جدول نوع فاکتور )
date	تاریخ حواله
note	یادداشت و توضیحات
freight	هزینه حمل
delivery	تحویل (در محل انبار)
project	پروژه
*items	آرایه ای از اقلام حواله، شامل ساختار زیر:

*itemCode	کد کالا
*quantity	تعداد
reference	ارجاع
note	توضیحات

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     loginToken: 'f6b912...45fdc',
     deleteOldReceipts: true,
     receipt:{
		warehouseCode: 11,
		invoiceNumber: 1004,
		invoiceType: 0,
		date: '2018-07-17',
		notes: '',
		freight: 0,
		delivery: '',
		project: 'پروژه فروشگاه آنلاین',
		items: [
		{
		    itemCode: 6,
		    quantity: 1,
		    reference: 'PQ-1224',
		    notes: ''
		},
		{
		    itemCode: 7,
		    quantity: 2,
		},
		...
		]
	}
}

نکات ضروری

با فراخوانی این متد رسید یا حواله انبار برای فاکتور خرید یا فروش صادر می گردد. در صورتی که کالاهای فاکتور در چندین انبار مختلف وجود داشته باشند به ازای هر انبار باید یکبار این متد را فراخوانی کرد و در هر فراخوانی کالاها و تعداد مورد نیاز به تفکیک انبار ذکر گردد.
در صورتی که مقدار پارامتر deleteOldReceipts=true باشد، کلیه حواله های قبلی صادر شده برای فاکتور حذف خواهند شد و حواله جدید صادر می شود.
کلیه آیتم های باید از نوع کالا و با قابلیت کنترل موجودی باشند در غیر اینصورت حواله ثبت نخواهد شد.

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن، Object حواله ذخیره شده یا ویرایش شده درون Result قرار می گیرد.

Number	شماره حواله انبار
InvoiceNumber	شماره فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode	کد انبار
Date	تاریخ حواله
Note	یادداشت و توضیحات
Delivery	تحویل (در محل انبار)
Freight	هزینه حمل
Project	پروژه
Items	آرایه ای از اقلام حواله، شامل ساختار زیر:

ItemCode	کد کالا
Reference	ارجاع
Note	توضیحات
Quantity	تعداد

{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: {
        "Id": 1060, 
        "Number": 1004, 
        "InvoiceNumber": "1004",
        "InvoiceType": 0, 
        "WarehouseCode": 11, 
        "Date": "2018-06-07T00:00:00", 
        "Notes": " حواله خروج از انبار - فاکتور فروش # 1004", 
        "Delivery": "در محل انبار", 
        "Freight": "توسط خودشان", 
        "Project": 'پروژه فروشگاه آنلاین',
        "Items": [ 
            { 
                "Id": 2062, 
                "ItemCode": “000006”, 
                "Reference": "PQ-1224", 
                "Notes": "", 
                "Item": {…}, 
                "Quantity": 1.0 
            }, 
            { 
                "Id": 2063, 
                "ItemCode": “000007”, 
                "Reference": "", 
                "Notes": "", 
                "Item": {…}, 
                "Quantity": 2.0 
            } 
        ] 
    } 
}

متدهای فاکتور در رابط برنامه نویسی حسابفا

دریافت

دریافت از طریق Id

دریافت لیست

ذخیره

حذف

ثبت دریافت و پرداخت فاکتور

دریافت URL فاکتور آنلاین

آیتم های موجود در پاسخ:

ذخیره حواله انبار

پارامترها :

آیتم های موجود در پاسخ: