نگاه کلی
پیکربندی
جدول کدهای خطا
جدول انواع
متدهای اشخاص
متدهای کالاها و خدمات
متدهای فاکتور
متدهای دریافت و پرداخت
متدهای رسید و حوالۀ انبار
متدهای ثبت سند حسابداری
متدهای اقلام تخفیف‌دار
متدهای انتقال بین بانکی
هوک تغییرات
متدهای دیگر
متدهای دریافت گزارش
متدهای سیستم استعلام
نمونۀ کد

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

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

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
Copyed 
{
	apiKey: 'asdfASR^%FDHdsfg456',
	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 درصد پورسانت فروشنده
Profit سود فاکتور
Currency واحد پول
TaxId کد منحصر به فرد مالیاتی
InvoiceItems آرایه‌ای از اقلام موجود در فاکتور. هر قلم شامل ساختار زیر می باشد:
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {...},
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": {...
                },
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": [
                    "974900098723"
                ]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Profit": 5000.000,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/getById

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
id Id فاکتور مورد نظر
idList لیست id فاکتورهای مورد نظر
Copyed 
{
	apiKey: 'asdfASR^%FDHdsfg456',
	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 درصد پورسانت فروشنده
Profit سود فاکتور
Currency واحد پول
TaxId کد منحصر به فرد مالیاتی
InvoiceItems آرایه‌ای از اقلام موجود در فاکتور. هر قلم شامل ساختار زیر می باشد:
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {...},
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": {...
                },
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": [
                    "974900098723"
                ]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Profit": 5000.000,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/getInvoices

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
type نوع فاکتور ( جدول نوع فاکتور )
queryInfo Object فیلتر و مرتب‌سازی (مشاهدۀ توضیحات)
Copyed 
{
	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 درصد پورسانت فروشنده
Profit سود فاکتور
Currency واحد پول
TaxId کد منحصر به فرد مالیاتی
Copyed 
{
 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,
   Profit : 5000.000,
   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,
   Profit: 5000.000,
   Currency: 'IRR',
   TaxId: '',
            }
        ]
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/save

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
invoice Object نگهدارنده اطلاعات فاکتور می باشد.هر Object شامل ساختار زیر می باشد:

* آیتم‌های ستاره دار ضروری هستند.
number شماره فاکتور
در صورتی که شماره فاکتور را وارد نکنید، فاکتور با شماره اتوماتیک ذخیره می‌شود.
در صورتی که شماره فاکتور وارد شود و موجود باشد، اطلاعات ویرایش می‌شود.
در صورتی که شماره فاکتور وارد شود و موجود نباشد، فاکتور با آن شماره ذخیره خواهد شد.
reference شماره ارجاع
*date تاریخ فاکتور
*dueDate تاریخ سر رسید فاکتور
*contactCode کد شخص
contactTitle عنوان مشتری/فروشنده در فاکتور
note یادداشت
sent وضعیت ارسال فاکتور
*invoiceType نوع فاکتور ( جدول نوع فاکتور )
status وضعیت فاکتور ( جدول وضعیت فاکتور )
tag فیلد متنی قابل استفاده توسط برنامه‌نویس
freight هزینه حمل
freightPersonCode کد شخص حمل کننده کالا
warehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
project پروژه
salesmanCode کد فروشنده
salesmanPercent درصد پورسانت فروشنده
invoiceItems آرایه‌ای از اقلام فاکتور، شامل ساختار زیر:
rowNumber شماره ردیف
*description توضیحات کالا یا خدمات
*itemCode کد کالا یا خدمات
unit واحد کالا
*quantity تعداد یا مقدار
*unitPrice قیمت واحد
*discount تخفیف
*tax مالیات
serialNumbers شماره سریال
others آرایه‌ای از اضافات و کسورات فاکتور، شامل ساختار زیر:
title عنوان اضافات و کسورات
amount مقدار اضافات و کسورات
add true:اضافات
false:کسورات
currency واحد پول
taxId کد منحصر به فرد مالیاتی
currencyRate نرخ برابری ارز به ارز پایه
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'f6b912...45fdc',
    invoice:{
       number: '1001',
       reference: '',
       date: '2024-07-17 17:30:12',
       dueDate: '2024-07-17 17:30:12',
       contactCode: '000001',
       contactTitle: 'فروشگاه توحید',
       note: '',
       sent: false,
       invoiceType: 0,
       status: 2,
       tag: '',
       freight: 0,
       freightPersonCode: '',
       warehouseReceiptStatus: 1,
       project: 'پروژه یک',
       salesmanCode: 10001,
       salesmanPercent: 30,
       currency: 'IRR',
       invoiceItems: [{
           rowNumber: 1,
           description: 'Galaxy J7 گوشی سامسونگ',
           itemCode: '000001',
           unit: 'عدد',
           quantity: 1,
           unitPrice: 100000,
           discount: 0,
           tax: 9000,
           serialNumbers: ['974900098723']
       }],
     others : [
        {
           "title": "هزینه‌های گمرکی",
           "amount": 1540000.0,
           "add": true 
        }
    ],
     currency: "IRR",
     taxId: "",
     currencyRate: 1.0000000000
   }
}
نکات ضروری
  1. برای فاکتور ضایعات حتما باید فیلد note مقدار داشته باشد.

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

Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن، Object فاکتور ذخیره شده یا ویرایش شده درون Result قرار می گیرد.
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سر رسید فاکتور
ContactCode کد شخص
ContactTitle عنوان مشتری/فروشنده در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخص حمل کننده کالا
FreightPersonName نام شخص حمل کننده کالا
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور، شامل ساختار زیر:
RowNumber شماره ردیف
Description شرح کالا یا خدمات
ItemCode کد کالا یا خدمات
Unit واحد کالا
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum سرجمع قیمت بدون تخفیف و مالیات
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل با احتساب تخفیف و مالیات
SerialNumbers شماره سریال
مثال:
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {...},
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": {...},
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": ["974900098723"]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/delete

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
Copyed 
{
	apiKey: 'asdfASR^%FDHdsfg456',
	loginToken: 'f6b912...45fdc',
	number: 1001,
	type: 0
}

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

Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد.
Copyed 
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: true
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/savePayment

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
type نوع فاکتور ( جدول نوع فاکتور)
number شماره فاکتور فروش
bankCode کد بانک
cashCode کد صندوق
pettyCashCode کد تنخواه‌گردان
contactCode کد شخص
accountPath مسیر حساب
date تاریخ تراکنش
amount مبلغ تراکنش
transactionNumber شماره تراکنش
project نام پروژه، در صورتی که این فیلد ارسال نشود، رسید با پروژه ثبت شده برای فاکتورذخیره خواهد شد.
description توضیحات تراکنش
transactionFee هزینه یا کارمزد تراکنش
currency واحد پول
currencyRate نرخ برابری ارز به ارز پایه
cashCode کد صندوق
pettyCashCode کد تنخواه‌گردان
Copyed 
{
  apiKey: 'asdfASR^%FDHdsfg456',
  loginToken: 'f6b912...45fdc',
  type: 0,
  number: 1001,
  bankCode: '0001',
  date: '2024-07-17T00:00:00',
  amount: 109000,
  transactionNumber: '255496387',
  project: 'فروشگاه آنلاین',
  description: 'پرداخت آنلاین',
  transactionFee: 0
}
نکات ضروری
  1. فقط یکی از پنج فیلد accountPath ، contactCode ،bankCode، cashCode و pettyCashCode باید مقدار داشته باشد.
  2. واحد پول فاکتور با واحد پول بانک، صندوق یا تنخواه‌گردان باید یکی باشد.
  3. در صورت ذکر نشدن 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 مبلغ
Invoice Object فاکتور.
Id id فاکتور
Number شماره فاکتور
DateTime تاریخ ثبت فاکتور
invoiceType نوع فاکتور ( جدول نوع فاکتور )
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 78,
        "Number": 1075,
        "DateTime": "2024-07-17T00:00:00",
        "Description": "پرداخت آنلاین",
        "Amount": 109000.0,
        "Currency": "IRR",
        "CurrencyRate": 1.0000000000,
        "Project": "",
        "Items": [
            {
                "Contact": {
                    "Id": 1,
                    "Code": "000001",
                    "Name": "فروشگاه توحید"
                },
                "Account": "دارایی‌ها : دارایی‌های جاری : حساب‌های دریافتنی : حساب‌های دریافتنی",
                "Amount": 109000.0,
                "Description": "پرداخت آنلاین"
            }
        ],
        "Transactions": [
            {
                "Bank": {
                    "Id": 1,
                    "Code": "0001",
                    "Name": "ملت"
                },
                "Cash": null,
                "PettyCash": null,
                "Contact": null,
                "Check": null,
                "Account": null,
                "Type": 3,
                "Reference": "255496387",
                "TransactionFee": 0.0,
                "Amount": 109000.0
            }
        ],
        "Invoice": {
            "Id": 2,
            "Number": "1001",
            "DateTime": "2024-07-17T00:00:00",
            "InvoiceType": 0
        }
    }
}
توضیحات آرایه Transactions:

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

Copyed
URL:https://api.hesabfa.com/v1/invoice/getOnlineInvoiceUrl

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
Copyed 
{
	apiKey: 'asdfASR^%FDHdsfg456',
	loginToken: 'f6b912...45fdc',
	number: 1001,
	type: 0
}
نکات ضروری
  1. این متد در حال حاظر صرفا برای فاکتورهای فروش فعال است.
  2. در صورتی که درگاه پرداختی اینترنتی فعال نشده باشد، امکان دریافت URL فاکتور آنلاین وجود ندارد.
  3. برای فعالسازی درگاه پرداختی اینترنتی از منوی تنظیمات، تنظیمات فاکتور آنلاین را انتخاب کنید.
آیتم‌های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن مقدار URL فاکتور آنلاین درون Result قرار می گیرد.
Copyed 
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: '',
	Result: "https://app.hesabfa.com/public/invoice?token=FT2bEEe134vmseXMK"
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/SaveWarehouseReceipt
پارامترها :
apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
deleteOldReceipts آیا رسید یا حواله‌های قدیمی برای این فاکتور حذف شوند؟
receipt Object نگهدارنده اطلاعات حواله می باشد.هر Objectشامل ساختار زیر می باشد :

* آیتم‌های ستاره دار ضروری هستند.
*warehouseCode کد انبار
*invoiceNumber شماره فاکتور
*invoiceType نوع فاکتور ( جدول نوع فاکتور )
date تاریخ حواله
note یادداشت و توضیحات
freight هزینه حمل
delivery تحویل (در محل انبار)
project پروژه
*items آرایه‌ای از اقلام حواله، شامل ساختار زیر:
*itemCode کد کالا
*quantity تعداد
reference ارجاع
note توضیحات
Copyed 
{
     apiKey: 'asdfASR^%FDHdsfg456',
     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,
            },
		...
        ]
    }
}
نکات ضروری
  1. با فراخوانی این متد رسید یا حوالۀ انبار برای فاکتور خرید یا فروش صادر می گردد. در صورتی که کالاهای فاکتور در چندین انبار مختلف وجود داشته باشند به ازای هر انبار باید یکبار این متد را فراخوانی کرد و در هر فراخوانی کالاها و تعداد مورد نیاز به تفکیک انبار ذکر گردد.
  2. در صورتی که مقدار پارامتر deleteOldReceipts=true باشد، کلیه حواله‌های قبلی صادر شده برای فاکتور حذف خواهند شد و حواله جدید صادر می‌شود.
  3. کلیه آیتم‌های باید از نوع کالا و با قابلیت کنترل موجودی باشند در غیر اینصورت حواله ثبت نخواهد شد.
آیتم‌های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن، Object حواله ذخیره شده یا ویرایش شده درون Result قرار می گیرد.
Number شماره حوالۀ انبار
InvoiceNumber شماره فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode کد انبار
Date تاریخ حواله
Note یادداشت و توضیحات
Delivery تحویل (در محل انبار)
Freight هزینه حمل
Project پروژه
Items آرایه‌ای از اقلام حواله، شامل ساختار زیر:
ItemCode کد کالا
Reference ارجاع
Note توضیحات
Quantity تعداد
Copyed 
{
	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 
            } 
        ] 
    } 
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/changePaidStatus

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
paid پرداخت شده
Copyed 
{
 apiKey: 'asdfASR^%FDHdsfg456',
 userId: 'mail@example.com',
 password: '123456',
 loginToken: 'f6b912...45fdc',
 number: 1001,
 type: 0,
 paid: true     
}
نکات ضروری
  1. فقط فاکتورهای تایید شده امکان تغییر وضعیت پرداخت را دارند.
آیتم‌های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن، Object فاکتور ذخیره شده یا ویرایش شده درون Result قرار می گیرد.
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سر رسید فاکتور
ContactCode کد شخص
ContactTitle عنوان مشتری/فروشنده در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخص حمل کننده کالا
FreightPersonName نام شخص حمل کننده کالا
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور، شامل ساختار زیر:
RowNumber شماره ردیف
Description شرح کالا یا خدمات
ItemCode کد کالا یا خدمات
Unit واحد کالا
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum سرجمع قیمت بدون تخفیف و مالیات
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل با احتساب تخفیف و مالیات
SerialNumbers شماره سریال
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {...
        },
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": {...
                },
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": [
                    "974900098723"
                ]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Profit": 5000.000,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/changeSentStatus

پارامترها :

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
sent ارسال شده
Copyed 
{
 apiKey: 'asdfASR^%FDHdsfg456',
 userId: 'mail@example.com',
 password: '123456',
 loginToken: 'f6b912...45fdc',
 number: 1001,
 type: 0,
 sent: true     
}
نکات ضروری
  1. فقط فاکتورهای تایید شده امکان تغییر وضعیت ارسال را دارند.
آیتم‌های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن، Object فاکتور ذخیره شده یا ویرایش شده درون Result قرار می گیرد.
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سر رسید فاکتور
ContactCode کد شخص
ContactTitle عنوان مشتری/فروشنده در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخص حمل کننده کالا
FreightPersonName نام شخص حمل کننده کالا
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور، شامل ساختار زیر:
RowNumber شماره ردیف
Description شرح کالا یا خدمات
ItemCode کد کالا یا خدمات
Unit واحد کالا
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum سرجمع قیمت بدون تخفیف و مالیات
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل با احتساب تخفیف و مالیات
SerialNumbers شماره سریال
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {...
        },
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": {...
                },
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": [
                    "974900098723"
                ]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Profit": 5000.000,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null
    }
}