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

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

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

Object رسید یا دریافت مورد نظر

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

Contact

شخص(مشخصات شخص به صورت زیر خواهد بود)

Code	کد شخص
Name	نام شخص

Account	مسیر حساب
Amount	مبلغ
Description	توضیحات

Transactions

آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.

Cash	نقدی
Bank	بانکی(مشخصات بانک به صورت زیر خواهد بود)

Code	کد بانک
Name	نام بانک

PettyCash	تنخواه گردان
Contact	اعتباری از شخص
Check	بصورت چکی
Account	مسیر حساب
Type	نوع تراکنش ( جدول نوع تراکنش رسید )
Reference	ارجاع
TransactionFee	کارمزد خدمات بانکی
Amount	مبلغ

{
    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,
                "Account": null,
                "Description": "دریافت وجه/چک از محسن کریمی"
            },
            {...},
            {...}
        ],
        "Transactions": [
            {
                "Cash": null,
                "Bank": {
                    "Id": 1004,
                    "Code": "0001",
                    "Name": "بانک ملت"
                },
                "PettyCash": null,
                "Contact": null,
                "Check": null,
                "Account": null,
                "Type": "3",
                "Reference": null,
                "TransactionFee": 300.0000,
                "Amount": 25000000.0000
                },
            {...},
            {...}
        ]
    }
} 

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

apiKey userId password loginToken

پارامتر های اجباری برای تمامی متد ها (مشاهده توضیحات)

type	نوع رسید ( جدول نوع رسید )

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

queryInfo

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

{
    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	نام شخص

Account	مسیر حساب
Amount	مبلغ
Description	توضیحات

Transactions

آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.

Cash	نقدی
Bank	بانکی(مشخصات بانک به صورت زیر خواهد بود)

Code	کد بانک
Name	نام بانک

PettyCash	تنخواه گردان
Contact	اعتباری از شخص
Check	بصورت چکی
Type	نوع تراکنش رسید ( جدول نوع تراکنش رسید )
Account	مسیر حساب
Check	بصورت چکی
Reference	رجاع
TransactionFee	کارمزد خدمات بانکی

{
    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,
                        "Account": null,
                        "Description": "دریافت وجه فاکتور - فاکتور فروش # 1079 - محسن کریمی"
                    }
                ],
                "Transactions": [
                    {
                        "Cash": null,
                        "Bank": {
                        "Id": 1004,
                        "Code": "0001",
                        "Name": "بانک ملت"
                },
                        "PettyCash": null,
                        "Contact": null,
                        "Check": null,
                        "Account": null,
                        "Type": "3",
                        "Reference": null,
                        "TransactionFee": 300.0000,
                        "Amount": 0.5500
                    }
                ]
            }, 
            {…},
            {…}
    ]}
} 

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

apiKey userId password loginToken

پارامتر های اجباری برای تمامی متد ها (مشاهده توضیحات)

*Type	نوع رسید ( جدول نوع رسید )
number	شماره رسید. در صورت وجود، رسید ویرایش می شود. در صورتی که ارسال نشود، رسید جدید ذخیره خواهد شد.
dateTime	تاریخ. در صورت عدم ارسال، رسید به تاریخ روز ذخیره می شود.
Project	نام پروژه
Description	شرح رسید.
*BankCode	کد بانک
CashCode	کد صندوق
PettyCashCode	کد تنخواه گردان
contactCode	کد شخص
accountPath	مسیر حساب
*ContactCode	کد شخص
*Amount	مبلغ به ارز پایه سیستم
BankFee	کارمزد خدمات بانکی
Reference	شماره ارجاع
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

Object رسید مورد نظر

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

Contact

شخص(مشخصات شخص به صورت زیر خواهد بود)

Code	کد شخص
Name	نام شخص

Amount	مبلغ
Account	مسیر حساب
Description	توضیحات

Transactions

آرایه ای از تراکنش های دریافتی یا پرداختی. ساختار در مثال نشان داده شده است.

Cash	نقدی
Bank	بانکی(مشخصات بانک به صورت زیر خواهد بود)

Code	کد بانک
Name	نام بانک

PettyCash	تنخواه گردان
Contact	اعتباری از شخص
Check	بصورت چکی
Account	مسیر حساب
Type	نوع تراکنش ( جدول نوع تراکنش رسید )
Reference	ارجاع
TransactionFee	کارمزد خدمات بانکی
Amount	مبلغ

{
    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,
                "Account": null,
                "Description": "دریافت وجه/چک از محسن کریمی"
            }
        ],
        "Transactions": [
            {
                "Cash": null,
                "Bank": {
                    "Id": 1004,
                    "Code": "0001",
                    "Name": "بانک ملت"
                },
                "PettyCash": null,
                "Contact": null,
                "Check": null,
                "Account": null,
                "Type": "3",
                "Reference": null,
                "TransactionFee":300.0000,
                "Amount": 25000000.0000
            }
        ]
    }
}
 

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

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

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

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