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

متدهای دریافت گزارش در رابط برنامه نویسی حسابفا

Copyed
URL: https://api.hesabfa.com/v1/report/balancesheet

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
Copyed 
{
    apiKey:"...",
    loginToken:"...",
    startDate: "2021-01-01T00:00:00Z", 
    endDate: "2022-01-01T00:00:00Z",  
    project: "دفتر اصلی" 
}
نکات ضروری

در صورت عدم ذکر تاریخ شروع و پایان گزارش، سیستم بر اساس تاریخ شروع و پایان سالی مالی گزارش را ارائه خواهد کرد.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش ترازنامه درون Result قرار می گیرد.
Accounts حساب ها
Account حساب
Name نام حساب
MainAccountType نوع حساب اصلی(جدول نوع حساب اصلی)
DetailType نوع تفصیل(جدول نوع تفصیل)
Debit گردش بدهکار
Credit گردش بستانکار
TotalDebit تراز - بدهکار
TotalCredit تراز - بستانکار
Balance تراز حساب
TotalBalance تراز کل حساب
Children زیر شاخه ها
Assets سرجمع دارایی ها
Liabilities بدهی ها
Equity حقوق صاحبان سهام
ProfitOrLoss سود و زیان
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Accounts": [
            {
                "Account": {
                    "Name": "دارایی ها",
                    "MainAccountType": 1,
                    "DetailType": 6
                },
                "Debit": 0.0,
                "Credit": 0.0,
                "TotalDebit": 938740984721.0000000000,
                "TotalCredit": 3345011191.0000000000,
                "Balance": 0.0,
                "TotalBalance": 935395973530.0000000000,
                "Children":[
                    {
                        "Account": {
                            "Name": "دارایی های جاری",
                            "MainAccountType": 1,
                            "DetailType": 6
                        },
                        "Debit": 0.0,
                        "Credit": 0.0,
                        "TotalDebit": 938367507121.0000000000,
                        "TotalCredit": 3336961191.0000000000,
                        "Balance": 0.0,
                        "TotalBalance": 935030545930.0000000000,
                        "Children": [...],
                        },
                        {...},
                        {...},
                        {...},
                 ]
                    },
              {...},
              {...},
        ],
        "Assets": 935395973530.0000000000,
        "Liabilities": 934003786599.0000000000,
        "Equity": 1104786500.0000000000,
        "ProfitOrLoss": 287400431.0000000000
    }
}
Copyed
URL: https://api.hesabfa.com/v1/report/debtorscreditors

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
Copyed 
{
    apiKey:"...",
    loginToken:"...",
    startDate: "2021-01-01T00:00:00Z", 
    endDate: "2022-01-01T00:00:00Z",  
    project: "دفتر اصلی" 
}
نکات ضروری

در صورت عدم ذکر تاریخ شروع و پایان گزارش، سیستم بر اساس تاریخ شروع و پایان سالی مالی گزارش را ارائه خواهد کرد.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش بدهکاران و بستانکاران درون Result قرار می گیرد.
Code کد حسابداری شخص
Name نام شخص
NodeName نام دسته بندی
NodeFamily مسیر دسته بندی
Debit گردش بدهکار
Credit گردش بستانکار
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "Code": "000001",
            "Name": "حمیدرضا قره زاده",
            "NodeName": "اشخاص",
            "NodeFamily": "اشخاص : تست ۴ : اشخاص",
            "Debit": 297406639.0,
            "Credit": 55516582958.0
        },
        {
            "Code": "000002",
            "Name": "حسین دوست",
            "NodeName": "غیررسمی",
            "NodeFamily": "اشخاص : غیررسمی",
            "Debit": 197941998.0,
            "Credit": 107905527.0
        },
        {...},
        {...},
        {...}
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/report/inventory

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
Copyed 
{
    apiKey:"...",
    loginToken:"...",
    startDate: "2021-01-01T00:00:00Z", 
    endDate: "2022-01-01T00:00:00Z",  
    project: "دفتر اصلی" 
}
نکات ضروری

در صورت عدم ذکر تاریخ شروع و پایان گزارش، سیستم بر اساس تاریخ شروع و پایان سالی مالی گزارش را ارائه خواهد کرد.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result درون فیلد result آرایه ای از سندها قرار میگیرد.
Code کدحسابداری
Name نام
NodeName نام دسته بندی
NodeFamily مسیر دسته بندی
MainUnit واحد اصلی
SubUnit واحد فرعی
ProductCode کد محصول
Amount مبلغ
Quantity تعداد
Opening موجودی اول دوره
Increase افزایش طی دوره
Decrease کاهش طی دوره
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "Code": "000002",
            "Name": "گوشی (script) 1/5٪ ?",
            "NodeName": "زیرگروه 2",
            "NodeFamily": "کالاها : گروه یک : زیر گروه یک 1 : زیرگروه 2",
            "MainUnit": "عدد",
            "SubUnit": "متر",
            "ProductCode": "asdfasfd",
            "Amount": 15500595.0,
            "Quantity": 69.0000,
            "Opening": 100.0000,
            "Increase": 47.0000,
            "Decrease": 78.0000
        },
        {
            "Code": "000003",
            "Name": "كالاي 3",
            "NodeName": "گروه یک",
            "NodeFamily": "کالاها : گروه یک",
            "MainUnit": "",
            "SubUnit": "",
            "ProductCode": "",
            "Amount": 30000.0,
            "Quantity": 6.0000,
            "Opening": 50.0000,
            "Increase": 26.0000,
            "Decrease": 70.0000
        },
            {...},
            {...},
            {...},
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/report/profitandlossstatement

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
Copyed 
{
    apiKey:"...",
    loginToken:"...",
    startDate: "2021-01-01T00:00:00Z", 
    endDate: "2022-01-01T00:00:00Z",  
    project: "دفتر اصلی" 
}
نکات ضروری

در صورت عدم ذکر تاریخ شروع و پایان گزارش، سیستم بر اساس تاریخ شروع و پایان سالی مالی گزارش را ارائه خواهد کرد.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش سود و زیان درون Result قرار می گیرد.
Accounts حساب ها
Account حساب
Name نام حساب
MainAccountType نوع حساب اصلی(جدول نوع حساب اصلی)
DetailType نوع تفصیل(جدول نوع تفصیل)
Debit گردش بدهکار
Credit گردش بستانکار
TotalDebit تراز - بدهکار
TotalCredit تراز - بستانکار
Balance تراز حساب
TotalBalance تراز کل حساب
Children زیر شاخه ها
InventoryAdjustment کنترل کسری و اضافه کالا
Account حساب
Name نام حساب
MainAccountType نوع حساب اصلی(جدول نوع حساب اصلی)
DetailType نوع تفصیل(جدول نوع تفصیل)
Debit گردش بدهکار
Credit گردش بستانکار
TotalDebit تراز - بدهکار
TotalCredit تراز - بستانکار
Balance تراز حساب
TotalBalance تراز کل حساب
Children زیر شاخه ها
BeginningInventory موجودی ابتدای دوره
EndingInventory موجودی پایان دوره
ProfitOrLoss سود یا زیان
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Accounts": [
            {
                "Account": {
                    "Name": "دارایی ها",
                    "MainAccountType": 1,
                    "DetailType": 6
                },
                "Debit": 0.0,
                "Credit": 0.0,
                "TotalDebit": 938740984721.0000000000,
                "TotalCredit": 3345011191.0000000000,
                "Balance": 0.0,
                "TotalBalance": 935395973530.0000000000,
                "Children": [],
                    "InventoryAdjustment": {
                        "Account": {
                            "Name": "کنترل کسری و اضافه کالا",
                            "MainAccountType": 8,
                            "DetailType": 5
                        },
                        "Debit": 0.0,
                        "Credit": 199866168.0000000000,
                        "TotalDebit": 0.0,
                        "TotalCredit": 199866168.0000000000,
                        "Balance": 199866168.0000000000,
                        "TotalBalance": 199866168.0000000000,
                        "Children": []
                    },
                    "BeginningInventory": 600850000.0,
                    "EndingInventory": 54165611488.0,
                    "ProfitOrLoss": 287400431.0000000000
         ]
    }
}
نکات ضروری

در صورتی که سیستم حسابداری ادواری باشد فیلدهای EndingInventory , BeginningInventory , InventoryAdjustment را در خروجی خواهیم داشت .اما اگر سیستم حسابداری دائمی باشد این سه فیلد در خروجی وجود نخواهند داشت.

Copyed
URL: https://api.hesabfa.com/v1/report/trialbalance

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
Copyed 
{
    apiKey:"...",
    loginToken:"...",
    startDate: "2021-01-01T00:00:00Z", 
    endDate: "2022-01-01T00:00:00Z",  
    project: "دفتر اصلی" 
}
نکات ضروری

در صورت عدم ذکر تاریخ شروع و پایان گزارش، سیستم بر اساس تاریخ شروع و پایان سالی مالی گزارش را ارائه خواهد کرد.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش تراز آزمایشی درون Result قرار می گیرد.
Account حساب
Name نام حساب
Path مسیر حساب
AccountType نوع حساب(جدول نوع حساب)
MainAccountType نوع حساب اصلی(جدول نوع حساب اصلی)
Debit گردش بدهکار
Credit گردش بستانکار
Balance تراز حساب
BalanceType ماهیت حساب(جدول نوع ماهیت حساب)
OpeningDebit تراز افتتاحیه - بدهکار
OpeningCredit تراز افتتاحیه - بستانکار
RemainingDebit مانده از قبل - بدهکار
RemainingCredit مانده از قبل - بستانکار
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "Account": {
                "Name": "دارایی ها",
                "Path": "دارایی ها",
                "AccountType": 0,
                "MainAccountType": 1
            },
            "Debit": 219158621.0000000000,
            "Credit": 58462244.0000000000,
            "Balance": 160696377.0000000000,
            "BalanceType": 0,
            "OpeningDebit": 1052136000.0000000000,
            "OpeningCredit": 0.0,
            "RemainingDebit": 884957064612.0000000000,
            "RemainingCredit": 3286548947.0000000000
        },
        {...},
        {...},
        {...}
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/report/trialbalanceitems

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
*accountPath مسیر حساب

* آیتم های ستاره دار ضروری هستند.
Copyed 
{
    apiKey:"...",
    loginToken:"...",
    startDate: "2021-01-01T00:00:00Z", 
    endDate: "2022-01-01T00:00:00Z", 
    project: "دفتر اصلی" 
    accountPath: "دارایی ها : دارایی های جاری : موجودی نقد و بانک : بانک" 
}
نکات ضروری

در صورت عدم ذکر تاریخ شروع و پایان گزارش، سیستم بر اساس تاریخ شروع و پایان سالی مالی گزارش را ارائه خواهد کرد.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش آیتم های تفصیل تراز آزمایشی درون Result قرار می گیرد.
Code کد تفصیل (کالا - شخص - بانک - تنخواه گردان - صندوق)
Name نام تفصیل
Debit گردش بدهکار
Credit گردش بستانکار
Balance تراز حساب
BalanceType ماهیت حساب(جدول نوع ماهیت حساب)
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "Code": "0001",
            "Name": "0001 - بانک ملت - 4564512",
            "Debit": 570900210.0000000000,
            "Credit": 562380200.0000000000,
            "Balance": 8520010.0000000000,
            "BalanceType": 0
        },
        {
            "Code": "0002",
            "Name": "0002 - بانك تجارت (معلم) - 45646132",
            "Debit": 37951000.0000000000,
            "Credit": 260300.0000000000,
            "Balance": 37690700.0000000000,
            "BalanceType": 0
        },
        {...},
        {...},
        {...}
    ]
}
نکات ضروری

درصورتی که تفصیل حساب انتخاب شده کالا باشد،فیلد Code و Name مربوط به کالا خواهد بود.درصورتی که تفصیل حساب انتخاب شده شخص باشد فیلد Code و Name مربوط به شخص خواهد بود و بدین ترتیب...

Copyed
URL: https://api.hesabfa.com/v1/report/bank

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
*code کد بانک

* آیتم های ستاره دار ضروری هستند.
Copyed 
{
    "apiKey":"...",
    "loginToken":"...",
    "startDate": "2023-01-01T00:00:00Z", 
    "endDate": "2024-01-01T00:00:00Z",  
    "project": "پروژه یک",
    "code": 1    
}

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش گردش حساب بانک درون Result قرار می گیرد.
DateTime تاریخ
DocumentNumber شماره سند
Description شرح
Amount مبلغ
Type نوع تراکنش ( جدول نوع تراکنش )
Debit بدهکار
Credit بستانکار
Reference ارجاع
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "DateTime": "2024-01-20T00:00:00",
            "DocumentNumber": 220,
            "Description": "انتقال وجه از بانک ملت به بانك تجارت (معلم)",
            "Amount": 6000.0000,
            "Type": 1,
            "Debit": 0.0,
            "Credit": 6000.0000,
            "Reference": ""
        },
        {...},
        {...},
        {...}
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/report/cash

پارامترها :

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
*code کد صندوق

* آیتم های ستاره دار ضروری هستند.
Copyed 
{
    "apiKey":"...",
    "loginToken":"...",
    "startDate": "2023-01-01T00:00:00Z", 
    "endDate": "2024-01-01T00:00:00Z",  
    "project": "پروژه یک",
    "code": 4    
}

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش گردش حساب صندوق درون Result قرار می گیرد.
DateTime تاریخ
DocumentNumber شماره سند
Description شرح
Amount مبلغ
Type نوع تراکنش ( جدول نوع تراکنش )
Debit بدهکار
Credit بستانکار
Reference ارجاع
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "DateTime": "2024-01-20T00:00:00",
            "DocumentNumber": 220,
            "Description": "انتقال وجه از بانک ملت به صندوق جاری",
            "Amount": 6000.0000,
            "Type": 1,
            "Debit": 0.0,
            "Credit": 6000.0000,
            "Reference": ""
        },
        {...},
        {...},
        {...}
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/report/pettyCash

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
*code کد تنخواه گردان

* آیتم های ستاره دار ضروری هستند.
Copyed 
{
    "apiKey":"...",
    "loginToken":"...",
    "startDate": "2023-01-01T00:00:00Z", 
    "endDate": "2024-01-01T00:00:00Z",  
    "project": "پروژه یک",
    "code": 5    
}

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش گردش حساب تنخواه گردان درون Result قرار می گیرد.
DateTime تاریخ
DocumentNumber شماره سند
Description شرح
Amount مبلغ
Type نوع تراکنش ( جدول نوع تراکنش )
Debit بدهکار
Credit بستانکار
Reference ارجاع
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "DateTime": "2024-01-20T00:00:00",
            "DocumentNumber": 220,
            "Description": "انتقال وجه از صندوق مرکزی به تنخواه گردان",
            "Amount": 6000.0000,
            "Type": 1,
            "Debit": 0.0,
            "Credit": 6000.0000,
            "Reference": ""
        },
        {...},
        {...},
        {...}
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/report/journal

پارامترها:

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
startDate تاریخ شروع
endDate تاریخ پایان
project عنوان پروژه
take حداکثر تعداد رکورد بازگشتی
در صورتی که پارامتر take ارسال نشود، حداکثر 1000 رکورد ارسال می شود
skip تعداد رکوردی که از ابتدای لیست صرف نظر می شود.
Copyed 
{
    "apiKey":"...",
    "loginToken":"...",
    "startDate": "2016-01-01T00:00:00Z", 
    "endDate": "2024-01-01T00:00:00Z",  
    "project": "پروژه یک",
    "take": 10,
    "skip": 20         
}

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object گزارش دفتر روزنامه درون Result قرار می گیرد.
DateTime تاریخ
AccountPath مسیر حساب
Detail تفضیل حساب
DocumentNumber شماره سند
Description شرح
Debit بدهکار
Credit بستانکار
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
        {
            "TotalCount": 745,
            "FilteredCount": 0,
            "Description": "انتقال وجه از صندوق مرکزی به تنخواه گردان",
            "From": 21,
            "To": 31,
            "List": [
                 {  
                     "DateTime": "2020-08-25T00:00:00",
                     "AccountPath": "دارایی ها : دارایی های جاری : حساب های دریافتنی : حساب های دریافتنی",  
                     "Detail": "حسین دوست",   
                     "DocumentNumber": 302,   
                     "Description": "حساب های دریافتنی - حسین دوست", 
                     "Type": 0
                     "Debit": 14175.0000,                         
                     "Credit": 0.0    
                 },
        {...},
        {...},
        {...}
    ]
}