2023-01-01 00:00:00 persion مستندات راهنمای حسابفا واسط API متدهای دریافت و پرداخت https://www.hesabfa.com/help/api/ReceivePay/ متدهای دریافت و پرداخت-حسابفا

دریافت و پرداخت


Copyed
URL: https://api.hesabfa.com/v1/receipt/get
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
type نوع رسید ( جدول نوع رسید )
number شماره رسید مورد نظر
Copyed
{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    type: 1,
    number: 1001
} 
توجه:

بوسیله این متد رسید دریافت یا پرداخت به اشخاص، بازگردانده می شود.

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result Object رسید یا دریافت مورد نظر
Number شماره رسید
DateTime تاریخ رسید
Description شرح
Amount مبلغ رسید
Currency واحد پول رسید
Project پروژه
Items آرایه ای از طرف های دریافت یا پرداخت کننده. ساختار در مثال نشان داده شده است.
Contact شخص(مشخصات شخص به صورت زیر خواهد بود)
Code کد شخص
Name نام شخص
Amount مبلغ
Description توضیحات
Transactions آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.
Cash نقدی
Bank بانکی(مشخصات بانک به صورت زیر خواهد بود)
Code کد بانک
Name نام بانک
PettyCash تنخواه گردان
Contact اعتباری از شخص
Check بصورت چکی
Amount مبلغ
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: '',
    Result: {
        "Id": 100,
        "Number": 1009,
        "DateTime": "2020-11-07T00:00:00",
        "Description": "دریافت وجه/چک از محسن کریمی",
        "Amount": 2500000.0000,
        "Currency": "IRR",
        "Project": "",
        "Items": [
            {
                "Contact": {
                    "Id": 3055,
                    "Code": "000009",
                    "Name": " محسن کریمی"
                },
                "Amount": 2500000.0000,
                "Description": "دریافت وجه/چک از محسن کریمی"
            },
            {...},
            {...}
        ],
        "Transactions": [
            {
                "Cash": null,
                "Bank": {
                    "Id": 1004,
                    "Code": "0001",
                    "Name": "بانک ملت"
                },
                "PettyCash": null,
                "Contact": null,
                "Check": null,
                "Amount": 25000000.0000
                },
            {...},
            {...}
        ]
    }
} 
توضیحات آرایه Transactions:

تراکنش در حسابفا می تواند بصورت نقدی (cash) ، بانکی (bank)، تنخواه گردان (PettyCash)، اعتباری از شخص (Contact) و یا بصورت چکی (Check) باشد که در هر حالت آبجکت مربوطه شامل دیتا خواهد بود و سایر آبجکت ها null خواهند بود.

Copyed
URL: https://api.hesabfa.com/v1/receipt/getReceipts
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
type نوع رسید ( جدول نوع رسید )
پارامترهای اختیاری:
queryInfo Object فیلتر و مرتب سازی (مشاهده توضیحات)
Copyed
{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    type: 1,
    queryInfo:{
		SortBy: 'DateTime',
		SortDesc: true,
		Take: 20,
		Skip: 0
	}
} 
توجه:

بوسیله این متد لیست رسیدهای دریافت یا پرداخت به اشخاص، بازگردانده می شود.

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result درون فیلد result آرایه ای از رسیدها قرار میگیرد.
TotalCount تعداد کل
FilteredCount تعداد فیلتر شده
From شماره ردیف شروع
To شماره ردیف خاتمه
List لیستی از Object های نگهدارنده اطلاعات رسیدها می باشد.هر Object شامل ساختار زیر می باشد:
Number شماره رسید
DateTime تاریخ رسید
Description توضیحات
Amount مبلغ رسید
Currency واحد پول رسید
Project پروژه
Items آرایه ای از طرف های دریافت یا پرداخت کننده. ساختار در مثال نشان داده شده است.
Contact شخص(مشخصات شخص به صورت زیر خواهد بود)
Code کد شخص
Name نام شخص
Amount مبلغ
Description توضیحات
Transactions آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.
Cash نقدی
Bank بانکی(مشخصات بانک به صورت زیر خواهد بود)
Code کد بانک
Name نام بانک
PettyCash تنخواه گردان
Contact اعتباری از شخص
Check بصورت چکی
Amount مبلغ
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: '',
    Result: {
        "TotalCount": 9,
        "FilteredCount": 9,
        "From": 1,
        "To": 9,
        "List": [
            {
                "Id": 4101,
                "Number": 1008,
                "DateTime": "2020-11-07T00:00:00",
                "Description": "دریافت وجه فاکتور - فاکتور فروش # 1079 – محسن کریمی",
                "Amount": 0.5500,
                "Currency": "USD",
                "Project": "",
                "Items": [
                    {
                        "Contact": {
                            "Id": 3049,
                            "Code": "000003",
                            "Name": " محسن کریمی"
                        },
                        "Amount": 0.5500,
                        "Description": "دریافت وجه فاکتور - فاکتور فروش # 1079 - محسن کریمی"
                    }
                ],
                "Transactions": [
                    {
                        "Cash": null,
                        "Bank": {
                        "Id": 1004,
                        "Code": "0001",
                        "Name": "بانک ملت"
                },
                        "PettyCash": null,
                        "Contact": null,
                        "Check": null,
                        "Amount": 0.5500
                    }
                ]
            }, 
            {…},
            {…}
    ]}
} 
توضیحات آرایه Transactions:

تراکنش در حسابفا می تواند بصورت نقدی (cash) ، بانکی (bank)، تنخواه گردان (PettyCash)، اعتباری از شخص (Contact) و یا بصورت چکی (Check) باشد که در هر حالت آبجکت مربوطه شامل دیتا خواهد بود و سایر آبجکت ها null خواهند بود.

Copyed
URL: https://api.hesabfa.com/v1/receipt/save
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
* آیتم های ستاره دار ضروری هستند.
*Type نوع رسید ( جدول نوع رسید )
Number شماره رسید. در صورت وجود، رسید ویرایش می شود. در صورتی که ارسال نشود، رسید جدید ذخیره خواهد شد.
DateTime تاریخ. در صورت عدم ارسال، رسید به تاریخ روز ذخیره می شود.
Project نام پروژه
Description شرح رسید.
*BankCode کد بانک
*ContactCode کد شخص
*Amount مبلغ به ارز پایه سیستم
BankFee کارمزد خدمات بانکی
Reference شماره ارجاع
Currency واحد پول
CurrencyRate نرخ برابری ارز به ارز پایه
CashCode کد صندوق
PettyCashCode کد تنخواه گردان
Copyed
{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    type: 1,
    description: 'دریافت وجه/چک از محسن کریمی',
    amount: 2500000.0000,
    contactCode: 9,
    bankCode: 1,
    cashCode: null,
    pettyCashCode: null,
    currency: 'IRR',
    currencyRate: 1
}
 
توجه:

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

توجه:

فقط یکی از سه فیلد BankCode، CashCode و PettyCashCode باید مقدار داشته باشد. در صورت ذکر نشدن Currency و CurrencyRate از واحد پول بانک، صندوق یا تنخواه گردان و نرخ برابری ارز پیش فرض سیستم استفاده خواهد شد.

آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result Object رسید مورد نظر
Number شماره رسید
DateTime تاریخ رسید
Description توضیحات
Amount مبلغ رسید
Currency واحد پول رسید
Project پروژه
Items آرایه ای از طرف های دریافت یا پرداخت کننده. ساختار در مثال نشان داده شده است.
Contact شخص(مشخصات شخص به صورت زیر خواهد بود)
Code کد شخص
Name نام شخص
Amount مبلغ
Description توضیحات
Transactions آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.
Cash نقدی
Bank بانکی(مشخصات بانک به صورت زیر خواهد بود)
Code کد بانک
Name نام بانک
PettyCash تنخواه گردان
Contact اعتباری از شخص
Check بصورت چکی
Amount مبلغ
Copyed
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: '',
    Result: {
        "Id": 100,
        "Number": 1009,
        "DateTime": "2020-11-07T00:00:00",
        "Description": "دریافت وجه/چک از محسن کریمی",
        "Amount": 2500000.0000,
        "Currency": "IRR",
        "Project": "",
        "Items": [
            {
                "Contact": {
                    "Id": 3055,
                    "Code": "000009",
                    "Name": " محسن کریمی"
                },
                "Amount": 2500000.0000,
                "Description": "دریافت وجه/چک از محسن کریمی"
            }
        ],
        "Transactions": [
            {
                "Cash": null,
                "Bank": {
                    "Id": 1004,
                    "Code": "0001",
                    "Name": "بانک ملت"
                },
                "PettyCash": null,
                "Contact": null,
                "Check": null,
                "Amount": 25000000.0000
            }
        ]
    }
}
 
توضیحات آرایه Transactions:

تراکنش در حسابفا می تواند بصورت نقدی (cash) ، بانکی (bank)، تنخواه گردان (PettyCash)، اعتباری از شخص (Contact) و یا بصورت چکی (Check) باشد که در هر حالت آبجکت مربوطه شامل دیتا خواهد بود و سایر آبجکت ها null خواهند بود.

Copyed
URL: https://api.hesabfa.com/v1/receipt/delete
پارامترهای اجباری:
apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
type نوع رسید ( جدول نوع رسید )
number شماره رسید
Copyed
{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    type: 1,
    number: 1001
} 
آیتم های موجود در پاسخ:
Success
ErrorCode
ErrorMessage
(مشاهده توضیحات)
Result در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد.
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": true
}