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

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

Copyed
URL: https://api.hesabfa.com/v1/inquiry/credit

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed 
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     loginToken: 'f6b912...45fdc',
 }

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

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

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*nationalCode کد ملی
*birthDate تاریخ تولد
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",  
	 "birthDate": "1999-01-01"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
Matched مطابقت
FirstName نام
LastName نام خانوادگی
NationalCode کد/شناسه ملی
IsDead فوت شده
Alive در قید حیات
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
			"FirstName": "حسن",
			"LastName": "حسنی",
			"NationalCode": "1234567890",
			"IsDead": false,   
			"Alive" : true  
	       }
    }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/checkMobileAndNationalCode

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*nationalCode کد ملی
*mobile شماره موبایل
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",  
	 "mobile": "09123456789"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
Matched مطابقت
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
	        	}
     }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/checkCardAndNationalCode

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*nationalCode کد ملی
*cardNumber شماره کارت
*birthDate تاریخ تولد
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",  
	 "cardNumber": "6199999999999999"
	 "birthDate": "2000-02-05"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
Matched مطابقت
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
			}
	  }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/checkIbanAndNationalCode

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*nationalCode کد ملی
*birthDate تاریخ تولد
*iban شماره شبا
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",
	 "birthDate": "1999-01-01"	 
	 "iban": "IR910100010000001234567890"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
Matched مطابقت
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
			}
	  }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/iban

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*iban شماره شبا
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "iban": "IR910100010000001234567890"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
Name نام و نام خانوادگی
BankName نام بانک
IsTransferable قابلیت انتقال وجه
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Name": "حسن حسنی",
			"BankName": "ملت",
			"IsTransferable": true
			}
	  }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/card

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*cardNumber شماره کارت
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "cardNumber": "6199999999999999"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
Name نام و نام خانوادگی
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Name": "حسن حسنی",
			}
	  }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/cardToIban

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*cardNumber شماره کارت
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "cardNumber": "6199999999999999"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
IBAN شماره شبا
BankName نام بانک
Name نام و نام خانوادگی
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"IBAN": "IR910100010000001234567890",
			"BankName": "ملت",
			"Name": "حسن حسنی"
			}
	  }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/accountToIBAN

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*account شماره حساب
*bank کد بانک (جدول کد بانک )
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "account": "6199999999999999",
	 "bank": "012",
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
IBAN شماره شبا
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"IBAN": "IR910100010000001234567890",
			}
	  }
}
Copyed
URL: https://api.hesabfa.com/v1/inquiry/postalCode

پارامترها:

apiKey
userId
password
loginToken
 پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
*postalCode کد پستی
Copyed 
{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "postalCode": "6199999999999999"
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.
Status وضعیت
Message پیام موفقیت یا خطا
Data
Address Object آدرس
Province استان
Town شهرستان
District منطقه
Street خیابان اصلی
Street2 خیابان فرعی
Number پلاک
Floor طبقه
SideFloor واحد
BuildingName نام ساختمان
Description توضیحات
Copyed 
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Address": {
				"Province": "استان تهران",
				"Town": " شهرستان تهران ",              
				"District": " محله 1",              
				"Street": " بلوار مدرس",              
				"Street2": " خیابان مدرس ",              
				"Number": "1",              
				"Floor": " طبقه همکف",              
				"SideFloor": "2", 
				"BuildingName": "ساختمان صدف",             
				"Description": "-"             
				}
			  }
	       }  
}