متدهای دریافت و پرداخت در واسط برنامهنویسی حسابفا
پارامترها:
|
apiKey userId password loginToken |
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات) |
| type | نوع رسید ( جدول نوع رسید ) |
| number | شماره رسید مورد نظر |
curl -X POST https://api.hesabfa.com/v1/receipt/get \
-H "Content-Type: application/json" \
-d '{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"number": 1001
}'
<?php
$data = [
'apiKey' => 'your-api-key',
'loginToken' => 'your-login-token',
'type' => 1,
'number' => 1001
];
$ch = curl_init("https://api.hesabfa.com/v1/receipt/get");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
const data = {
apiKey: "your-api-key",
loginToken: "your-login-token",
type: 1,
number: 1001
};
fetch("https://api.hesabfa.com/v1/receipt/get", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
console.log(result);
});
import requests
data = {
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"number": 1001
}
response = requests.post(
"https://api.hesabfa.com/v1/receipt/get",
json=data
)
result = response.json()
print(result)
using System.Net.Http.Json;
using var client = new HttpClient();
var data = new
{
apiKey = "your-api-key",
loginToken = "your-login-token",
type = 1,
number = 1001
};
var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/receipt/get", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
با این متد، رسید دریافت یا پرداخت اشخاص برگردانده میشود.
آیتمهای موجود در پاسخ:
|
Success ErrorCode ErrorMessage |
(مشاهدۀ توضیحات) |
| Result | Object اطلاعات رسید دریافت یا پرداخت، با ساختار زیر: |
| Id | شناسه رسید (برای سرویس دریافت با ID) |
| Number | شماره رسید |
| DateTime | تاریخ رسید |
| Description | شرح |
| Amount | مبلغ رسید |
| Currency | واحد پول رسید |
| CurrencyRate | نرخ تبدیل ارز |
| Project | پروژه |
| Items | آرایهای از طرفهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Contact | شخص(مشخصات شخص به صورت زیر خواهد بود) |
| Id | شناسه شخص |
| Code | کد شخص |
| Name | نام شخص |
| Account | مسیر حساب |
| Amount | مبلغ |
| Description | توضیحات |
| Transactions | آرایهای از تراکنشهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Bank | مشخصات بانک |
| Cash | مشخصات صندوق |
| PettyCash | مشخصات تنخواهگردان |
| Contact | مشخصات شخص |
| Check | مشخصات چک |
| Account | مسیر حساب |
| Type | نوع تراکنش ( جدول نوع تراکنش رسید ) |
| Reference | ارجاع |
| TransactionFee | کارمزد خدمات بانکی |
| Amount | مبلغ |
| Invoice | Object اطلاعات فاکتور، با ساختار زیر: |
| Id | شناسه فاکتور |
| Number | شماره فاکتور |
| DateTime | تاریخ فاکتور |
| InvoiceType | نوع فاکتور ( جدول نوع فاکتور) |
{
"Success": true,
"ErrorCode": 0,
"ErrorMessage": "",
"Result": {
"Id": 100,
"Number": 1009,
"DateTime": "2020-11-07T00:00:00",
"Description": "دریافت وجه/چک از محسن کریمی",
"Amount": 2500000,
"Currency": "IRR",
"CurrencyRate": 1.0,
"Project": "",
"Items": [
{
"Contact": {
"Id": 3055,
"Code": "000009",
"Name": " محسن کریمی"
},
"Account": "دارایی ها : دارایی های جاری : حساب های دریافتنی : حساب های دریافتنی",
"Amount": 2500000,
"Description": "دریافت وجه/چک از محسن کریمی"
}
],
"Transactions": [
{
"Bank": {
"Id": 1004,
"Code": "0001",
"Name": "بانک ملت"
},
"Cash": null,
"PettyCash": null,
"Contact": null,
"Check": null,
"Account": null,
"Type": 3,
"Reference": null,
"TransactionFee": 300,
"Amount": 2500000
}
],
"Invoice": {
"Id": 1,
"Number": "1002",
"DateTime": "2016-06-13T00:00:00",
"InvoiceType": 0
}
}
}
تراکنش در حسابفا میتواند واریز به / برداشت از صندوق (cash)، واریز به / برداشت از بانک (bank)، واریز به / برداشت از تنخواهگردان (PettyCash)، اعتباری از شخص (Contact) یا چکی (Check) باشد. در هر حالت فقط Object مربوط به همان نوع مقدار دارد و بقیه null هستند.
پارامترها :
|
apiKey userId password loginToken |
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات) |
| type | نوع رسید ( جدول نوع رسید ) |
| id | id رسید |
| idList | آرایهای از id رسیدها |
{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"id": 123,
"idList": [
123,
124
]
}
curl -X POST https://api.hesabfa.com/v1/receipt/GetById \
-H "Content-Type: application/json" \
-d '{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"id": 123,
"idList": [
123,
124
]
}'
<?php
$data = [
'apiKey' => 'your-api-key',
'loginToken' => 'your-login-token',
'type' => 1,
'id' => 123,
'idList' => [
123,
124
]
];
$ch = curl_init("https://api.hesabfa.com/v1/receipt/GetById");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
const data = {
apiKey: "your-api-key",
loginToken: "your-login-token",
type: 1,
id: 123,
idList: [
123,
124
]
};
fetch("https://api.hesabfa.com/v1/receipt/GetById", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
console.log(result);
});
import requests
data = {
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"id": 123,
"idList": [
123,
124
]
}
response = requests.post(
"https://api.hesabfa.com/v1/receipt/GetById",
json=data
)
result = response.json()
print(result)
using System.Net.Http.Json;
using var client = new HttpClient();
var data = new
{
apiKey = "your-api-key",
loginToken = "your-login-token",
type = 1,
id = 123,
idList = new object[]
{
123,
124
}
};
var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/receipt/GetById", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
- یکی از پارامترهای id یا idList باید ارسال شود.
با این متد، رسید دریافت یا پرداخت اشخاص برگردانده میشود.
آیتمهای موجود در پاسخ:
|
Success ErrorCode ErrorMessage |
(مشاهدۀ توضیحات) |
| Result | آرایهای از رسیدهای دریافت یا پرداخت. هر رسید ساختار زیر را دارد: |
| Id | شناسه رسید (برای سرویس دریافت با ID) |
| Number | شماره رسید |
| DateTime | تاریخ رسید |
| Description | شرح |
| Amount | مبلغ رسید |
| Currency | واحد پول رسید |
| CurrencyRate | نرخ تبدیل ارز |
| Project | پروژه |
| Items | آرایهای از طرفهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Contact | شخص (مشخصات شخص به صورت زیر خواهد بود) |
| Id | شناسه شخص |
| Code | کد شخص |
| Name | نام شخص |
| Account | مسیر حساب |
| Amount | مبلغ |
| Description | توضیحات |
| Transactions | آرایهای از تراکنشهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Bank | مشخصات بانک |
| Cash | مشخصات صندوق |
| PettyCash | مشخصات تنخواهگردان |
| Contact | مشخصات شخص |
| Check | مشخصات چک |
| Account | مسیر حساب |
| Type | نوع تراکنش ( جدول نوع تراکنش رسید ) |
| Reference | ارجاع |
| TransactionFee | کارمزد خدمات بانکی |
| Amount | مبلغ |
| Invoice | Object اطلاعات فاکتور، با ساختار زیر: |
| Id | شناسه فاکتور |
| Number | شماره فاکتور |
| DateTime | تاریخ فاکتور |
| InvoiceType | نوع فاکتور ( جدول نوع فاکتور) |
{
"Success": true,
"ErrorCode": 0,
"ErrorMessage": "",
"Result": [
{
"Id": 100,
"Number": 1009,
"DateTime": "2020-11-07T00:00:00",
"Description": "دریافت وجه فاکتور-فاکتور قروش # 1029 - محسن کریمی",
"Amount": 2500000,
"Currency": "IRR",
"CurrencyRate": 1.0,
"Project": "",
"Items": [
{
"Contact": {
"Id": 3055,
"Code": "000009",
"Name": " محسن کریمی"
},
"Account": "دارایی ها : دارایی های جاری : حساب های دریافتنی : حساب های دریافتنی",
"Amount": 2500000,
"Description": "دریافت وجه فاکتور-فاکتور قروش # 1029 - محسن کریمی"
}
],
"Transactions": [
{
"Bank": {
"Id": 1004,
"Code": "0001",
"Name": "بانک ملت"
},
"Cash": null,
"PettyCash": null,
"Contact": null,
"Check": null,
"Account": null,
"Type": 3,
"Reference": null,
"TransactionFee": 300,
"Amount": 2500000
}
],
"Invoice": {
"Id": 1,
"Number": "1002",
"DateTime": "2016-06-13T00:00:00",
"InvoiceType": 0
}
}
]
}
تراکنش در حسابفا میتواند واریز به / برداشت از صندوق (cash)، واریز به / برداشت از بانک (bank)، واریز به / برداشت از تنخواهگردان (PettyCash)، اعتباری از شخص (Contact) یا چکی (Check) باشد. در هر حالت فقط Object مربوط به همان نوع مقدار دارد و بقیه null هستند.
پارامترها:
|
apiKey userId password loginToken |
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات) |
| type | نوع رسید ( جدول نوع رسید ) |
| queryInfo | Object فیلتر و مرتبسازی (مشاهدۀ توضیحات) |
{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"queryInfo": {
"sortBy": "DateTime",
"sortDesc": true,
"take": 20,
"skip": 0
}
}
curl -X POST https://api.hesabfa.com/v1/receipt/getReceipts \
-H "Content-Type: application/json" \
-d '{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"queryInfo": {
"sortBy": "DateTime",
"sortDesc": true,
"take": 20,
"skip": 0
}
}'
<?php
$data = [
'apiKey' => 'your-api-key',
'loginToken' => 'your-login-token',
'type' => 1,
'queryInfo' => [
'sortBy' => 'DateTime',
'sortDesc' => true,
'take' => 20,
'skip' => 0
]
];
$ch = curl_init("https://api.hesabfa.com/v1/receipt/getReceipts");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
const data = {
apiKey: "your-api-key",
loginToken: "your-login-token",
type: 1,
queryInfo: {
sortBy: "DateTime",
sortDesc: true,
take: 20,
skip: 0
}
};
fetch("https://api.hesabfa.com/v1/receipt/getReceipts", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
console.log(result);
});
import requests
data = {
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"queryInfo": {
"sortBy": "DateTime",
"sortDesc": True,
"take": 20,
"skip": 0
}
}
response = requests.post(
"https://api.hesabfa.com/v1/receipt/getReceipts",
json=data
)
result = response.json()
print(result)
using System.Net.Http.Json;
using var client = new HttpClient();
var data = new
{
apiKey = "your-api-key",
loginToken = "your-login-token",
type = 1,
queryInfo = new
{
sortBy = "DateTime",
sortDesc = true,
take = 20,
skip = 0
}
};
var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/receipt/getReceipts", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
با این متد، فهرست رسیدهای دریافت یا پرداخت اشخاص برگردانده میشود.
آیتمهای موجود در پاسخ:
|
Success ErrorCode ErrorMessage |
(مشاهدۀ توضیحات) |
| Result | Object نتیجه، شامل اطلاعات صفحهبندی و آرایۀ رسیدها (List): |
| TotalCount | تعداد کل |
| FilteredCount | تعداد فیلتر شده |
| From | شماره ردیف شروع |
| To | شماره ردیف خاتمه |
| List | آرایهای از Objectهای اطلاعات رسید. هر Object ساختار زیر را دارد: |
| Id | شناسه رسید (برای سرویس دریافت با ID) |
| Number | شماره رسید |
| DateTime | تاریخ رسید |
| Description | توضیحات |
| Amount | مبلغ رسید |
| Currency | واحد پول رسید |
| CurrencyRate | نرخ تبدیل ارز |
| Project | پروژه |
| Items | آرایهای از طرفهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Contact | شخص (مشخصات شخص به صورت زیر خواهد بود) |
| Id | شناسه شخص |
| Code | کد شخص |
| Name | نام شخص |
| Account | مسیر حساب |
| Amount | مبلغ |
| Description | توضیحات |
| Transactions | آرایهای از تراکنشهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Bank | مشخصات بانک |
| Cash | مشخصات صندوق |
| PettyCash | مشخصات تنخواهگردان |
| Contact | مشخصات شخص |
| Check | مشخصات چک |
| Account | مسیر حساب |
| Type | نوع تراکنش رسید ( جدول نوع تراکنش رسید ) |
| Reference | ارجاع |
| TransactionFee | کارمزد خدمات بانکی |
| Amount | مبلغ |
| Invoice | Object اطلاعات فاکتور، با ساختار زیر: |
| Id | شناسه فاکتور |
| Number | شماره فاکتور |
| DateTime | تاریخ فاکتور |
| InvoiceType | نوع فاکتور ( جدول نوع فاکتور) |
{
"Success": true,
"ErrorCode": 0,
"ErrorMessage": "",
"Result": {
"TotalCount": 1,
"FilteredCount": 1,
"From": 1,
"To": 1,
"List": [
{
"Id": 4101,
"Number": 1008,
"DateTime": "2020-11-07T00:00:00",
"Description": "دریافت وجه فاکتور - فاکتور فروش # 1079 – محسن کریمی",
"Amount": 0.55,
"Currency": "USD",
"CurrencyRate": 1.0,
"Project": "",
"Items": [
{
"Contact": {
"Id": 3049,
"Code": "000003",
"Name": " محسن کریمی"
},
"Account": "دارایی ها : دارایی های جاری : حساب های دریافتنی : حساب های دریافتنی",
"Amount": 0.55,
"Description": "دریافت وجه فاکتور - فاکتور فروش # 1079 - محسن کریمی"
}
],
"Transactions": [
{
"Bank": {
"Id": 1004,
"Code": "0001",
"Name": "بانک ملت"
},
"Cash": null,
"PettyCash": null,
"Contact": null,
"Check": null,
"Account": null,
"Type": 3,
"Reference": null,
"TransactionFee": 300,
"Amount": 0.55
}
],
"Invoice": {
"Id": 1,
"Number": "1002",
"DateTime": "2016-06-13T00:00:00",
"InvoiceType": 0
}
}
]
}
}
تراکنش در حسابفا میتواند واریز به / برداشت از صندوق (cash)، واریز به / برداشت از بانک (bank)، واریز به / برداشت از تنخواهگردان (pettyCash)، اعتباری از شخص (contact) یا چکی (check) باشد. در هر حالت فقط Object مربوط به همان نوع مقدار دارد و بقیه null هستند.
پارامترها:
|
apiKey userId password loginToken |
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات) |
| *type | نوع رسید ( جدول نوع رسید ) |
| number | شماره رسید. در صورت وجود، رسید ویرایش میشود. در صورتی که ارسال نشود، رسید جدید ذخیره خواهد شد. |
| dateTime | تاریخ. در صورت عدم ارسال، رسید به تاریخ روز ذخیره میشود. |
| project | نام پروژه |
| description | شرح رسید. |
| bankCode | کد بانک |
| cashCode | کد صندوق |
| pettyCashCode | کد تنخواهگردان |
| accountPath | مسیر حساب |
| *contactCode | کد شخص |
| *amount | مبلغ به ارز پایه سیستم |
| bankFee | کارمزد خدمات بانکی |
| reference | شماره ارجاع |
| currency | واحد پول |
| currencyRate | نرخ برابری ارز به ارز پایه |
{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"description": "دریافت وجه/چک از محسن کریمی",
"amount": 2500000,
"contactCode": 9,
"bankCode": 1,
"cashCode": null,
"pettyCashCode": null,
"currency": "IRR",
"currencyRate": 1
}
curl -X POST https://api.hesabfa.com/v1/receipt/save \
-H "Content-Type: application/json" \
-d '{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"description": "دریافت وجه/چک از محسن کریمی",
"amount": 2500000,
"contactCode": 9,
"bankCode": 1,
"cashCode": null,
"pettyCashCode": null,
"currency": "IRR",
"currencyRate": 1
}'
<?php
$data = [
'apiKey' => 'your-api-key',
'loginToken' => 'your-login-token',
'type' => 1,
'description' => 'دریافت وجه/چک از محسن کریمی',
'amount' => 2500000,
'contactCode' => 9,
'bankCode' => 1,
'cashCode' => null,
'pettyCashCode' => null,
'currency' => 'IRR',
'currencyRate' => 1
];
$ch = curl_init("https://api.hesabfa.com/v1/receipt/save");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
const data = {
apiKey: "your-api-key",
loginToken: "your-login-token",
type: 1,
description: "دریافت وجه/چک از محسن کریمی",
amount: 2500000,
contactCode: 9,
bankCode: 1,
cashCode: null,
pettyCashCode: null,
currency: "IRR",
currencyRate: 1
};
fetch("https://api.hesabfa.com/v1/receipt/save", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
console.log(result);
});
import requests
data = {
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"description": "دریافت وجه/چک از محسن کریمی",
"amount": 2500000,
"contactCode": 9,
"bankCode": 1,
"cashCode": None,
"pettyCashCode": None,
"currency": "IRR",
"currencyRate": 1
}
response = requests.post(
"https://api.hesabfa.com/v1/receipt/save",
json=data
)
result = response.json()
print(result)
using System.Net.Http.Json;
using var client = new HttpClient();
var data = new
{
apiKey = "your-api-key",
loginToken = "your-login-token",
type = 1,
description = "دریافت وجه/چک از محسن کریمی",
amount = 2500000,
contactCode = 9,
bankCode = 1,
cashCode = (object?)null,
pettyCashCode = (object?)null,
currency = "IRR",
currencyRate = 1
};
var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/receipt/save", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
با این متد، یک رسید دریافت یا پرداخت در سیستم ثبت میشود.
contactCode الزامی است و از میان bankCode، cashCode و pettyCashCode فقط یکی باید مقدار داشته باشد؛ اگر بیش از یکی ارسال شود، خطایی برگردانده نمیشود و فقط یکی از آنها ثبت میشود (مثلاً با bankCode و cashCode، رسید بانکی ثبت میشود). در این متد، accountPath جایگزین contactCode نمیشود؛ برای ثبت رسید با مسیر حساب از متد ثبت پیشرفتۀ رسید (receipt/save2) استفاده کنید. اگر currency و currencyRate ارسال نشوند، واحد پول بانک، صندوق یا تنخواهگردان و نرخ برابری پیشفرض سیستم به کار میروند.
مثال: "داراییها: داراییهای جاری: موجودی نقد و بانک: وجوه در راه"
اگر حساب، تفصیلی مانند شخص یا بانک داشته باشد، کد آن تفصیل هم باید ارسال شود؛ مثلاً اگر تفصیل حساب، شخص باشد، فیلد contactCode هم باید ارسال شود.
آیتمهای موجود در پاسخ:
|
Success ErrorCode ErrorMessage |
(مشاهدۀ توضیحات) |
| Result | Object اطلاعات رسید دریافت یا پرداخت، با ساختار زیر: |
| Id | شناسه رسید (برای سرویس دریافت با ID) |
| Number | شماره رسید |
| DateTime | تاریخ رسید |
| Description | شرح |
| Amount | مبلغ رسید |
| Currency | واحد پول رسید |
| CurrencyRate | نرخ تبدیل ارز |
| Project | پروژه |
| Items | آرایهای از طرفهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Contact | شخص(مشخصات شخص به صورت زیر خواهد بود) |
| Id | شناسه شخص |
| Code | کد شخص |
| Name | نام شخص |
| Account | مسیر حساب |
| Amount | مبلغ |
| Description | توضیحات |
| Transactions | آرایهای از تراکنشهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Bank | مشخصات بانک |
| Cash | مشخصات صندوق |
| PettyCash | مشخصات تنخواهگردان |
| Contact | مشخصات شخص |
| Check | مشخصات چک |
| Account | مسیر حساب |
| Type | نوع تراکنش ( جدول نوع تراکنش رسید ) |
| Reference | ارجاع |
| TransactionFee | کارمزد خدمات بانکی |
| Amount | مبلغ |
| Invoice | Object اطلاعات فاکتور، با ساختار زیر: |
| Id | شناسه فاکتور |
| Number | شماره فاکتور |
| DateTime | تاریخ فاکتور |
| InvoiceType | نوع فاکتور ( جدول نوع فاکتور) |
{
"Success": true,
"ErrorCode": 0,
"ErrorMessage": "",
"Result": {
"Id": 100,
"Number": 1009,
"DateTime": "2020-11-07T00:00:00",
"Description": "دریافت وجه/چک از محسن کریمی",
"Amount": 2500000,
"Currency": "IRR",
"CurrencyRate": 0,
"Project": "",
"Items": [
{
"Contact": {
"Id": 3055,
"Code": "000009",
"Name": " محسن کریمی"
},
"Account": null,
"Amount": 2500000,
"Description": "دریافت وجه/چک از محسن کریمی"
}
],
"Transactions": [
{
"Bank": {
"Id": 1004,
"Code": "0001",
"Name": "بانک ملت"
},
"Cash": null,
"PettyCash": null,
"Contact": null,
"Check": null,
"Account": null,
"Type": 3,
"Reference": null,
"TransactionFee": 300,
"Amount": 25000000
}
],
"Invoice": null
}
}
تراکنش در حسابفا میتواند واریز به / برداشت از صندوق (cash)، واریز به / برداشت از بانک (bank)، واریز به / برداشت از تنخواهگردان (PettyCash)، اعتباری از شخص (Contact) یا چکی (Check) باشد. در هر حالت فقط Object مربوط به همان نوع مقدار دارد و بقیه null هستند.
پارامترها:
|
apiKey userId password loginToken |
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات) |
| type | نوع رسید ( جدول نوع رسید ) |
| number | شماره رسید |
curl -X POST https://api.hesabfa.com/v1/receipt/delete \
-H "Content-Type: application/json" \
-d '{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"number": 1001
}'
<?php
$data = [
'apiKey' => 'your-api-key',
'loginToken' => 'your-login-token',
'type' => 1,
'number' => 1001
];
$ch = curl_init("https://api.hesabfa.com/v1/receipt/delete");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
const data = {
apiKey: "your-api-key",
loginToken: "your-login-token",
type: 1,
number: 1001
};
fetch("https://api.hesabfa.com/v1/receipt/delete", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
console.log(result);
});
import requests
data = {
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 1,
"number": 1001
}
response = requests.post(
"https://api.hesabfa.com/v1/receipt/delete",
json=data
)
result = response.json()
print(result)
using System.Net.Http.Json;
using var client = new HttpClient();
var data = new
{
apiKey = "your-api-key",
loginToken = "your-login-token",
type = 1,
number = 1001
};
var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/receipt/delete", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
آیتمهای موجود در پاسخ:
|
Success ErrorCode ErrorMessage |
(مشاهدۀ توضیحات) |
| Result | در صورت موفقیت، مقدار true در Result قرار میگیرد. |
پارامترها:
|
apiKey userId password loginToken |
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات) |
| type | نوع رسید ( جدول نوع رسید ) |
| number |
شماره رسید
در صورت وجود، رسید ویرایش میشود. در صورتی که ارسال نشود، رسید جدید ذخیره خواهد شد. |
| description | شرح رسید |
| currency | واحد پول |
| currencyRate | نرخ برابری ارز به ارز پایه |
| dateTime | تاریخ. در صورت عدم ارسال، رسید به تاریخ روز ذخیره میشود. |
| project | نام پروژه |
| items | آرایهای از اقلام رسید. هر قلم ساختار زیر را دارد: |
| account | مسیر حساب |
| contactCode | کد شخص |
| amount | مبلغ |
| description | شرح |
| transactions | آرایهای از تراکنشهای رسید. هر تراکنش ساختار زیر را دارد: |
| amount | مبلغ |
| reference | ارجاع |
| transactionFee | کارمزد خدمات بانکی |
| bankCode | کد بانک |
| cashCode | کد صندوق |
| pettyCashCode | کد تنخواهگردان |
| contactCode | کد شخص |
| account | مسیر حساب |
| check | چک |
| number | شماره چک |
| date | تاریخ چک |
| sayyad | شماره صیاد |
| amount | مبلغ چک |
| payee | در وجه (فقط در صورتی که چک پرداختی باشد – در رسید پرداخت، هزینه و پرداخت سایر) |
| bankCode | کد بانکی که چک از آن صادر شده (فقط در صورتی که چک پرداختی باشد – در رسید پرداخت، هزینه و پرداخت سایر) |
| payerCode | دریافت کننده چک (فقط در صورتی که چک دریافتی باشد – در رسید دریافت، درآمد و دریافت سایر) |
| bankName | نام بانک صادر کننده چک (فقط در صورتی که چک دریافتی باشد – در رسید دریافت، درآمد و دریافت سایر) |
| bankBranch | شعبه بانک چک (فقط در صورتی که چک دریافتی باشد – در رسید دریافت، درآمد و دریافت سایر) |
| spendCheck | چک خرج شده |
| number | شماره چک دریافتی |
| date | تاریخ چک دریافتی |
| amount | مبلغ چک دریافتی |
{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 4,
"description": "رسید هزینه آبان ماه",
"currency": "IRR",
"currencyRate": 1,
"dateTime": "2024-07-23",
"project": "",
"items": [
{
"account": "هزینهها: هزینههای عملیاتی: هزینه ملزومات مصرفی",
"amount": 3200000
}
],
"transactions": [
{
"bankCode": 1,
"amount": 2000000,
"reference": "8900546",
"transactionFee": 250
},
{
"Check": {
"number": "5470098",
"amount": 1200000,
"sayyad": "872000545448792",
"bankName": "تجارت",
"payerCode": 2
}
}
]
}
curl -X POST https://api.hesabfa.com/v1/receipt/save2 \
-H "Content-Type: application/json" \
-d '{
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 4,
"description": "رسید هزینه آبان ماه",
"currency": "IRR",
"currencyRate": 1,
"dateTime": "2024-07-23",
"project": "",
"items": [
{
"account": "هزینهها: هزینههای عملیاتی: هزینه ملزومات مصرفی",
"amount": 3200000
}
],
"transactions": [
{
"bankCode": 1,
"amount": 2000000,
"reference": "8900546",
"transactionFee": 250
},
{
"Check": {
"number": "5470098",
"amount": 1200000,
"sayyad": "872000545448792",
"bankName": "تجارت",
"payerCode": 2
}
}
]
}'
<?php
$data = [
'apiKey' => 'your-api-key',
'loginToken' => 'your-login-token',
'type' => 4,
'description' => 'رسید هزینه آبان ماه',
'currency' => 'IRR',
'currencyRate' => 1,
'dateTime' => '2024-07-23',
'project' => '',
'items' => [
[
'account' => 'هزینهها: هزینههای عملیاتی: هزینه ملزومات مصرفی',
'amount' => 3200000
]
],
'transactions' => [
[
'bankCode' => 1,
'amount' => 2000000,
'reference' => '8900546',
'transactionFee' => 250
],
[
'Check' => [
'number' => '5470098',
'amount' => 1200000,
'sayyad' => '872000545448792',
'bankName' => 'تجارت',
'payerCode' => 2
]
]
]
];
$ch = curl_init("https://api.hesabfa.com/v1/receipt/save2");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
const data = {
apiKey: "your-api-key",
loginToken: "your-login-token",
type: 4,
description: "رسید هزینه آبان ماه",
currency: "IRR",
currencyRate: 1,
dateTime: "2024-07-23",
project: "",
items: [
{
account: "هزینهها: هزینههای عملیاتی: هزینه ملزومات مصرفی",
amount: 3200000
}
],
transactions: [
{
bankCode: 1,
amount: 2000000,
reference: "8900546",
transactionFee: 250
},
{
Check: {
number: "5470098",
amount: 1200000,
sayyad: "872000545448792",
bankName: "تجارت",
payerCode: 2
}
}
]
};
fetch("https://api.hesabfa.com/v1/receipt/save2", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
console.log(result);
});
import requests
data = {
"apiKey": "your-api-key",
"loginToken": "your-login-token",
"type": 4,
"description": "رسید هزینه آبان ماه",
"currency": "IRR",
"currencyRate": 1,
"dateTime": "2024-07-23",
"project": "",
"items": [
{
"account": "هزینهها: هزینههای عملیاتی: هزینه ملزومات مصرفی",
"amount": 3200000
}
],
"transactions": [
{
"bankCode": 1,
"amount": 2000000,
"reference": "8900546",
"transactionFee": 250
},
{
"Check": {
"number": "5470098",
"amount": 1200000,
"sayyad": "872000545448792",
"bankName": "تجارت",
"payerCode": 2
}
}
]
}
response = requests.post(
"https://api.hesabfa.com/v1/receipt/save2",
json=data
)
result = response.json()
print(result)
using System.Net.Http.Json;
using var client = new HttpClient();
var data = new
{
apiKey = "your-api-key",
loginToken = "your-login-token",
type = 4,
description = "رسید هزینه آبان ماه",
currency = "IRR",
currencyRate = 1,
dateTime = "2024-07-23",
project = "",
items = new object[]
{
new
{
account = "هزینهها: هزینههای عملیاتی: هزینه ملزومات مصرفی",
amount = 3200000
}
},
transactions = new object[]
{
new
{
bankCode = 1,
amount = 2000000,
reference = "8900546",
transactionFee = 250
},
new Dictionary<string, object?>
{
["Check"] = new
{
number = "5470098",
amount = 1200000,
sayyad = "872000545448792",
bankName = "تجارت",
payerCode = 2
}
}
}
};
var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/receipt/save2", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
با این متد، علاوه بر ثبت پیشرفتۀ رسیدهای دریافت و پرداخت، میتوانید رسیدهای درآمد و هزینه را هم ثبت کنید.
اگر رسید شامل چکی باشد که وضعیت آن عادی نیست (مثلاً در جریان وصول است یا خرج شده)، این رسید را نمیتوان از طریق API ویرایش کرد.
برای ثبت رسید دریافت و پرداخت، ارسال کد شخص کافی است. برای ثبت رسید درآمد و هزینه، مسیر کامل حساب باید ارسال شود و اگر تفصیل حساب، شخص باشد، کد شخص هم لازم است.
در هر تراکنش فقط یکی از فیلدهای bankCode، cashCode، check، accountPath، contactCode، pettyCashCode و spendCheck باید مقدار داشته باشد؛ اگر بیش از یکی ارسال شود، خطایی برگردانده نمیشود و فقط یکی از آنها ثبت میشود. در هر ردیف items نیز اگر contactCode و account هر دو ارسال شوند، account نادیده گرفته میشود. اگر currency و currencyRate ارسال نشوند، واحد پول بانک، صندوق یا تنخواهگردان و نرخ برابری پیشفرض سیستم به کار میروند.
فیلد spendCheck فقط در رسید پرداخت به کار میرود. برای ثبت خرج چک، شماره، تاریخ و مبلغ چک دریافتی باید ارسال شود. چک دریافتی که وضعیت آن عادی نباشد، قابل خرج نیست.
مثال: "داراییها: داراییهای جاری: موجودی نقد و بانک: وجوه در راه"
اگر حساب، تفصیلی مانند شخص یا بانک داشته باشد، کد آن تفصیل هم باید ارسال شود؛ مثلاً اگر تفصیل حساب، شخص باشد، فیلد contactCode هم باید ارسال شود.
آیتمهای موجود در پاسخ:
|
Success ErrorCode ErrorMessage |
(مشاهدۀ توضیحات) |
| Result | Object اطلاعات رسید دریافت یا پرداخت، با ساختار زیر: |
| Id | شناسه رسید (برای سرویس دریافت با ID) |
| Number | شماره رسید |
| DateTime | تاریخ رسید |
| Description | شرح |
| Amount | مبلغ رسید |
| Currency | واحد پول رسید |
| CurrencyRate | نرخ تبدیل ارز |
| Project | پروژه |
| Items | آرایهای از طرفهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Contact | شخص(مشخصات شخص به صورت زیر خواهد بود) |
| Id | شناسه شخص |
| Code | کد شخص |
| Name | نام شخص |
| Account | مسیر حساب |
| Amount | مبلغ |
| Description | توضیحات |
| Transactions | آرایهای از تراکنشهای دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است. |
| Bank | مشخصات بانک |
| Cash | مشخصات صندوق |
| PettyCash | مشخصات تنخواهگردان |
| Contact | مشخصات شخص |
| Check | مشخصات چک |
| Account | مسیر حساب |
| Type | نوع تراکنش ( جدول نوع تراکنش رسید ) |
| Reference | ارجاع |
| TransactionFee | کارمزد خدمات بانکی |
| Amount | مبلغ |
| Invoice | Object اطلاعات فاکتور، با ساختار زیر: |
| Id | شناسه فاکتور |
| Number | شماره فاکتور |
| DateTime | تاریخ فاکتور |
| InvoiceType | نوع فاکتور ( جدول نوع فاکتور) |
{
"Success": true,
"ErrorCode": 0,
"ErrorMessage": "",
"Result": {
"Id": 9178,
"Number": 227,
"DateTime": "2024-07-23T00:00:00+03:30",
"Description": "رسید هزینه آبان ماه",
"Amount": 3200000.0,
"Currency": "IRR",
"CurrencyRate": 1.0,
"Project": "",
"Items": [
{
"Contact": null,
"Account": "هزینهها : هزینههای عملیاتی : هزینه ملزومات مصرفی",
"Amount": 3200000.0,
"Description": "پرداخت وجه/چک بابت هزینههای عملیاتی : هزینه ملزومات مصرفی"
}
],
"Transactions": [
{
"Bank": {
"Id": 1,
"Code": "0001",
"Name": "بانک ملت"
},
"Cash": null,
"PettyCash": null,
"Contact": null,
"Check": null,
"Account": null,
"Type": 3,
"Reference": "8900546",
"TransactionFee": 250.0,
"Amount": 2000000.0
},
{
"Bank": null,
"Cash": null,
"PettyCash": null,
"Contact": null,
"Check": {
"Number": "5470098",
"Date": "2024-07-23T00:00:00+03:30",
"Sayyad": "872000545448792",
"Amount": 1200000.0,
"Status": 0,
"BankCode": "0002",
"BankName": "بانك تجارت",
"BankBranch": null,
"PayerCode": null,
"PayerName": null,
"Payee": "محمد محمدی"
},
"Account": null,
"Type": 4,
"Reference": "",
"TransactionFee": 0.0,
"Amount": 1200000.0
}
],
"Invoice": null
}
}
تراکنش در حسابفا میتواند واریز به / برداشت از صندوق (cash)، واریز به / برداشت از بانک (bank)، واریز به / برداشت از تنخواهگردان (PettyCash)، اعتباری از شخص (Contact) یا چکی (Check) باشد. در هر حالت فقط Object مربوط به همان نوع مقدار دارد و بقیه null هستند.