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

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

Copyed
URL: https://api.hesabfa.com/v1/discountitem/get

پارامترها :

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
contactCode کد شخص
productCode کد کالا
contactPath مسیر دسته بندی اشخاص
productPath مسیر دسته بندی کالاها یا خدمات
tag فیلد متنی قابل استفاده توسط برنامه نویس
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'f6b912...45fdc',
    contactCode: '000001',
    productCode: '',
    contactPath: '',
    tag: '' 
}
نکات ضروری

در درخواست باید فقط یکی از آیتم های کدشخص یا کد کالا یا مسیر دسته بندی اشخاص یا مسیر دسته بندی کالاها ذکر شود.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object مورد نظر درون Result قرار می گیرد.
Title عنوان تخفیف
Type وضعیت سند(جدول نوع اقلام تخفیف دار)
ContactCode کد شخص
ProductCode کد کالا یا خدمت
ContactPath مسیر دسته بندی شخص
ProductPath مسیر دسته بندی کالا
ValidFrom شروع اعتبار
ValidTo پایان اعتبار
Percent درصد تخفیف
Amount مبلغ تخفیف
OneTime یکبار مصرف
UseCount تعداد استفاده
UseDate تاریخ آخرین استفاده
Info توضیحات
Tag فیلد متنی قابل استفاده توسط برنامه نویس
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
       {
                "Id": 1,
                "Title": "تخفبف 20 درصد تا سقف 100 هزار تومان مخصوص مشتریان وفادار",          
                "Type": 6,          
                "Info": "",           
                "ContactCode": "",             
                "ProductCode": "",         
                "ValidFrom": "2024-05-22T00:00:00",             
                "ValidTo": "2025-03-20T00:00:00",             
                "Percent": 20.0000,         
                "Amount": 1000000.0000,                
                "OneTime": false,                
                "UseCount": 0,                 
                "UseDate": "0001-01-01T00:00:00",
                "Info": "",
                "Tag": ""                
        },
     ]
}
Copyed
URL: https://api.hesabfa.com/v1/discountitem/getById

پارامترها :

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
idList لیست id اقلام تخفیف دار
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'f6b912...45fdc',
    idList: [1]
}

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object مورد نظر درون Result قرار می گیرد.
Title عنوان تخفیف
Type وضعیت سند(جدول نوع اقلام تخفیف دار)
ContactCode کد شخص
ProductCode کد کالا یا خدمت
ContactPath مسیر دسته بندی شخص
ProductPath مسیر دسته بندی کالا
ValidFrom شروع اعتبار
ValidTo پایان اعتبار
Percent درصد تخفیف
Amount مبلغ تخفیف
OneTime یکبار مصرف
UseCount تعداد استفاده
UseDate تاریخ آخرین استفاده
Info توضیحات
Tag فیلد متنی قابل استفاده توسط برنامه نویس
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
       {
                "Id": 1,
                "Title": "تخفبف 20 درصد تا سقف 100 هزار تومان مخصوص مشتریان وفادار",          
                "Type": 6,          
                "Info": "",           
                "ContactCode": "",             
                "ProductCode": "",         
                "ValidFrom": "2024-05-22T00:00:00",             
                "ValidTo": "2025-03-20T00:00:00",             
                "Percent": 20.0000,         
                "Amount": 1000000.0000,                
                "OneTime": false,                
                "UseCount": 0,                 
                "UseDate": "0001-01-01T00:00:00",
                "Info": "",
                "Tag": ""                
        },
     ]
}
Copyed
URL: https://api.hesabfa.com/v1/discountitem/getItems

پارامترها :

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
پارامترهای اختیاری:
queryInfo Object فیلتر و مرتب سازی (مشاهده توضیحات)
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'f6b912...45fdc',
    queryInfo:{
        sortBy: 'Id',
        sortDesc: false,
        take: 20,
        skip: 0,
        filters:[{
            property: 'Title',
            operator: '*',
            value: 'وفادار'
            }
        ]
    }
}

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object مورد نظر درون Result قرار می گیرد.
Title عنوان تخفیف
Type وضعیت سند(جدول نوع اقلام تخفیف دار)
ContactCode کد شخص
ProductCode کد کالا یا خدمت
ContactPath مسیر دسته بندی شخص
ProductPath مسیر دسته بندی کالا
ValidFrom شروع اعتبار
ValidTo پایان اعتبار
Percent درصد تخفیف
Amount مبلغ تخفیف
OneTime یکبار مصرف
UseCount تعداد استفاده
UseDate تاریخ آخرین استفاده
Info توضیحات
Tag فیلد متنی قابل استفاده توسط برنامه نویس
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
       {
                "Id": 1,
                "Title": "تخفبف 20 درصد تا سقف 100 هزار تومان مخصوص مشتریان وفادار",          
                "Type": 6,          
                "Info": "",           
                "ContactCode": "",             
                "ProductCode": "",         
                "ValidFrom": "2024-05-22T00:00:00",             
                "ValidTo": "2025-03-20T00:00:00",             
                "Percent": 20.0000,         
                "Amount": 1000000.0000,                
                "OneTime": false,                
                "UseCount": 0,                 
                "UseDate": "0001-01-01T00:00:00",
                "Info": "",
                "Tag": ""                
        },
     ]
}
Copyed
URL: https://api.hesabfa.com/v1/discountitem/save

پارامترها :

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
item Object نگهدارنده اطلاعات اقلام تخفیف دار می باشد.هر Object شامل ساختار زیر می باشد:
id
title عنوان تخفیف
type وضعیت سند(جدول نوع اقلام تخفیف دار)
percent درصد تخفیف
amount مبلغ تخفیف
validFrom شروع اعتبار
validTo پایان اعتبار
tag فیلد متنی قابل استفاده توسط برنامه نویس
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'mail@example.com',
     "item":{
                "id": 2,
                "title": "تخفیف عمومی همه کالاها",
                "type": 1,
                "percent": 5,
                "amount": 20000,
                "validFrom": "2025-01-01",
                "validTo": "2025-10-01",
                "tag": ""
            }
}
نکات ضروری
  1. در صورتی که فیلد id ذکر شود، آیتم ویرایش خواهد شد. در غیر اینصورت آیتم جدید ثبت خواهد شد.
  2. با توجه به فیلد type فقط یکی از فیلدهای contactCode، productCode، contactPath و productPath باید مقدار داشته باشند.
  3. در صورتی که همزمان درصد تخفیف و مبلغ تخفیف ذکر شود، مبلغ تخفیف به عنوان سقف در نظر گرفته می شود. مثلا اگر درصد 20 و مبلغ 100,000 باشد، یعنی 20 درصد تخفیف تا سقف 100,000 (واحد پول کسب و کار).
  4. مقدار فیلدهای useCount و useDate و info توسط نرم افزار و با استفاده شدن تخفیف مشخص می شود و توسط API یا کاربر قابل تنظیم و تغییر نیست.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object اقلام تخفیف دار ذخیره شده یا ویرایش شده درون Result قرار می گیرد.
Title عنوان تخفیف
Type وضعیت سند(جدول نوع اقلام تخفیف دار)
ContactCode کد شخص
ProductCode کد کالا یا خدمت
ContactPath مسیر دسته بندی شخص
ProductPath مسیر دسته بندی کالا
ValidFrom شروع اعتبار
ValidTo پایان اعتبار
Percent درصد تخفیف
Amount مبلغ تخفیف
OneTime یکبار مصرف
UseCount تعداد استفاده
UseDate تاریخ آخرین استفاده
Info توضیحات
Tag فیلد متنی قابل استفاده توسط برنامه نویس
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: [
       {
                "Id": 1,
                "Title": "تخفبف 20 درصد تا سقف 100 هزار تومان مخصوص مشتریان وفادار",          
                "Type": 6,          
                "Info": "",           
                "ContactCode": "",             
                "ProductCode": "",         
                "ValidFrom": "2024-05-22T00:00:00",             
                "ValidTo": "2025-03-20T00:00:00",             
                "Percent": 20.0000,         
                "Amount": 1000000.0000,                
                "OneTime": false,                
                "UseCount": 0,                 
                "UseDate": "0001-01-01T00:00:00",
                "Info": "",
                "Tag": ""                
        },
     ]
}
Copyed
URL: https://api.hesabfa.com/v1/discountitem/batchsave

پارامترها :

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
item Object نگهدارنده اطلاعات اقلام تخفیف دار می باشد.هر Object شامل ساختار زیر می باشد:
id
title عنوان تخفیف
type وضعیت سند(جدول نوع اقلام تخفیف دار)
percent درصد تخفیف
amount مبلغ تخفیف
validFrom شروع اعتبار
validTo پایان اعتبار
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'f6b912...45fdc',
     "items": [{
                    "id": 1,
                    "title": "تخفیف عمومی همه کالاها",
                    "type": 1,
                    "percent": 5,
                    "amount": 20000,
                    "validFrom": "2025-01-01",
                    "validTo": "2025-10-01",
                    "tag": "-"
                },
               {
                    "id": 2,
                    "title": "تخفیف مشتریان وفادار",
                    "type": 6,
                    "percent": 20,
                    "amount": 100000,
                    "contactPath": "اشخاص : مشتریان وفادار",
                    "validFrom": "2025-01-01",
                    "validTo": "2025-10-01",
                    "tag": "-"
               }
     ]
}
نکات ضروری
  1. در صورتی که فیلد id ذکر شود، آیتم ویرایش خواهد شد. در غیر اینصورت آیتم جدید ثبت خواهد شد.
  2. با توجه به فیلد type فقط یکی از فیلدهای contactCode، productCode، contactPath و productPath باید مقدار داشته باشند.
  3. در صورتی که همزمان درصد تخفیف و مبلغ تخفیف ذکر شود، مبلغ تخفیف به عنوان سقف در نظر گرفته می شود. مثلا اگر درصد 20 و مبلغ 100,000 باشد، یعنی 20 درصد تخفیف تا سقف 100,000 (واحد پول کسب و کار).
  4. مقدار فیلدهای useCount و useDate و info توسط نرم افزار و با استفاده شدن تخفیف مشخص می شود و توسط API یا کاربر قابل تنظیم و تغییر نیست.

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن، Object ذخیره شده یا ویرایش شده درون Result قرار می گیرد.
Title عنوان تخفیف
Type وضعیت سند(جدول نوع اقلام تخفیف دار)
ContactCode کد شخص
ProductCode کد کالا یا خدمت
ContactPath مسیر دسته بندی شخص
ProductPath مسیر دسته بندی کالا
ValidFrom شروع اعتبار
ValidTo پایان اعتبار
Percent درصد تخفیف
Amount مبلغ تخفیف
OneTime یکبار مصرف
UseCount تعداد استفاده
UseDate تاریخ آخرین استفاده
Info توضیحات
Tag فیلد متنی قابل استفاده توسط برنامه نویس
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    "Result": [
        {
            "Id": 1,
            "Title": "تخفیف عمومی همه کالاها",
            "Type": 1,
            "ContactCode": "",
            "ProductCode": "",
            "ContactPath": "",
            "ProductPath": "",
            "ValidFrom": "2025-01-01T00:00:00",
            "ValidTo": "2025-10-01T00:00:00",
            "Percent": 5.0,
            "Amount": 20000.0,
            "OneTime": false,
            "UseCount": 0,
            "UseDate": "0001-01-01T00:00:00",
            "Info": "",
            "Tag": "+"
        },
        {
            "Id": 2,
            "Title": "تخفیف مشتریان وفادار",
            "Type": 6,
            "ContactCode": "",
            "ProductCode": "",
            "ContactPath": " اشخاص : مشتریان وفادار ",
            "ProductPath": "",
            "ValidFrom": "2025-01-01T00:00:00",
            "ValidTo": "2025-10-01T00:00:00",
            "Percent": 20.0,
            "Amount": 100000.0,
            "OneTime": false,
            "UseCount": 0,
            "UseDate": "0001-01-01T00:00:00",
            "Info": "",
            "Tag": "-"
        }
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/discountitem/delete

پارامترها :

apiKey
userId
password
loginToken 		پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
idList لیست id اقلام تخفیف دار
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'f6b912...45fdc',
    "idList": [1, 2]
}

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

Success
ErrorCode
ErrorMessage
 (مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد.
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: true
}