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


Copyed
URL:https://api.hesabfa.com/v1/invoice/get

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/get \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'number' => 1001,
    'type' => 0
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    number: 1001,
    type: 0
};

fetch("https://api.hesabfa.com/v1/invoice/get", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/get",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    number = 1001,
    type = 0
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/get", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result Object اطلاعات فاکتور، با ساختار زیر:
Id شناسه فاکتور (برای سرویس دریافت با ID)
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سررسید فاکتور
ContactCode کد شخص
Contact Object اطلاعات شخص
ContactTitle عنوان شخص در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور)
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخصی که هزینه حمل به حساب او ثبت می‌شود
FreightPersonName نام شخصی که هزینه حمل به حساب او ثبت می‌شود
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Others آرایه‌ای از سایر هزینه‌ها و کسورات فاکتور؛ هر مورد: Title (عنوان)، Amount (مبلغ) و Add (true: به مبلغ فاکتور اضافه می‌شود، false: کسر می‌شود)
Currency واحد پول
CurrencyRate نرخ تبدیل ارز
TaxId کد منحصر به فرد مالیاتی
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور. هر قلم ساختار زیر را دارد:
Id شناسه ردیف فاکتور
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {
            "Code": "000001",
            "Name": "فروشگاه توحید"
        },
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": {
                    "Id": 79641,
                    "Code": "000001",
                    "Name": "Galaxy J7 گوشی موبایل",
                    "ItemType": 0,
                    "Unit": "عدد",
                    "SubUnit": "",
                    "ConversionFactor": 1,
                    "Barcode": "345345345345",
                    "Stock": 9,
                    "BuyPrice": 90000,
                    "SellPrice": 100000,
                    "PurchasesTitle": "Samsung Galaxy J7",
                    "SalesTitle": "Samsung Galaxy J7",
                    "NodeId": 43,
                    "NodeName": "سامسونگ",
                    "NodeFamily": "دیجیتال:موبایل:سامسونگ",
                    "Tag": "",
                    "Description": "",
                    "ProductCode": "745921",
                    "Active": true,
                    "SalesTaxable": true,
                    "PurchaseTaxable": true,
                    "TaxType": 3,
                    "TaxId": "",
                    "TaxUnit": "",
                    "ReorderPoint": 0,
                    "LeadTime": 0,
                    "MinimumOrder": 0,
                    "PriceList": null
                },
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": ["974900098723"]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null,
        "Profit": 9000.0
    }
} 
Copyed
URL:https://api.hesabfa.com/v1/invoice/getById

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
id Id فاکتور مورد نظر
idList آرایه‌ای از id فاکتورها
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "id": 1,
    "idList": [
        3259,
        3273
    ]
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/getById \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "id": 1,
    "idList": [
        3259,
        3273
    ]
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'id' => 1,
    'idList' => [
        3259,
        3273
    ]
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    id: 1,
    idList: [
        3259,
        3273
    ]
};

fetch("https://api.hesabfa.com/v1/invoice/getById", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "id": 1,
    "idList": [
        3259,
        3273
    ]
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/getById",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    id = 1,
    idList = new object[]
    {
        3259,
        3273
    }
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/getById", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
نکات ضروری
  • یکی از پارامترهای id یا idList باید ارسال شود.

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result Object اطلاعات فاکتور، با ساختار زیر:
Id شناسه فاکتور (برای سرویس دریافت با ID)
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سررسید فاکتور
ContactCode کد شخص
Contact Object اطلاعات شخص
ContactTitle عنوان شخص در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور)
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخصی که هزینه حمل به حساب او ثبت می‌شود
FreightPersonName نام شخصی که هزینه حمل به حساب او ثبت می‌شود
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Others آرایه‌ای از سایر هزینه‌ها و کسورات فاکتور؛ هر مورد: Title (عنوان)، Amount (مبلغ) و Add (true: به مبلغ فاکتور اضافه می‌شود، false: کسر می‌شود)
Currency واحد پول
CurrencyRate نرخ تبدیل ارز
TaxId کد منحصر به فرد مالیاتی
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور. هر قلم ساختار زیر را دارد:
Id شناسه ردیف فاکتور
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {
            "Code": "000001",
            "Name": "فروشگاه توحید"
        },
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": null,
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": ["974900098723"]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null,
        "Profit": 0
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/getInvoices

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
type نوع فاکتور ( جدول نوع فاکتور )
queryInfo Object فیلتر و مرتب‌سازی (مشاهدۀ توضیحات)
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "type": 0,
    "queryInfo": {
        "sortBy": "Date",
        "sortDesc": true,
        "take": 20,
        "skip": 0
    }
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/getInvoices \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "type": 0,
    "queryInfo": {
        "sortBy": "Date",
        "sortDesc": true,
        "take": 20,
        "skip": 0
    }
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'type' => 0,
    'queryInfo' => [
        'sortBy' => 'Date',
        'sortDesc' => true,
        'take' => 20,
        'skip' => 0
    ]
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/getInvoices");
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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    type: 0,
    queryInfo: {
        sortBy: "Date",
        sortDesc: true,
        take: 20,
        skip: 0
    }
};

fetch("https://api.hesabfa.com/v1/invoice/getInvoices", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "type": 0,
    "queryInfo": {
        "sortBy": "Date",
        "sortDesc": True,
        "take": 20,
        "skip": 0
    }
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/getInvoices",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    type = 0,
    queryInfo = new
    {
        sortBy = "Date",
        sortDesc = true,
        take = 20,
        skip = 0
    }
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/getInvoices", 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 شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سررسید فاکتور
ContactCode کد شخص
Contact Object اطلاعات شخص
ContactTitle عنوان شخص در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور)
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخصی که هزینه حمل به حساب او ثبت می‌شود
FreightPersonName نام شخصی که هزینه حمل به حساب او ثبت می‌شود
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Others آرایه‌ای از سایر هزینه‌ها و کسورات فاکتور؛ هر مورد: Title (عنوان)، Amount (مبلغ) و Add (true: به مبلغ فاکتور اضافه می‌شود، false: کسر می‌شود)
Currency واحد پول
CurrencyRate نرخ تبدیل ارز
TaxId کد منحصر به فرد مالیاتی
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور. هر قلم ساختار زیر را دارد:
Id شناسه ردیف فاکتور
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "TotalCount": 2,
        "FilteredCount": 2,
        "From": 1,
        "To": 2,
        "List": [
            {
                "Id": 3,
                "Number": "1002",
                "Reference": "",
                "Date": "2018-07-19 14:22:50",
                "DueDate": "2018-07-19 14:22:50",
                "ContactCode": "000001",
                "Contact": {
                    "Code": "000001",
                    "Name": "سعید محمدی"
                },
                "ContactTitle": "سعید محمدی",
                "Sum": 228000,
                "Payable": 228000,
                "Paid": 0,
                "Rest": 228000,
                "Freight": 0,
                "FreightPersonCode": "",
                "FreightPersonName": "",
                "Note": "",
                "Sent": false,
                "Returned": false,
                "InvoiceType": 0,
                "Status": 2,
                "InvoiceItems": [
                    {
                        "Id": 408,
                        "RowNumber": 0,
                        "Description": "Galaxy J7 گوشی سامسونگ",
                        "ItemCode": null,
                        "Item": {
                            "Id": 79641,
                            "Code": "000001",
                            "Name": "Galaxy J7 گوشی موبایل",
                            "ItemType": 0,
                            "Unit": "عدد",
                            "SubUnit": "",
                            "ConversionFactor": 1,
                            "Barcode": "345345345345",
                            "Stock": 9,
                            "BuyPrice": 90000,
                            "SellPrice": 100000,
                            "PurchasesTitle": "Samsung Galaxy J7",
                            "SalesTitle": "Samsung Galaxy J7",
                            "NodeId": 43,
                            "NodeName": "سامسونگ",
                            "NodeFamily": "دیجیتال:موبایل:سامسونگ",
                            "Tag": "",
                            "Description": "",
                            "ProductCode": "745921",
                            "Active": true,
                            "SalesTaxable": true,
                            "PurchaseTaxable": true,
                            "TaxType": 3,
                            "TaxId": "",
                            "TaxUnit": "",
                            "ReorderPoint": 0,
                            "LeadTime": 0,
                            "MinimumOrder": 0,
                            "PriceList": null
                        },
                        "Quantity": 1.0,
                        "Unit": "عدد",
                        "UnitPrice": 100000.0,
                        "Sum": 100000.0,
                        "Discount": 0.0,
                        "Tax": 9000.0,
                        "TotalAmount": 109000.0,
                        "SerialNumbers": ["974900098723"]
                    }
                ],
                "Tag": "",
                "WarehouseReceiptStatus": 1,
                "Project": "پروژه یک",
                "SalesmanCode": "10001",
                "SalesmanPercent": 30,
                "Others": [
                    {
                        "Title": "هزینه‌های گمرکی",
                        "Amount": 1540000.0,
                        "Add": true
                    }
                ],
                "Currency": "IRR",
                "CurrencyRate": 1.0,
                "TaxId": "",
                "Profit": 9000.0
            },
            {
                "Id": 2,
                "Number": "1001",
                "Reference": "",
                "Date": "2018-07-17 17:30:12",
                "DueDate": "2018-07-17 17:30:12",
                "ContactCode": "000001",
                "Contact": {
                    "Code": "000001",
                    "Name": "سعید محمدی"
                },
                "ContactTitle": "سعید محمدی",
                "Sum": 109000,
                "Payable": 109000,
                "Paid": 0,
                "Rest": 109000,
                "Freight": 0,
                "FreightPersonCode": "",
                "FreightPersonName": "",
                "Note": "",
                "Sent": false,
                "Returned": false,
                "InvoiceType": 0,
                "Status": 2,
                "InvoiceItems": [
                    {
                        "Id": 408,
                        "RowNumber": 0,
                        "Description": "Galaxy J7 گوشی سامسونگ",
                        "ItemCode": null,
                        "Item": {
                            "Id": 79641,
                            "Code": "000001",
                            "Name": "Galaxy J7 گوشی موبایل",
                            "ItemType": 0,
                            "Unit": "عدد",
                            "SubUnit": "",
                            "ConversionFactor": 1,
                            "Barcode": "345345345345",
                            "Stock": 9,
                            "BuyPrice": 90000,
                            "SellPrice": 100000,
                            "PurchasesTitle": "Samsung Galaxy J7",
                            "SalesTitle": "Samsung Galaxy J7",
                            "NodeId": 43,
                            "NodeName": "سامسونگ",
                            "NodeFamily": "دیجیتال:موبایل:سامسونگ",
                            "Tag": "",
                            "Description": "",
                            "ProductCode": "745921",
                            "Active": true,
                            "SalesTaxable": true,
                            "PurchaseTaxable": true,
                            "TaxType": 3,
                            "TaxId": "",
                            "TaxUnit": "",
                            "ReorderPoint": 0,
                            "LeadTime": 0,
                            "MinimumOrder": 0,
                            "PriceList": null
                        },
                        "Quantity": 1.0,
                        "Unit": "عدد",
                        "UnitPrice": 100000.0,
                        "Sum": 100000.0,
                        "Discount": 0.0,
                        "Tax": 9000.0,
                        "TotalAmount": 109000.0,
                        "SerialNumbers": ["974900098723"]
                    }
                ],
                "Tag": "",
                "WarehouseReceiptStatus": 1,
                "Project": "پروژه یک",
                "SalesmanCode": "10001",
                "SalesmanPercent": 30,
                "Others": [
                    {
                        "Title": "هزینه‌های گمرکی",
                        "Amount": 1540000.0,
                        "Add": true
                    }
                ],
                "Currency": "IRR",
                "CurrencyRate": 1.0,
                "TaxId": "",
                "Profit": 9000.0
            }
        ]
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/save

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
invoice Object اطلاعات فاکتور، با ساختار زیر:

* فیلدهای ستاره‌دار الزامی هستند.

number شماره فاکتور
در صورتی که شماره فاکتور را وارد نکنید، فاکتور با شماره اتوماتیک ذخیره می‌شود.
در صورتی که شماره فاکتور وارد شود و موجود باشد، اطلاعات ویرایش می‌شود.
در صورتی که شماره فاکتور وارد شود و موجود نباشد، فاکتور با آن شماره ذخیره خواهد شد.
reference شماره ارجاع
*date تاریخ فاکتور
*dueDate تاریخ سر رسید فاکتور
*contactCode کد شخص
contactTitle عنوان مشتری/فروشنده در فاکتور
note یادداشت
sent وضعیت ارسال فاکتور
*invoiceType نوع فاکتور ( جدول نوع فاکتور )
status وضعیت فاکتور ( جدول وضعیت فاکتور )
tag فیلد متنی قابل استفاده توسط برنامه‌نویس
freight هزینه حمل
freightPersonCode کد شخص حمل کننده کالا
warehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
project پروژه
salesmanCode کد فروشنده
salesmanPercent درصد پورسانت فروشنده
invoiceItems آرایه‌ای از اقلام فاکتور. هر قلم ساختار زیر را دارد:
rowNumber شماره ردیف
*description توضیحات کالا یا خدمات
*itemCode کد کالا یا خدمات
unit واحد کالا
*quantity تعداد یا مقدار
*unitPrice قیمت واحد
*discount تخفیف
*tax مالیات
serialNumbers شماره سریال
others آرایه‌ای از اضافات و کسورات فاکتور. هر مورد ساختار زیر را دارد:
title عنوان اضافات و کسورات
amount مقدار اضافات و کسورات
add true:اضافات
false:کسورات
currency واحد پول
taxId کد منحصر به فرد مالیاتی
currencyRate نرخ برابری ارز به ارز پایه
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "invoice": {
        "number": "1001",
        "reference": "",
        "date": "2024-07-17 17:30:12",
        "dueDate": "2024-07-17 17:30:12",
        "contactCode": "000001",
        "contactTitle": "فروشگاه توحید",
        "note": "",
        "sent": false,
        "invoiceType": 0,
        "status": 2,
        "tag": "",
        "freight": 0,
        "freightPersonCode": "",
        "warehouseReceiptStatus": 1,
        "project": "پروژه یک",
        "salesmanCode": 10001,
        "salesmanPercent": 30,
        "currency": "IRR",
        "invoiceItems": [
            {
                "rowNumber": 1,
                "description": "Galaxy J7 گوشی سامسونگ",
                "itemCode": "000001",
                "unit": "عدد",
                "quantity": 1,
                "unitPrice": 100000,
                "discount": 0,
                "tax": 9000,
                "serialNumbers": [
                    "974900098723"
                ]
            }
        ],
        "others": [
            {
                "title": "هزینه‌های گمرکی",
                "amount": 1540000,
                "add": true
            }
        ],
        "taxId": "",
        "currencyRate": 1
    }
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/save \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "invoice": {
        "number": "1001",
        "reference": "",
        "date": "2024-07-17 17:30:12",
        "dueDate": "2024-07-17 17:30:12",
        "contactCode": "000001",
        "contactTitle": "فروشگاه توحید",
        "note": "",
        "sent": false,
        "invoiceType": 0,
        "status": 2,
        "tag": "",
        "freight": 0,
        "freightPersonCode": "",
        "warehouseReceiptStatus": 1,
        "project": "پروژه یک",
        "salesmanCode": 10001,
        "salesmanPercent": 30,
        "currency": "IRR",
        "invoiceItems": [
            {
                "rowNumber": 1,
                "description": "Galaxy J7 گوشی سامسونگ",
                "itemCode": "000001",
                "unit": "عدد",
                "quantity": 1,
                "unitPrice": 100000,
                "discount": 0,
                "tax": 9000,
                "serialNumbers": [
                    "974900098723"
                ]
            }
        ],
        "others": [
            {
                "title": "هزینه‌های گمرکی",
                "amount": 1540000,
                "add": true
            }
        ],
        "taxId": "",
        "currencyRate": 1
    }
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'invoice' => [
        'number' => '1001',
        'reference' => '',
        'date' => '2024-07-17 17:30:12',
        'dueDate' => '2024-07-17 17:30:12',
        'contactCode' => '000001',
        'contactTitle' => 'فروشگاه توحید',
        'note' => '',
        'sent' => false,
        'invoiceType' => 0,
        'status' => 2,
        'tag' => '',
        'freight' => 0,
        'freightPersonCode' => '',
        'warehouseReceiptStatus' => 1,
        'project' => 'پروژه یک',
        'salesmanCode' => 10001,
        'salesmanPercent' => 30,
        'currency' => 'IRR',
        'invoiceItems' => [
            [
                'rowNumber' => 1,
                'description' => 'Galaxy J7 گوشی سامسونگ',
                'itemCode' => '000001',
                'unit' => 'عدد',
                'quantity' => 1,
                'unitPrice' => 100000,
                'discount' => 0,
                'tax' => 9000,
                'serialNumbers' => [
                    '974900098723'
                ]
            ]
        ],
        'others' => [
            [
                'title' => 'هزینه‌های گمرکی',
                'amount' => 1540000,
                'add' => true
            ]
        ],
        'taxId' => '',
        'currencyRate' => 1
    ]
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    invoice: {
        number: "1001",
        reference: "",
        date: "2024-07-17 17:30:12",
        dueDate: "2024-07-17 17:30:12",
        contactCode: "000001",
        contactTitle: "فروشگاه توحید",
        note: "",
        sent: false,
        invoiceType: 0,
        status: 2,
        tag: "",
        freight: 0,
        freightPersonCode: "",
        warehouseReceiptStatus: 1,
        project: "پروژه یک",
        salesmanCode: 10001,
        salesmanPercent: 30,
        currency: "IRR",
        invoiceItems: [
            {
                rowNumber: 1,
                description: "Galaxy J7 گوشی سامسونگ",
                itemCode: "000001",
                unit: "عدد",
                quantity: 1,
                unitPrice: 100000,
                discount: 0,
                tax: 9000,
                serialNumbers: [
                    "974900098723"
                ]
            }
        ],
        others: [
            {
                title: "هزینه‌های گمرکی",
                amount: 1540000,
                add: true
            }
        ],
        taxId: "",
        currencyRate: 1
    }
};

fetch("https://api.hesabfa.com/v1/invoice/save", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "invoice": {
        "number": "1001",
        "reference": "",
        "date": "2024-07-17 17:30:12",
        "dueDate": "2024-07-17 17:30:12",
        "contactCode": "000001",
        "contactTitle": "فروشگاه توحید",
        "note": "",
        "sent": False,
        "invoiceType": 0,
        "status": 2,
        "tag": "",
        "freight": 0,
        "freightPersonCode": "",
        "warehouseReceiptStatus": 1,
        "project": "پروژه یک",
        "salesmanCode": 10001,
        "salesmanPercent": 30,
        "currency": "IRR",
        "invoiceItems": [
            {
                "rowNumber": 1,
                "description": "Galaxy J7 گوشی سامسونگ",
                "itemCode": "000001",
                "unit": "عدد",
                "quantity": 1,
                "unitPrice": 100000,
                "discount": 0,
                "tax": 9000,
                "serialNumbers": [
                    "974900098723"
                ]
            }
        ],
        "others": [
            {
                "title": "هزینه‌های گمرکی",
                "amount": 1540000,
                "add": True
            }
        ],
        "taxId": "",
        "currencyRate": 1
    }
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/save",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    invoice = new
    {
        number = "1001",
        reference = "",
        date = "2024-07-17 17:30:12",
        dueDate = "2024-07-17 17:30:12",
        contactCode = "000001",
        contactTitle = "فروشگاه توحید",
        note = "",
        sent = false,
        invoiceType = 0,
        status = 2,
        tag = "",
        freight = 0,
        freightPersonCode = "",
        warehouseReceiptStatus = 1,
        project = "پروژه یک",
        salesmanCode = 10001,
        salesmanPercent = 30,
        currency = "IRR",
        invoiceItems = new object[]
        {
            new
            {
                rowNumber = 1,
                description = "Galaxy J7 گوشی سامسونگ",
                itemCode = "000001",
                unit = "عدد",
                quantity = 1,
                unitPrice = 100000,
                discount = 0,
                tax = 9000,
                serialNumbers = new object[]
                {
                    "974900098723"
                }
            }
        },
        others = new object[]
        {
            new
            {
                title = "هزینه‌های گمرکی",
                amount = 1540000,
                add = true
            }
        },
        taxId = "",
        currencyRate = 1
    }
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/save", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
نکات ضروری
  1. در فاکتور ضایعات، فیلد note حتماً باید مقدار داشته باشد.

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result Object اطلاعات فاکتور، با ساختار زیر:
Id شناسه فاکتور (برای سرویس دریافت با ID)
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سررسید فاکتور
ContactCode کد شخص
Contact Object اطلاعات شخص
ContactTitle عنوان شخص در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور)
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخصی که هزینه حمل به حساب او ثبت می‌شود
FreightPersonName نام شخصی که هزینه حمل به حساب او ثبت می‌شود
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Others آرایه‌ای از سایر هزینه‌ها و کسورات فاکتور؛ هر مورد: Title (عنوان)، Amount (مبلغ) و Add (true: به مبلغ فاکتور اضافه می‌شود، false: کسر می‌شود)
Currency واحد پول
CurrencyRate نرخ تبدیل ارز
TaxId کد منحصر به فرد مالیاتی
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور. هر قلم ساختار زیر را دارد:
Id شناسه ردیف فاکتور
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
مثال:
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {
            "Code": "000001",
            "Name": "فروشگاه توحید"
        },
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": null,
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": ["974900098723"]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null,
        "Profit": 0
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/delete

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/delete \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'number' => 1001,
    'type' => 0
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    number: 1001,
    type: 0
};

fetch("https://api.hesabfa.com/v1/invoice/delete", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/delete",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    number = 1001,
    type = 0
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/delete", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result در صورت موفقیت، مقدار true در Result قرار می‌گیرد.
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": true
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/savePayment

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
type نوع فاکتور ( جدول نوع فاکتور)
number شماره فاکتور فروش
bankCode کد بانک
cashCode کد صندوق
pettyCashCode کد تنخواه‌گردان
contactCode کد شخص
accountPath مسیر حساب
date تاریخ تراکنش
amount مبلغ تراکنش
*transactionNumber شماره تراکنش
project نام پروژه، در صورتی که این فیلد ارسال نشود، رسید با پروژه ثبت شده برای فاکتورذخیره خواهد شد.
description توضیحات تراکنش
transactionFee هزینه یا کارمزد تراکنش
currency واحد پول
currencyRate نرخ برابری ارز به ارز پایه
cashCode کد صندوق
pettyCashCode کد تنخواه‌گردان
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "type": 0,
    "number": 1001,
    "bankCode": "0001",
    "date": "2024-07-17T00:00:00",
    "amount": 109000,
    "transactionNumber": "255496387",
    "project": "فروشگاه آنلاین",
    "description": "پرداخت آنلاین",
    "transactionFee": 0
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/savePayment \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "type": 0,
    "number": 1001,
    "bankCode": "0001",
    "date": "2024-07-17T00:00:00",
    "amount": 109000,
    "transactionNumber": "255496387",
    "project": "فروشگاه آنلاین",
    "description": "پرداخت آنلاین",
    "transactionFee": 0
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'type' => 0,
    'number' => 1001,
    'bankCode' => '0001',
    'date' => '2024-07-17T00:00:00',
    'amount' => 109000,
    'transactionNumber' => '255496387',
    'project' => 'فروشگاه آنلاین',
    'description' => 'پرداخت آنلاین',
    'transactionFee' => 0
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/savePayment");
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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    type: 0,
    number: 1001,
    bankCode: "0001",
    date: "2024-07-17T00:00:00",
    amount: 109000,
    transactionNumber: "255496387",
    project: "فروشگاه آنلاین",
    description: "پرداخت آنلاین",
    transactionFee: 0
};

fetch("https://api.hesabfa.com/v1/invoice/savePayment", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "type": 0,
    "number": 1001,
    "bankCode": "0001",
    "date": "2024-07-17T00:00:00",
    "amount": 109000,
    "transactionNumber": "255496387",
    "project": "فروشگاه آنلاین",
    "description": "پرداخت آنلاین",
    "transactionFee": 0
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/savePayment",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    type = 0,
    number = 1001,
    bankCode = "0001",
    date = "2024-07-17T00:00:00",
    amount = 109000,
    transactionNumber = "255496387",
    project = "فروشگاه آنلاین",
    description = "پرداخت آنلاین",
    transactionFee = 0
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/savePayment", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
نکات ضروری
  1. فقط یکی از پنج فیلد accountPath، contactCode، bankCode، cashCode و pettyCashCode باید مقدار داشته باشد. اگر بیش از یکی ارسال شود، خطایی برگردانده نمی‌شود و فقط یکی از آن‌ها ثبت می‌شود (مثلاً اگر bankCode و cashCode هر دو ارسال شوند، پرداخت به بانک ثبت می‌شود).
  2. ارسال transactionNumber الزامی است.
  3. واحد پول فاکتور با واحد پول بانک، صندوق یا تنخواه‌گردان باید یکی باشد.
  4. اگر currency و currencyRate ارسال نشوند، مقادیر فاکتور به کار می‌روند.
accountPath مسیر حساب

مثال: "دارایی‌ها: دارایی‌های جاری: موجودی نقد و بانک: وجوه در راه"
اگر حساب، تفصیلی مانند شخص یا بانک داشته باشد، کد آن تفصیل هم باید ارسال شود؛ مثلاً اگر تفصیل حساب، شخص باشد، فیلد contactCode هم باید ارسال شود.

توضیحات فیلد transactionFee

اگر بابت پرداخت آنلاین، مبلغی به‌عنوان هزینۀ تراکنش از حساب شما کسر می‌شود، می‌توانید آن را در این فیلد ثبت کنید تا سند هزینه به‌طور خودکار صادر شود.

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result در صورت موفقیت، Object رسید دریافت یا پرداخت ثبت‌شده در Result قرار می‌گیرد. ساختار آن به شرح زیر است:
Id شناسه رسید دریافت
Number شماره رسید
DateTime تاریخ رسید
Description شرح
Amount مبلغ رسید
Currency واحد پول رسید
CurrencyRate نرخ تبدیل ارز
Project پروژه
Items آرایه‌ای از طرف‌های دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است.
Contact شخص(مشخصات شخص به صورت زیر خواهد بود)
Id شناسه بانک
Code کد شخص
Name نام شخص
Account مسیر حساب
Amount مبلغ
Description توضیحات
Transactions آرایه‌ای از تراکنش‌های دریافت یا پرداخت. ساختار آن در مثال نشان داده شده است.
Cash نقدی
Bank بانکی(مشخصات بانک به صورت زیر خواهد بود)
Code کد بانک
Name نام بانک
PettyCash تنخواه‌گردان
Contact اعتباری از شخص
Check بصورت چکی
Account مسیر حساب
Type نوع تراکنش رسید ( جدول نوع تراکنش رسید )
Reference ارجاع
TransactionFee کارمزد خدمات بانکی
Amount مبلغ
Invoice Object اطلاعات فاکتور، با ساختار زیر:
Id id فاکتور
Number شماره فاکتور
DateTime تاریخ ثبت فاکتور
invoiceType نوع فاکتور ( جدول نوع فاکتور )
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 78,
        "Number": 1075,
        "DateTime": "2024-07-17T00:00:00",
        "Description": "پرداخت آنلاین",
        "Amount": 109000.0,
        "Currency": "IRR",
        "CurrencyRate": 1.0000000000,
        "Project": "",
        "Items": [
            {
                "Contact": {
                    "Id": 1,
                    "Code": "000001",
                    "Name": "فروشگاه توحید"
                },
                "Account": "دارایی‌ها : دارایی‌های جاری : حساب‌های دریافتنی : حساب‌های دریافتنی",
                "Amount": 109000.0,
                "Description": "پرداخت آنلاین"
            }
        ],
        "Transactions": [
            {
                "Bank": {
                    "Id": 1,
                    "Code": "0001",
                    "Name": "ملت"
                },
                "Cash": null,
                "PettyCash": null,
                "Contact": null,
                "Check": null,
                "Account": null,
                "Type": 3,
                "Reference": "255496387",
                "TransactionFee": 0.0,
                "Amount": 109000.0
            }
        ],
        "Invoice": {
            "Id": 2,
            "Number": "1001",
            "DateTime": "2024-07-17T00:00:00",
            "InvoiceType": 0
        }
    }
} 
توضیحات آرایه Transactions

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

Copyed
URL:https://api.hesabfa.com/v1/invoice/getOnlineInvoiceUrl

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/getOnlineInvoiceUrl \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'number' => 1001,
    'type' => 0
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/getOnlineInvoiceUrl");
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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    number: 1001,
    type: 0
};

fetch("https://api.hesabfa.com/v1/invoice/getOnlineInvoiceUrl", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/getOnlineInvoiceUrl",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    number = 1001,
    type = 0
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/getOnlineInvoiceUrl", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
نکات ضروری
  1. این متد در حال حاضر فقط برای فاکتورهای فروش فعال است.
  2. اگر درگاه پرداخت اینترنتی فعال نشده باشد، دریافت URL فاکتور آنلاین ممکن نیست.
  3. برای فعال‌سازی درگاه پرداخت اینترنتی، در منوی تنظیمات گزینۀ تنظیمات فاکتور آنلاین را انتخاب کنید.

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result در صورت موفقیت، آدرس (URL) فاکتور آنلاین در Result قرار می‌گیرد.
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": "https://app.hesabfa.com/public/invoice?token=FT2bEEe134vmseXMK"
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/SaveWarehouseReceipt

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
deleteOldReceipts آیا رسید یا حواله‌های قدیمی برای این فاکتور حذف شوند؟
receipt Object اطلاعات حواله، با ساختار زیر:

* فیلدهای ستاره‌دار الزامی هستند.

*warehouseCode کد انبار
*invoiceNumber شماره فاکتور
*invoiceType نوع فاکتور ( جدول نوع فاکتور )
date تاریخ حواله
notes یادداشت و توضیحات
freight هزینه حمل
delivery تحویل (در محل انبار)
project پروژه
*items آرایه‌ای از اقلام حواله، شامل ساختار زیر:
*itemCode کد کالا
*quantity تعداد
reference ارجاع
notes توضیحات
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "deleteOldReceipts": true,
    "receipt": {
        "warehouseCode": 11,
        "invoiceNumber": 1004,
        "invoiceType": 0,
        "date": "2018-07-17",
        "notes": "",
        "freight": 0,
        "delivery": "",
        "project": "پروژه فروشگاه آنلاین",
        "items": [
            {
                "itemCode": 6,
                "quantity": 1,
                "reference": "PQ-1224",
                "notes": ""
            },
            {
                "itemCode": 7,
                "quantity": 2
            }
        ]
    }
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/SaveWarehouseReceipt \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "deleteOldReceipts": true,
    "receipt": {
        "warehouseCode": 11,
        "invoiceNumber": 1004,
        "invoiceType": 0,
        "date": "2018-07-17",
        "notes": "",
        "freight": 0,
        "delivery": "",
        "project": "پروژه فروشگاه آنلاین",
        "items": [
            {
                "itemCode": 6,
                "quantity": 1,
                "reference": "PQ-1224",
                "notes": ""
            },
            {
                "itemCode": 7,
                "quantity": 2
            }
        ]
    }
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'deleteOldReceipts' => true,
    'receipt' => [
        'warehouseCode' => 11,
        'invoiceNumber' => 1004,
        'invoiceType' => 0,
        'date' => '2018-07-17',
        'notes' => '',
        'freight' => 0,
        'delivery' => '',
        'project' => 'پروژه فروشگاه آنلاین',
        'items' => [
            [
                'itemCode' => 6,
                'quantity' => 1,
                'reference' => 'PQ-1224',
                'notes' => ''
            ],
            [
                'itemCode' => 7,
                'quantity' => 2
            ]
        ]
    ]
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/SaveWarehouseReceipt");
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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    deleteOldReceipts: true,
    receipt: {
        warehouseCode: 11,
        invoiceNumber: 1004,
        invoiceType: 0,
        date: "2018-07-17",
        notes: "",
        freight: 0,
        delivery: "",
        project: "پروژه فروشگاه آنلاین",
        items: [
            {
                itemCode: 6,
                quantity: 1,
                reference: "PQ-1224",
                notes: ""
            },
            {
                itemCode: 7,
                quantity: 2
            }
        ]
    }
};

fetch("https://api.hesabfa.com/v1/invoice/SaveWarehouseReceipt", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "deleteOldReceipts": True,
    "receipt": {
        "warehouseCode": 11,
        "invoiceNumber": 1004,
        "invoiceType": 0,
        "date": "2018-07-17",
        "notes": "",
        "freight": 0,
        "delivery": "",
        "project": "پروژه فروشگاه آنلاین",
        "items": [
            {
                "itemCode": 6,
                "quantity": 1,
                "reference": "PQ-1224",
                "notes": ""
            },
            {
                "itemCode": 7,
                "quantity": 2
            }
        ]
    }
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/SaveWarehouseReceipt",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    deleteOldReceipts = true,
    receipt = new
    {
        warehouseCode = 11,
        invoiceNumber = 1004,
        invoiceType = 0,
        date = "2018-07-17",
        notes = "",
        freight = 0,
        delivery = "",
        project = "پروژه فروشگاه آنلاین",
        items = new object[]
        {
            new
            {
                itemCode = 6,
                quantity = 1,
                reference = "PQ-1224",
                notes = ""
            },
            new
            {
                itemCode = 7,
                quantity = 2
            }
        }
    }
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/SaveWarehouseReceipt", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
نکات ضروری
  1. با فراخوانی این متد، رسید یا حوالۀ انبار برای فاکتور خرید یا فروش صادر می‌شود. اگر کالاهای فاکتور در چند انبار باشند، این متد را باید برای هر انبار یک بار فراخوانی کرد و در هر فراخوانی، کالاها و تعداد آن‌ها را به تفکیک همان انبار فرستاد.
  2. اگر deleteOldReceipts=true باشد، همۀ حواله‌های قبلی فاکتور حذف و حوالۀ جدید صادر می‌شود.
  3. همۀ اقلام باید از نوع کالا و دارای کنترل موجودی باشند؛ در غیر این صورت، حواله ثبت نمی‌شود.

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result در صورت موفقیت، Object حواله ذخیره‌شده یا ویرایش‌شده در Result قرار می‌گیرد. ساختار آن به شرح زیر است:
Id شناسه رسید یا حوالۀ انبار
Number شماره حوالۀ انبار
InvoiceNumber شماره فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode کد انبار
DestinationWarehouseCode کد انبار مقصد (فقط در حوالۀ انتقال)
Date تاریخ حواله
Notes یادداشت و توضیحات
Note یادداشت و توضیحات
Delivery تحویل (در محل انبار)
Freight هزینه حمل
Project پروژه
Receiving true: رسید ورود به انبار، false: حوالۀ خروج از انبار
Items آرایه‌ای از اقلام حواله. هر قلم ساختار زیر را دارد:
Id شناسه ردیف
ItemCode کد کالا
Reference ارجاع
Notes یادداشت و توضیحات
Item شی کالا یا خدمات
Note توضیحات
Quantity تعداد
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 1060,
        "Number": 1004,
        "InvoiceNumber": "1004",
        "InvoiceType": 0,
        "WarehouseCode": 11,
        "DestinationWarehouseCode": 0,
        "Date": "2018-06-07T00:00:00",
        "Notes": " حواله خروج از انبار - فاکتور فروش # 1004",
        "Delivery": "در محل انبار",
        "Freight": "توسط خودشان",
        "Project": "پروژه فروشگاه آنلاین",
        "Receiving": false,
        "Items": [
            {
                "Id": 2062,
                "ItemCode": "000006",
                "Reference": "PQ-1224",
                "Notes": "",
                "Item": {
                    "Id": 6,
                    "Code": "000006",
                    "Name": "کالای تست 1"
                },
                "Quantity": 1
            },
            {
                "Id": 2063,
                "ItemCode": "000007",
                "Reference": "",
                "Notes": "",
                "Item": {
                    "Id": 7,
                    "Code": "000007",
                    "Name": "کالای تست 2"
                },
                "Quantity": 2
            }
        ]
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/changePaidStatus

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
paid پرداخت شده
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0,
    "paid": true
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/changePaidStatus \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0,
    "paid": true
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'number' => 1001,
    'type' => 0,
    'paid' => true
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/changePaidStatus");
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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    number: 1001,
    type: 0,
    paid: true
};

fetch("https://api.hesabfa.com/v1/invoice/changePaidStatus", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0,
    "paid": True
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/changePaidStatus",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    number = 1001,
    type = 0,
    paid = true
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/changePaidStatus", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
نکات ضروری
  1. وضعیت پرداخت فقط در فاکتورهای تأییدشده قابل تغییر است.

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result Object اطلاعات فاکتور، با ساختار زیر:
Id شناسه فاکتور (برای سرویس دریافت با ID)
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سررسید فاکتور
ContactCode کد شخص
Contact Object اطلاعات شخص
ContactTitle عنوان شخص در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور)
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخصی که هزینه حمل به حساب او ثبت می‌شود
FreightPersonName نام شخصی که هزینه حمل به حساب او ثبت می‌شود
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Others آرایه‌ای از سایر هزینه‌ها و کسورات فاکتور؛ هر مورد: Title (عنوان)، Amount (مبلغ) و Add (true: به مبلغ فاکتور اضافه می‌شود، false: کسر می‌شود)
Currency واحد پول
CurrencyRate نرخ تبدیل ارز
TaxId کد منحصر به فرد مالیاتی
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور. هر قلم ساختار زیر را دارد:
Id شناسه ردیف فاکتور
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {
            "Code": "000001",
            "Name": "فروشگاه توحید"
        },
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": false,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": null,
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": ["974900098723"]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null,
        "Profit": 0
    }
}
Copyed
URL:https://api.hesabfa.com/v1/invoice/changeSentStatus

پارامترها :

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره فاکتور مورد نظر
type نوع فاکتور ( جدول نوع فاکتور)
sent ارسال شده
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0,
    "sent": true
}
Copyed
curl -X POST https://api.hesabfa.com/v1/invoice/changeSentStatus \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0,
    "sent": true
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'number' => 1001,
    'type' => 0,
    'sent' => true
];

$ch = curl_init("https://api.hesabfa.com/v1/invoice/changeSentStatus");
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);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    number: 1001,
    type: 0,
    sent: true
};

fetch("https://api.hesabfa.com/v1/invoice/changeSentStatus", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "number": 1001,
    "type": 0,
    "sent": True
}

response = requests.post(
    "https://api.hesabfa.com/v1/invoice/changeSentStatus",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    number = 1001,
    type = 0,
    sent = true
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/invoice/changeSentStatus", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
نکات ضروری
  1. وضعیت ارسال فقط در فاکتورهای تأییدشده قابل تغییر است.

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

Success
ErrorCode
ErrorMessage
(مشاهدۀ توضیحات)
Result Object اطلاعات فاکتور، با ساختار زیر:
Id شناسه فاکتور (برای سرویس دریافت با ID)
Number شماره فاکتور
Reference شماره ارجاع
Date تاریخ فاکتور
DueDate تاریخ سررسید فاکتور
ContactCode کد شخص
Contact Object اطلاعات شخص
ContactTitle عنوان شخص در فاکتور
Sum جمع مبلغ فاکتور
Payable مبلغ قابل پرداخت فاکتور
Paid مبلغ پرداخت شده فاکتور
Rest مبلغ باقیمانده فاکتور
Note یادداشت
Sent وضعیت ارسال فاکتور
Returned وضعیت برگشتی فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور)
Status وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag فیلد متنی قابل استفاده توسط برنامه‌نویس
Freight هزینه حمل
FreightPersonCode کد شخصی که هزینه حمل به حساب او ثبت می‌شود
FreightPersonName نام شخصی که هزینه حمل به حساب او ثبت می‌شود
WarehouseReceiptStatus وضعیت رسید یا حوالۀ انبار فاکتور( جدول وضعیت رسید یا حوالۀ انبار فاکتور )
Project پروژه
SalesmanCode کد فروشنده
SalesmanPercent درصد پورسانت فروشنده
Others آرایه‌ای از سایر هزینه‌ها و کسورات فاکتور؛ هر مورد: Title (عنوان)، Amount (مبلغ) و Add (true: به مبلغ فاکتور اضافه می‌شود، false: کسر می‌شود)
Currency واحد پول
CurrencyRate نرخ تبدیل ارز
TaxId کد منحصر به فرد مالیاتی
Profit سود فاکتور
InvoiceItems آرایه‌ای از اقلام فاکتور. هر قلم ساختار زیر را دارد:
Id شناسه ردیف فاکتور
RowNumber شماره ردیف
ItemCode کد کالا یا خدمات
Item شی کالا یا خدمات
Description شرح کالا یا خدمات
Unit واحد
Quantity تعداد یا مقدار
UnitPrice قیمت واحد
Sum تعداد * قیمت واحد
Discount تخفیف
Tax مالیات
TotalAmount مبلغ کل
SerialNumbers شماره سریال
Copyed
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": {
        "Id": 2,
        "Number": "1001",
        "Reference": "",
        "Date": "2024-07-17T00:00:00",
        "DueDate": "2024-07-17T00:00:00",
        "ContactCode": "000001",
        "Contact": {
            "Code": "000001",
            "Name": "فروشگاه توحید"
        },
        "ContactTitle": "فروشگاه توحید",
        "Sum": 109000.0,
        "Payable": 1649000.0,
        "Paid": 109000.0000,
        "Rest": 1540000.0000,
        "Freight": 0.0,
        "FreightPersonCode": "",
        "FreightPersonName": "",
        "Note": "",
        "Sent": true,
        "Returned": false,
        "InvoiceType": 0,
        "Status": 1,
        "InvoiceItems": [
            {
                "Id": 408,
                "RowNumber": 0,
                "Description": "Galaxy J7 گوشی سامسونگ",
                "ItemCode": null,
                "Item": null,
                "Quantity": 1.0,
                "Unit": "عدد",
                "UnitPrice": 100000.0,
                "Sum": 100000.0,
                "Discount": 0.0,
                "Tax": 9000.0,
                "TotalAmount": 109000.0,
                "SerialNumbers": ["974900098723"]
            }
        ],
        "Tag": "API",
        "WarehouseReceiptStatus": 0,
        "Project": "",
        "SalesmanCode": "",
        "SalesmanPercent": 30.0,
        "Others": [
            {
                "Title": "هزینه‌های گمرکی",
                "Amount": 1540000.0,
                "Add": true
            }
        ],
        "Currency": "IRR",
        "CurrencyRate": 1.0,
        "TaxId": null,
        "Profit": 0
    }
}