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

تنظیمات

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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
start Id شروع دریافت تغییرات
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456',
     loginToken: 'f6b912...45fdc',
     start: 1337
 }
خروجی
نمونه خروجی
{
     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
    }
    ]
}

توضیح پارامترهای خروجی:

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

شرح کد
ذخیره شخص 31
ویرایش شخص 32
حذف شخص 33
ذخیره کالا 51
ویرایش کالا 52
حذف کالا 53
ذخیره فاکتور فروش 121
ویرایش فاکتور فروش 122
حذف فاکتور فروش 123
ذخیره فاکتور خرید 131
ویرایش فاکتور خرید 132
حذف فاکتور خرید 133
ذخیره فاکتور برگشت از فروش 141
ویرایش فاکتور برگشت از فروش 142
حذف فاکتور برگشت از فروش 143
ذخیره فاکتور برگشت از خرید 151
ویرایش فاکتور برگشت از خرید 152
حذف فاکتور برگشت از خرید 153
ذخیره فاکتور ضایعات 161
ویرایش فاکتور ضایعات 162
حذف فاکتور ضایعات 163
دریافت لیست کالا از اکسل 101
دریافت لیست اشخاص از اکسل 102
URL: https://api.hesabfa.com/v1/setting/GetBanks

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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/GetCurrency

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
     "Result": {
        "Currency": "IRR"
    }
}
URL: https://api.hesabfa.com/v1/setting/GetWarehouses

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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

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

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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: '[email protected]',
     password: '123456'
 }
خروجی
نمونه خروجی
{
    "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

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

ورودی
پارامترهای اجباری:
apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
مثال:
{
     "apiKey": "asdfASR^%FDHdsfg456",
     "userId": "[email protected]",
     "password": "123456",
     "Table": [
     {
        "From": "USD",
        "To": "IRR",
        "Rate": 234500
     },
     {
        "From": "AED",
        "To": "IRR",
        "Rate": 68000
     }]
 }
خروجی
نمونه خروجی
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": true
}