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

دریافت آخرین تغییرات

URL: https://api.hesabfa.com/v1/setting/GetChanges

Request
Response

پارامترهای اجباری:

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

start Id شروع دریافت تغییرات

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     loginToken: 'f6b912...45fdc',
     start: 1337
 }

نکات ضروری

با فراخوانی این متد آخرین تغییرات انجام شده روی ماهیت های فاکتور، کالا و خدمات و اشخاص دریافت می گردد.

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

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

Result آرایه ای از آخرین تغییرات موجود می باشد. هر تغییر شامل ساختار زیر می باشد:

DateTime	تاریخ و ساعت تغییر
Action	نوع عملیات(جدول نوع عملیات)
ObjectId	شناسه ماهیتی که تغییر کرده
ObjectType	نوع ماهیت: Product, Contact, Invoice, WarehouseReceipt, Receipt
Extra	در فیلد Extra کد کالا یا شخص یا کد کالاهای ثبت شده در فاکتور قرار می گیرد. هنگام حذف کالا، شخص یا فاکتور، کد شخص، کالا یا آیتمهای فاکتور حذف شده در این فیلد ثبت می شود
API	در صورتی که مقدار این فیلد true باشد بدین معنی است که تغییر انجام شده توسط API در سیستم اعمال شده است

{
     Success: true,
     ErrorCode: 0,
     ErrorMessage: "",
     Result: 
    [
    {
        "Id": 1337,
        "DateTime": "2020-01-18T15:58:56.0629885",
        "Action": 123,
        "ObjectId": 10,
        "ObjectType": "Invoice",
        "Extra": "000254",
        "API": true

    },
    {
        "Id": 1338,
        "DateTime": "2020-01-18T15:58:56.0907442",
        "Action": 53,
        "ObjectId": 12,
        "ObjectType": "Product",
        "Extra": "000128",
        "API": true
    },
    {
        "Id": 1339,
        "DateTime": "2020-01-18T15:58:56.0916386",
        "Action": 123,
        "ObjectId": 13,
        "ObjectType": "Invoice",
        "Extra": "000752",
        "API": true
    },
    {
        "Id": 1340,
        "DateTime": "2020-01-18T15:58:56.0922324",
        "Action": 31,
        "ObjectId": 14,
        "ObjectType": "Contact",
        "Extra": "000361",
        "API": true
    },
    {
        "Id": 1341,
        "DateTime": "2020-01-18T16:05:16.554849",
        "Action": 32,
        "ObjectId": 17,
        "ObjectType": "Contact",
        "Extra": "000816",
        "API": true
    }
    ]
}

دریافت لیست سال مالی

URL: https://api.hesabfa.com/v1/setting/GetFiscalYears

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
}

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

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

Result

Name	نام سال مالی
StartDate	تاریخ شروع سال مالی
EndDate	تاریخ پایان سال مالی
Closed	بسته شده
FirstYear	اولین سال مالی

{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": [{
        "Name": "سال مالی منتهی به 1402/12/29",
        "StartDate": "2023-03-20T00:00:00",
        "EndDate": "2024-03-19T00:00:00",
        "Closed": "false",
        "FirstYear": true
     }]
}

دریافت لیست بانک ها

URL: https://api.hesabfa.com/v1/setting/GetBanks

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
    
 }

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

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

Result آرایه ای از بانک های موجود می باشد. هر بانک شامل ساختار زیر می باشد:

Code	کد بانک
AccountNumber	شماره حساب
Name	نام بانک
Branch	شعبه
Currency	واحد پول

{
     Success: true,
     ErrorCode: 0,
     ErrorMessage: "",
     Result: [
        {
            "Id": 1,
            "Code": "0001",
            "AccountNumber": "4564512",
            "Name": "بانک ملت",
            "Branch": "استقلال",
            "Currency": "IRR"
        },
        {
            "Id": 2,
            "Code": "0002",
            "AccountNumber": "57812459",
            "Name": "بانك تجارت",
            "Branch": "معلم",
            "Currency": "IRR"
        },
        {...},
        {...}
    ]
}

دریافت لیست صندوق ها

URL: https://api.hesabfa.com/v1/setting/GetCashes

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
}

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

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

Result آرایه ای از صندوق های موجود می باشد. هر صندوق شامل ساختار زیر می باشد:

Code	کد صندوق
Name	نام صندوق
Currency	واحد پول

{
     Success: true,
     ErrorCode: 0,
     ErrorMessage: "",
     Result: [
        {
            "Id": 1,
            "Code": "0001",
            "Name": "صندوق اصلی",
            "Currency": "IRR"
        },
        {
            "Id": 2,
            "Code": "0002",
            "Name": "صندوق فروشگاه",
            "Currency": "IRR"
        },
        {...},
        {...}
    ]
}

دریافت لیست تنخواه گردان ها

URL: https://api.hesabfa.com/v1/setting/GetPettyCashes

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
}

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

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

Result آرایه ای از تخواه گردان های موجود می باشد. هر تنخواه گردان شامل ساختار زیر می باشد:

Name	نام تنخواه گردان
Code	کد تنخواه گردان
Currency	واحد پول

{
     Success: true,
     ErrorCode: 0,
     ErrorMessage: "",
     Result: [
        {
            "Id": 1,
            "Code": "0001",
            "Name": "تنخواه گردان خانم احمدی",
            "Currency": "IRR",
        },
       ]
}

دریافت واحد پول

URL: https://api.hesabfa.com/v1/setting/GetCurrency

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

نکات ضروری

با فراخوانی این متد واحد پول پیش فرض سیستم دریافت می گردد.

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

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

Currency واحد پول

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Currency": "IRR"
    }
}

دریافت لیست انبارها

URL: https://api.hesabfa.com/v1/setting/GetWarehouses

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

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

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

Result آرایه ای از انبارهای موجود می باشد. هر انبار شامل ساختار زیر می باشد:

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

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        { 
            "Id": 5, 
            "Code": 11, 
            "Name": "انبار اصلی" 
        }, 
        { 
            "Id": 6, 
            "Code": 12, 
            "Name": "انبار 2" 
        }, 
        {…}, 
        {…} 
    ] 
    }
}

دریافت لیست دسته بندی کالاها

URL: https://api.hesabfa.com/v1/setting/GetProductCategories

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

نکات ضروری

با فراخوانی این متد درختواره دسته بندی کالاهای ثبت شده در سیستم ارسال می شود.

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

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

Result Object لیست دسته بندی کالاها

Root	دسته بندی ریشه

Name	نام دسته بندی
FullPath	مسیر دسته بندی
Children	زیر شاخه ها

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Root": {
            "Name": "کالاها",
            "FullPath": "کالاها",
            "Children": [
                {
                    "Name": "صوتی تصویری",
                    "FullPath": " کالاها: صوتی تصویری",
                    "Children": []
                },
                {
                    "Name": "لوازم خانگی",
                    "FullPath": " کالاها: لوازم خانگی",
                    "Children": [
                        {
                            "Name": "آشپزخانه",
                            "FullPath": " کالاها: لوازم خانگی آشپزخانه :",
                            "Children": []
                        }
                    ]
                }
            ]
        }
    }
}

دریافت لیست دسته بندی خدمات

URL: https://api.hesabfa.com/v1/setting/GetServiceCategories

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

نکات ضروری

با فراخوانی این متد درختواره دسته بندی خدمات ثبت شده در سیستم ارسال می شود.

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

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

Result Object لیست دسته بندی خدمات

Root	دسته بندی ریشه

Name	نام دسته بندی
FullPath	مسیر دسته بندی
Children	زیرشاخه ها

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Root": {
            "Name": "خدمات",
            "FullPath": "خدمات",
            "Children": [
                {
                    "Name": "درون شرکت",
                    "FullPath": " خدمات: درون شرکت",
                    "Children": []
                },
                {
                    "Name": "خارج از شرکت",
                    "FullPath": " خدمات: خارج از شرکت",
                    "Children": []
                }
            ]
        }
    }
}

دریافت لیست دسته بندی اشخاص

URL: https://api.hesabfa.com/v1/setting/GetContactCategories

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

نکات ضروری

با فراخوانی این متد درختواره دسته بندی اشخاص ثبت شده در سیستم ارسال می شود.

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

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

Result Object لیست دسته بندی اشخاص

Root	دسته بندی ریشه

Name	نام دسته بندی
FullPath	مسیر دسته بندی
Children	زیر شاخه ها

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Root": {
            "Name": "اشخاص",
            "FullPath": "اشخاص",
            "Children": [
                {
                    "Name": "پرسنل",
                    "FullPath": " اشخاص: درون شرکت",
                    "Children": []
                },
                {
                    "Name": "تامین کنندگان",
                    "FullPath": " اشخاص: تامین کنندگان",
                    "Children": []
                },
                {
                    "Name": "سازمان ها",
                    "FullPath": " اشخاص: سازمان ها",
                    "Children": []
                }
            ]
        }
    }
}

دریافت اطلاعات سال مالی جاری

URL: https://api.hesabfa.com/v1/setting/GetFiscalYear

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

نکات ضروری

با فراخوانی این متد اطلاعات سال مالی جاری ارسال می گردد.

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

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

Result

Name	نام سال مالی
StartDate	تاریخ شروع سال مالی
EndDate	تاریخ پایان سال مالی

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Name": "سال مالی منتهی به 1399/6/31",
        "StartDate": "2019-03-20T00:00:00",
        "EndDate": "2020-09-21T00:00:00"
    }
}

دریافت لیست پروژه ها

URL: https://api.hesabfa.com/v1/setting/GetProjects

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

نکات ضروری

با فراخوانی این متد لیست کلیه پروژه های ثبت شده در سال مالی جاری ارسال می شود.

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

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

Result آرایه ای از لیست پروژه ها موجود می باشد. هر پروژه شامل ساختار زیر می باشد:

Title	نام پروژه
Active	فعال بودن پروژه

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        {
            "Id": 2,
            "Title": "پروژه 1",
            "Active": true
        },
        {
            "Id": 2,
            "Title": "پروژه فروش مهرماه",
            "Active": true
        }        
        {…},
        {…} 
    ]
    }
}

دریافت لیست فروشنده ها

URL: https://api.hesabfa.com/v1/setting/GetSalesmen

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

نکات ضروری

با فراخوانی این متد لیست کلیه فروشنده های ثبت شده در سال مالی جاری ارسال می شود.

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

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

Result آرایه ای از لیست فروشنده ها موجود می باشد. هر فروشنده شامل ساختار زیر می باشد:

Code	کد فروشنده
Name	نام فروشنده
Active	فعال بودن فروشنده
Note	یادداشت

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        {
            "Id": 7,
            "Code": "000001",
            "Name": "محمد امینی",
            "Active": true,
            "Note": "دفتر مرکزی"
        },
        {
            "Id": 8,
            "Code": "000002",
            "Name": "سارا شریعتی",
            "Active": true,
            "Note": "بازاریاب سایر"
        },        
        {…}, 
        {…} 
    ] 
    }
}

دریافت جدول نرخ برابری ارزها

URL: https://api.hesabfa.com/v1/setting/GetCurrencyTable

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }

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

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

Result آرایه ای از جدول نرخ برابری ارزها موجود می باشد. هر جدول نرخ برابری ارز شامل ساختار زیر می باشد:

From	از
To	به
Rate	ضریب تبدیل

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        {
            "From": "USD",
            "To": "IRR",
            "Rate": 234500.0
        },
        {
            "From": "AED",
            "To": "IRR",
            "Rate": 68000.0
        },        
        {…}, 
        {…} 
    ] 
    }
}

تنظیم جدول نرخ برابری ارزها

URL: https://api.hesabfa.com/v1/setting/SetCurrencyTable

Request
Response

پارامترهای اجباری:

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

table آرایه ای از جدول نرخ برابری ارزها. هر جدول نرخ برابری ارز شامل ساختار زیر می باشد:

from	از
to	به
rate	ضریب تبدیل

{
     apiKey: "asdfASR^%FDHdsfg456",
     userId: "mail@example.com",
     password: "123456",
     table: [
     {
        "from": "USD",
        "to": "IRR",
        "rate": 234500
     },
     {
        "from": "AED",
        "to": "IRR",
        "rate": 68000
     }]
 }

نکات ضروری

با فراخوانی این متد می توانید جدول نرخ برابری ارزها را تنظیم کنید. دقت کنید که ارز با ارزش تر را در قسمت From قرار دهید، به عبارت دیگر نرخ برابری نباید از یک کمتر باشد.

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

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

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

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: true
}

دریافت جدول حساب ها

URL: https://api.hesabfa.com/v1/setting/GetAccounts

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
}

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

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

Result آرایه ای از جدول حساب ها موجود می باشد. هر جدول حساب شامل ساختار زیر می باشد:

Name	نام حساب
FullPath	مسیر حساب
DetailType	نوع تفصیل(جدول نوع تفصیل)

{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result:[
		{
			"Name": "دارایی ها",
			"FullPath": "دارایی ها",
			"DetailType": 6  
		},
		{
			"Name": "دارایی های جاری",
			"FullPath": "دارایی ها : دارایی های جاری",
			"DetailType": 6
		},
		{
			"Name": "موجودی نقد و بانک",
			"FullPath": "دارایی ها : دارایی های جاری : موجودی نقد و بانک",
			"DetailType": 6 
	   },        
		{…}, 
		{…} 
	 ] 
}

دریافت لیست قیمت پیش فرض

URL: https://api.hesabfa.com/v1/setting/getDefaultPriceList

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     loginToken: '...',
}

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

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

Result

Title	عنوان
Currency	واحد پول

{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": [
        {
            "Title": "عمده",
            "Currency": "IRR"
        },
        {
            "Title": "همکار",
            "Currency": "IRR"
        },
        {
            "Title": "مشتری ویژه",
            "Currency": "IRR"
        },
        {
            "Title": "دلاری",
            "Currency": "USD"
        }
    ]
}

دریافت اطلاعات کسب و کار

URL: https://api.hesabfa.com/v1/setting/GetBusinessInfo

Request
Response

پارامترهای اجباری:

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

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
}

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

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

Result

Name	نام کسب و کار
LegalName	نام قانونی
Calendar	تقویم
Currency	واحد پول اصلی
SupportMultiCurrency	امکان استفاده از سیستم چند ارزی
OtherCurrencies	سایر ارزها
Subscription	طرح
Credit	اعتبار سند
ExpireDate	تاریخ انقضا

{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Name": "فروشگاه آنلاین",
        "LegalName": "فروشگاه آنلاین حسابفا",
        "Calendar": "Persian",
        "Currency": "IRR",
        "SupportMultiCurrency": false,
        "OtherCurrencies": "",
        "Subscription": 4,
        "Credit": 0,
        "ExpireDate": "2024-04-16T00:00:00"
    }
}

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

دریافت آخرین تغییرات

دریافت لیست سال مالی

دریافت لیست بانک ها

دریافت لیست صندوق ها

دریافت لیست تنخواه گردان ها

دریافت واحد پول

دریافت لیست انبارها

دریافت لیست دسته بندی کالاها

دریافت لیست دسته بندی خدمات

دریافت لیست دسته بندی اشخاص

دریافت اطلاعات سال مالی جاری

دریافت لیست پروژه ها

دریافت لیست فروشنده ها

دریافت جدول نرخ برابری ارزها

تنظیم جدول نرخ برابری ارزها

دریافت جدول حساب ها

دریافت لیست قیمت پیش فرض

دریافت اطلاعات کسب و کار