متدهای اقلام تخفیف دار در Api نرم‌افزار حسابداری آنلاین حسابفا

دریافت

URL: https://api.hesabfa.com/v1/disCountItem/get

Request
Response

پارامترها :

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

contactCode	کد شخص
productCode	کد کالا
contactPath	مسیر دسته‌بندی اشخاص
productPath	مسیر دسته‌بندی کالاها یا خدمات
tag	فیلد متنی قابل استفاده توسط برنامه‌نویس

{
    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	فیلد متنی قابل استفاده توسط برنامه‌نویس

{
    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": ""                
        },
     ]
}

دریافت از طریق Id

URL: https://api.hesabfa.com/v1/disCountItem/getById

Request
Response

پارامترها :

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

idList لیست id اقلام تخفیف دار

{
    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	فیلد متنی قابل استفاده توسط برنامه‌نویس

{
    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": ""                
        },
     ]
}

دریافت لیست

URL: https://api.hesabfa.com/v1/disCountItem/getItems

Request
Response

پارامترها :

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

پارامترهای اختیاری:

queryInfo Object فیلتر و مرتب‌سازی (مشاهدۀ توضیحات)

{
    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	فیلد متنی قابل استفاده توسط برنامه‌نویس

{
    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": ""                
        },
     ]
}

ذخیره

URL: https://api.hesabfa.com/v1/disCountItem/save

Request
Response

پارامترها :

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

item	Object نگهدارنده اطلاعات اقلام تخفیف دار می باشد.هر Object شامل ساختار زیر می باشد:

id
title	عنوان تخفیف
type	وضعیت سند(جدول نوع اقلام تخفیف دار)
percent	درصد تخفیف
amount	مبلغ تخفیف
validFrom	شروع اعتبار
validTo	پایان اعتبار
tag	فیلد متنی قابل استفاده توسط برنامه‌نویس

{
    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": ""
            }
}

نکات ضروری

در صورتی که فیلد id ذکر شود، آیتم ویرایش خواهد شد. در غیر اینصورت آیتم جدید ثبت خواهد شد.
با توجه به فیلد type فقط یکی از فیلدهای contactCode، productCode، contactPath و productPath باید مقدار داشته باشند.
در صورتی که همزمان درصد تخفیف و مبلغ تخفیف ذکر شود، مبلغ تخفیف به عنوان سقف در نظر گرفته می‌شود. مثلا اگر درصد 20 و مبلغ 100,000 باشد، یعنی 20 درصد تخفیف تا سقف 100,000 (واحد پول کسب و کار).
مقدار فیلدهای 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	فیلد متنی قابل استفاده توسط برنامه‌نویس

{
    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": ""                
        },
     ]
}

ذخیره گروهی

URL: https://api.hesabfa.com/v1/disCountItem/batchSave

Request
Response

پارامترها :

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

item	Object نگهدارنده اطلاعات اقلام تخفیف دار می باشد.هر Object شامل ساختار زیر می باشد:

id
title	عنوان تخفیف
type	وضعیت سند(جدول نوع اقلام تخفیف دار)
percent	درصد تخفیف
amount	مبلغ تخفیف
validFrom	شروع اعتبار
validTo	پایان اعتبار

{
    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": "-"
               }
     ]
}

نکات ضروری

در صورتی که فیلد id ذکر شود، آیتم ویرایش خواهد شد. در غیر اینصورت آیتم جدید ثبت خواهد شد.
با توجه به فیلد type فقط یکی از فیلدهای contactCode، productCode، contactPath و productPath باید مقدار داشته باشند.
در صورتی که همزمان درصد تخفیف و مبلغ تخفیف ذکر شود، مبلغ تخفیف به عنوان سقف در نظر گرفته می‌شود. مثلا اگر درصد 20 و مبلغ 100,000 باشد، یعنی 20 درصد تخفیف تا سقف 100,000 (واحد پول کسب و کار).
مقدار فیلدهای 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	فیلد متنی قابل استفاده توسط برنامه‌نویس

{
    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": "-"
        }
    ]
}

حذف

URL: https://api.hesabfa.com/v1/disCountItem/delete

Request
Response

پارامترها :

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

idList لیست id اقلام تخفیف دار

{
    apiKey: 'asdfASR^%FDHdsfg456',
    loginToken: 'f6b912...45fdc',
    "idList": [1, 2]
}

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

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

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

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

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

دریافت

دریافت از طریق Id

دریافت لیست

پارامترهای اختیاری:

ذخیره

ذخیره گروهی

حذف