2023-01-01 00:00:00 persion مستندات راهنمای حسابفا واسط API متدهای دریافت گزارش. https://www.hesabfa.com/help/Setting/ سایر متدهای API حسابفا

تنظیمات


Copyed
URL: https://api.hesabfa.com/v1/setting/GetChanges
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
start Id شروع دریافت تغییرات
Copyed
{
     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
Extra در فیلد Extra کد کالا یا شخص یا کد کالاهای ثبت شده در فاکتور قرار می گیرد. هنگام حذف کالا، شخص یا فاکتور، کد شخص، کالا یا آیتمهای فاکتور حذف شده در این فیلد ثبت می شود
API در صورتی که مقدار این فیلد true باشد بدین معنی است که تغییر انجام شده توسط API در سیستم اعمال شده است
Copyed
{
     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
    }
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetBanks
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result آرایه ای از بانک های موجود می باشد. هر بانک شامل ساختار زیر می باشد:
Code کد بانک
AccountNumber شماره حساب
Name نام بانک
Branch شعبه
Currency واحد پول
Copyed
{
     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"
        },
        {...},
        {...}
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetCurrency
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
نکات ضروری

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

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
Result
(مشاهده توضیحات)
Currency واحد پول
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Currency": "IRR"
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetWarehouses
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result آرایه ای از انبارهای موجود می باشد. هر انبار شامل ساختار زیر می باشد:
Code کد انبار
Name نام انبار
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        { 
            "Id": 5, 
            "Code": 11, 
            "Name": "انبار اصلی" 
        }, 
        { 
            "Id": 6, 
            "Code": 12, 
            "Name": "انبار 2" 
        }, 
        {…}, 
        {…} 
    ] 
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetProductCategories
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
نکات ضروری

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

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result Object لیست دسته بندی کالاها
Root دسته بندی ریشه
Name نام دسته بندی
FullPath مسیر دسته بندی
Children زیر شاخه ها
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Root": {
            "Name": "کالاها",
            "FullPath": "کالاها",
            "Children": [
                {
                    "Name": "صوتی تصویری",
                    "FullPath": " کالاها: صوتی تصویری",
                    "Children": []
                },
                {
                    "Name": "لوازم خانگی",
                    "FullPath": " کالاها: لوازم خانگی",
                    "Children": [
                        {
                            "Name": "آشپزخانه",
                            "FullPath": " کالاها: لوازم خانگی آشپزخانه :",
                            "Children": []
                        }
                    ]
                }
            ]
        }
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetServiceCategories
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
نکات ضروری

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

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result Object لیست دسته بندی خدمات
Root دسته بندی ریشه
Name نام دسته بندی
FullPath مسیر دسته بندی
Children زیرشاخه ها
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Root": {
            "Name": "خدمات",
            "FullPath": "خدمات",
            "Children": [
                {
                    "Name": "درون شرکت",
                    "FullPath": " خدمات: درون شرکت",
                    "Children": []
                },
                {
                    "Name": "خارج از شرکت",
                    "FullPath": " خدمات: خارج از شرکت",
                    "Children": []
                }
            ]
        }
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetContactCategories
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
نکات ضروری

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

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result Object لیست دسته بندی اشخاص
Root دسته بندی ریشه
Name نام دسته بندی
FullPath مسیر دسته بندی
Children زیر شاخه ها
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Root": {
            "Name": "اشخاص",
            "FullPath": "اشخاص",
            "Children": [
                {
                    "Name": "پرسنل",
                    "FullPath": " اشخاص: درون شرکت",
                    "Children": []
                },
                {
                    "Name": "تامین کنندگان",
                    "FullPath": " اشخاص: تامین کنندگان",
                    "Children": []
                },
                {
                    "Name": "سازمان ها",
                    "FullPath": " اشخاص: سازمان ها",
                    "Children": []
                }
            ]
        }
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetFiscalYear
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
نکات ضروری

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

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result
Name نام سال مالی
StartDate تاریخ شروع سال مالی
EndDate تاریخ پایان سال مالی
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Name": "سال مالی منتهی به 1399/6/31",
        "StartDate": "2019-03-20T00:00:00",
        "EndDate": "2020-09-21T00:00:00"
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetProjects
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
نکات ضروری

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

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result آرایه ای از لیست پروژه ها موجود می باشد. هر پروژه شامل ساختار زیر می باشد:
Title نام پروژه
Active فعال بودن پروژه
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        {
            "Id": 2,
            "Title": "پروژه 1",
            "Active": true
        },
        {
            "Id": 2,
            "Title": "پروژه فروش مهرماه",
            "Active": true
        }        
        {…},
        {…} 
    ]
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetSalesmen
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
نکات ضروری

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

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result آرایه ای از لیست فروشنده ها موجود می باشد. هر فروشنده شامل ساختار زیر می باشد:
Code کد فروشنده
Name نام فروشنده
Active فعال بودن فروشنده
Note یادداشت
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        {
            "Id": 7,
            "Code": "000001",
            "Name": "محمد امینی",
            "Active": true,
            "Note": "دفتر مرکزی"
        },
        {
            "Id": 8,
            "Code": "000002",
            "Name": "سارا شریعتی",
            "Active": true,
            "Note": "بازاریاب سایر"
        },        
        {…}, 
        {…} 
    ] 
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetCurrencyTable
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456'
 }
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result آرایه ای از جدول نرخ برابری ارزها موجود می باشد. هر جدول نرخ برابری ارز شامل ساختار زیر می باشد:
From از
To به
Rate ضریب تبدیل
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
    [ 
        {
            "From": "USD",
            "To": "IRR",
            "Rate": 234500.0
        },
        {
            "From": "AED",
            "To": "IRR",
            "Rate": 68000.0
        },        
        {…}, 
        {…} 
    ] 
    }
}
Copyed
URL: https://api.hesabfa.com/v1/setting/SetCurrencyTable
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Table آرایه ای از جدول نرخ برابری ارزها. هر جدول نرخ برابری ارز شامل ساختار زیر می باشد:
From از
To به
Rate ضریب تبدیل
Copyed
{
     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 قرار می گیرد.
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: true
}
Copyed
URL: https://api.hesabfa.com/v1/setting/GetAccounts
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
}
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result آرایه ای از جدول حساب ها موجود می باشد. هر جدول حساب شامل ساختار زیر می باشد:
Name نام حساب
FullPathame مسیر حساب
DetailType نوع تفصیل(جدول نوع تفصیل)
Copyed
{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result:[
		{
			"Name": "دارایی ها",
			"FullPath": "دارایی ها",
			"DetailType": 6  
		},
		{
			"Name": "دارایی های جاری",
			"FullPath": "دارایی ها : دارایی های جاری",
			"DetailType": 6
		},
		{
			"Name": "موجودی نقد و بانک",
			"FullPath": "دارایی ها : دارایی های جاری : موجودی نقد و بانک",
			"DetailType": 6 
	   },        
		{…}, 
		{…} 
	 ] 
}