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

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

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

ورودی

پارامترهای اجباری:

apiKey userId password loginToken	پارامتر های اجباری برای تمامی متد ها (مشاهده توضیحات)
type	نوع رسید ( جدول نوع رسید )
number	شماره رسید مورد نظر

مثال:

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
    loginToken: 'f6b912...45fdc',
	type: 1,
	number: 1001
}

خروجی

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

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

Number	شماره رسید
DateTime	تاریخ رسید
Description	شرح
Amount	مبلغ رسید
Currency	واحد پول رسید
Project	پروژه
Items	آرایه ای از طرف های دریافت یا پرداخت کننده. ساختار در مثال نشان داده شده است.
Transactions	آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.

مثال:

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

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

دریافت لیست رسیدهای دریافت یا پرداخت

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

URL: https://api.hesabfa.com/v1/receipt/getReceipts

ورودی

پارامترهای اجباری:

apiKey userId password loginToken	پارامتر های اجباری برای تمامی متد ها (مشاهده توضیحات)
type	نوع رسید ( جدول نوع رسید )

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

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

مثال:

{
	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 آرایه ای از رسیدها قرار میگیرد.

مثال:

{
    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": [
                    {
                        "Bank": null,
                        "Cash": {
                            "Id": 1007,
                            "Code": "0004",
                            "Name": "دلاری"
                        },
                        "PettyCash": null,
                        "Contact": null,
                        "Check": null,
                        "Amount": 0.5500
                    }
                ]
            }, 
            {…},
            {…}
    ]}
}

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

ذخیره رسید

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

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	کد تنخواه گردان

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

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

خروجی

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

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

مثال:

{
    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 خواهند بود.

حذف رسید

حذف یک رسید دریافت یا پرداخت.

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

ورودی

پارامترهای اجباری:

apiKey userId password loginToken	پارامتر های اجباری برای تمامی متد ها (مشاهده توضیحات)
type	نوع رسید ( جدول نوع رسید )
number	شماره رسید

مثال:

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
    loginToken: 'f6b912...45fdc',
	type: 1,
	number: 1001
}

خروجی

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

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

مثال:

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