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

دریافت

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

Request
Response

پارامترها :

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

number شماره رسید انتقال

{
    "apiKey": "…",
    "loginToken": "…",
    "number": "1016"  
}

نکات ضروری

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

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

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

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

Number	شماره رسید
Description	شرح رسید
Date	تاریخ انتقال
FromAmount	مبلغ مبدا
FromReference	شماره ارجاع مبدا
FromBank	کد بانک مبدا
FromCash	کد صندوق مبدا
FromPettyCash	کد تنخواه‌گردان مبدا
FromTransactionFee	کارمزد خدمات بانکی مبدا
FromCurrencyRate	نرخ برابری ارز مبدا با ارز اصلی سیستم
ToAmount	مبلغ مقصد
ToReference	شماره ارجاع مقصد
ToBank	کد بانک مقصد
ToCash	کد صندوق مقصد
ToPettyCash	کد تنخواه‌گردان مقصد
ToTransactionFee	کارمز خدمات بانکی مقصد
ToCurrencyRate	نرخ برابری ارز مقصد با ارز اصلی سیستم

{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
                "Id": 2016,
                "Number": 1016,
                "Description": "انتقال وجه از بانک ملی به بانک دبی",
                "Date": "2024-07-17T00:00:00",
                "Project": "پروژه یک",
                "FromAmount": 581000000.0000,
                "ToAmount": 100,
                "FromReference": "58745",
                "ToReference": "AS-85/54",
                "FromBank": "0003",
                "FromCash": "",
                "FromPettyCash": "",
                "ToBank": "0007",
                "ToCash": "",
                "ToPettyCash": "",
                "FromTransactionFee": 35000,
                "ToTransactionFee": 2,
                "FromCurrencyRate": 1,
                "ToCurrencyRate": 581000
    }
}

دریافت لیست

URL: https://api.hesabfa.com/v1/bankTransfer/getTransfers

Request
Response

پارامترها:

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

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

{
    "apiKey": "…",
    "loginToken": "…",
    "queryInfo": {
        "filters": [
            {
                    "property": "FromBank",
                    "operator": "=",
                    "value": "0003"
            }
        ]
    }
}

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

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

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

Number	شماره رسید
Description	شرح رسید
Date	تاریخ انتقال
FromAmount	مبلغ مبدا
FromReference	شماره ارجاع مبدا
FromBank	کد بانک مبدا
FromCash	کد صندوق مبدا
FromPettyCash	کد تنخواه‌گردان مبدا
FromTransactionFee	کارمزد خدمات بانکی مبدا
FromCurrencyRate	نرخ برابری ارز مبدا با ارز اصلی سیستم
ToAmount	مبلغ مقصد
ToReference	شماره ارجاع مقصد
ToBank	کد بانک مقصد
ToCash	کد صندوق مقصد
ToPettyCash	کد تنخواه‌گردان مقصد
ToTransactionFee	کارمز خدمات بانکی مقصد
ToCurrencyRate	نرخ برابری ارز مقصد با ارز اصلی سیستم

{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "TotalCount": 17,
        "FilteredCount": 3,
        "From": 1,
        "To": 3,
        "List": [
            {
                "Id": 2019,
                "Description": "انتقال وجه از بانک ملی به بانک دبی",
                "Date": "2024-07-17T00:00:00",
                "Project": "پروژه یک",
                "FromAmount": 581000000.0000,
                "ToAmount": 100,
                "FromReference": "58745",
                "ToReference": "AS-85/54",
                "FromBank": "0003",
                "FromCash": "",
                "FromPettyCash": "",
                "ToBank": "0007",
                "ToCash": "",
                "ToPettyCash": "",
                "FromTransactionFee": 35000,
                "ToTransactionFee": 2,
                "FromCurrencyRate": 1,
                "ToCurrencyRate": 581000
            },
            {…},{…}        
       ]
    }
}

ذخیره

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

Request
Response

پارامترها :

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

transfer Object نگهدارنده اطلاعات انتقال بین بانکی می باشد.

number	شماره رسید
description	شرح رسید
date	تاریخ انتقال
fromAmount	مبلغ مبدا
fromReference	شماره ارجاع مبدا
fromBank	کد بانک مبدا
fromCash	کد صندوق مبدا
fromPettyCash	کد تنخواه‌گردان مبدا
fromTransactionFee	کارمزد خدمات بانکی مبدا
fromCurrencyRate	نرخ برابری ارز مبدا با ارز اصلی سیستم
toAmount	مبلغ مقصد
toReference	شماره ارجاع مقصد
toBank	کد بانک مقصد
toCash	کد صندوق مقصد
toPettyCash	کد تنخواه‌گردان مقصد
toTransactionFee	کارمز خدمات بانکی مقصد
toCurrencyRate	نرخ برابری ارز مقصد با ارز اصلی سیستم

{
    "apiKey": "…",
    "loginToken": "…",
    "transfer": {
                "number": 1016,
                "description": "انتقال وجه از بانک ملی به بانک دبی",
                "date": "2024-07-17T00:00:00",
                "project": "پروژه یک",
                "fromAmount": 581000000.0000,
                "toAmount": 100,
                "fromReference": "58745",
                "toReference": "AS-85/54",
                "fromBank": "0003",
                "fromCash": "",
                "fromPettyCash": "",
                "toBank": "0007",
                "toCash": "",
                "toPettyCash": "",
                "fromTransactionFee": 35000,
                "toTransactionFee": 2,
                "fromCurrencyRate": 1,
                "toCurrencyRate": 581000
    }
}

نکات ضروری

اگر شما رسید ذکر شود، رسید انتخاب شده ویرایش خواهد شد.
فقط یکی از آیتم‌هایی fromBank, fromCash, fromPettyCash باید مقدار داشته باشند.
فقط یکی از آیتمهای toBank, toCash, toPettyCash باید مقدار داشته باشند.
در سیستم چند ارزی، ارز مبدا یا ارز مقصد حتما باید با ارز اصلی سیستم یکی باشد. به عبارت دیگر امکان ثبت رسید انتقال بین دو ارز متفاوت از ارز اصلی سیستم، وجود ندارد.
در صورتی که ارز مبدا یا ارز مقصد متفاوت از ارز اصلی سیستم باشد، باید نرخ برابری ارز مبدا یا ارز مقصد با ارز اصلی سیستم ذکر گردد.

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

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

Result در صورت موفقیت آمیز بودن، Object انتقال بین بانکی ذخیره شده یا ویرایش شده درون Result قرار می گیرد.

Number	شماره رسید
Description	شرح رسید
Date	تاریخ انتقال
FromAmount	مبلغ مبدا
FromReference	شماره ارجاع مبدا
FromBank	کد بانک مبدا
FromCash	کد صندوق مبدا
FromPettyCash	کد تنخواه‌گردان مبدا
FromTransactionFee	کارمزد خدمات بانکی مبدا
FromCurrencyRate	نرخ برابری ارز مبدا با ارز اصلی سیستم
ToAmount	مبلغ مقصد
ToReference	شماره ارجاع مقصد
ToBank	کد بانک مقصد
ToCash	کد صندوق مقصد
ToPettyCash	کد تنخواه‌گردان مقصد
ToTransactionFee	کارمز خدمات بانکی مقصد
ToCurrencyRate	نرخ برابری ارز مقصد با ارز اصلی سیستم

{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
                "Id": 2019,
                "Description": "انتقال وجه از بانک ملی به بانک دبی",
                "Date": "2024-07-17T00:00:00",
                "Project": "پروژه یک",
                "FromAmount": 581000000.0000,
                "ToAmount": 100,
                "FromReference": "58745",
                "ToReference": "AS-85/54",
                "FromBank": "0003",
                "FromCash": "",
                "FromPettyCash": "",
                "ToBank": "0007",
                "ToCash": "",
                "ToPettyCash": "",
                "FromTransactionFee": 35000,
                "ToTransactionFee": 2,
                "FromCurrencyRate": 1,
                "ToCurrencyRate": 581000
    }
}

حذف

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

Request
Response

پارامترها :

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

number شماره رسید انتقال

{
    "apiKey": "…",
    "loginToken": "…",
    "number": "1016"   
}

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

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

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

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

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

دریافت

دریافت لیست

ذخیره

حذف