متدهای ثبت سند حسابداری در Api نرم افزار حسابداری آنلاین حسابفا

دریافت

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

Request
Response

پارامترها:

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

number شماره سند مورد نظر

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

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

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

Result در صورت موفقیت آمیز بودن، Object سند مورد نظر درون Result قرار می گیرد.

Number	شماره سند
Reference	ارجاع
Date	تاریخ
Description	توضیحات
Project	پروژه
Debit	بدهکار
Credit	بستانکار
Status	وضعیت سند(جدول وضعیت سند)
Transactions	آرایه ای از تراکنش های موجود در سند. هر تراکنش شامل ساختار زیر می باشد:

AccountPath	حساب
Description	توضیحات
Info	اطلاعات اضافه
Amount	مبلغ
CurrencyAmount	مبلغ در صورت چند ارزی بودن
Currency	واحد پول
Type	نوع تراکنش(جدول نوع تراکنش)
ContactCode	کد شخص
ProductCode	کد کالا
BankCode	کد بانک
CashCode	کد صندوق
PettyCashCode	کد تنخواه گردان

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Id": 2497,
        "Number": 415,        
        "Reference": 441,          
        "Date": "2022-11-26T00:00:00",       
        "Description": "تست API",       
        "Project": "",       
        "Debit": 1000.0000,  
        "Credit": 1000.0000,       
        "Status": 1,        
        "Transactions": [      
            {
                "Id": 14572,
                "AccountPath": "بدهی ها : بدهیهای جاری : پیش دریافت ها : پیش دریافت فروش",           
                "Description": "تست API",          
                "Info": "",           
                "Amount": 1000.0000,             
                "CurrencyAmount": 1000.0000,         
                "Currency": "IRR",             
                "Type": 1,             
                "ContactCode": "000001",         
                "ProductCode": "",                
                "BankCode": "",                
                "CashCode": "",                 
                "PettyCashCode": ""              
            },
            {
                "Id": 14573,
                "AccountPath": "دارایی ها : دارایی های جاری : موجودی نقد و بانک : صندوق",
                "Description": "تست API",
                "Info": "",
                "Amount": 1000.0000,
                "CurrencyAmount": 1000.0000,
                "Currency": "IRR",
                "Type": 0,
                "ContactCode": "",
                "ProductCode": "",
                "BankCode": "",
                "CashCode": "0001",
                "PettyCashCode": ""
            }
        ]
    }
}

ذخیره

URL: https://api.hesabfa.com/v1/document/save

Request
Response

پارامترها:

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

document Object نگهدارنده اطلاعات سند می باشد.هر Object شامل ساختار زیر می باشد:

number	شماره سند
reference	ارجاع
date	تاریخ
description	توضیحات
project	پروژه
debit	بدهکار
credit	بستانکار
status	وضعیت سند(جدول وضعیت سند)
transactions	آرایه ای از تراکنش های موجود در سند. هر تراکنش شامل ساختار زیر می باشد:

accountPath	حساب
description	توضیحات
info	اطلاعات اضافه
amount	مبلغ
currencyAmount	مبلغ در صورت چند ارزی بودن
currency	واحد پول
type	نوع تراکنش (جدول نوع تراکنش)
contactCode	کد شخص
productCode	کد کالا
bankCode	کد بانک
cashCode	کد صندوق
pettyCashCode	کد تنخواه گردان

{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
     "document": {
        "number": 415,
        "reference": 441,
        "date": "2022-11-26T00:00:00",
        "description": "پیش دریافت وجه از آقای محمدی",
        "project": "",
        "debit": 1000.0,
        "credit": 1000.0,
        "status": 1,
        "transactions": [
            {
                "accountPath": "بدهی ها : بدهیهای جاری : پیش دریافت ها : پیش دریافت فروش",
                "description": "پیش دریافت وجه از آقای محمدی",
                "info": "",
                "amount": 1000.0,
                "currencyAmount": 1000.0,
                "currency": "IRR",
                "type": 1,
                "contactCode": "000001",
                "productCode": "",
                "bankCode": "",
                "cashCode": "",
                "pettyCashCode": ""
            },
            {
                "accountPath": "دارایی ها : دارایی های جاری : موجودی نقد و بانک : صندوق",
                "description": "پیش دریافت وجه از آقای محمدی",
                "info": "",
                "amount": 1000.0,
                "currencyAmount": 1000.0,
                "currency": "IRR",
                "type": 0,
                "contactCode": "",
                "productCode": "",
                "bankCode": "",
                "cashCode": "0001",
                "pettyCashCode": ""
            }
        ]
    }
}

نکات ضروری

اگر شماره سند ذکر شود، سند انتخاب شده ویرایش خواهد شد. توجه کنید که تنها اسناد دستی قابل ذخیره و ویرایش هستند.
در صورتی که تفصیل حساب انتخاب شده شخص باشد فیلد کد شخص، اگر کالا باشد فیلد کد کلا، اگر بانک باشد فیلد کد بانک، اگر صندوق باشد فیلد کد صندوق و اگر تنخواه گردان باشد فیلد کد تنخواه گردان برای هر تراکنش باید پر باشد.
بدیهی است که سایر کدها برای آن تراکنش باید خالی باشند.
برای ثبت تراکنش ارزی، در فیلد currencyAmount مبلغ ارزی تراکنش و در فیلد amount مبلغ تراکنش به ارز پایه سیستم باید ثبت شود.
حداقل دو تراکنش باید در سند ثبت شود. اگر وضعیت سند را تایید شده انتخاب کنید، سند حتما باید تراز باشد.

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

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

Result در صورت موفقیت آمیز بودن، Object سند ذخیره شده یا ویرایش شده درون Result قرار می گیرد.

Number	شماره سند
Reference	ارجاع
Date	تاریخ
Description	توضیحات
Project	پروژه
Debit	بدهکار
Credit	بستانکار
Status	وضعیت سند(جدول وضعیت سند)
Transactions	آرایه ای از تراکنش های موجود در سند. هر تراکنش شامل ساختار زیر می باشد:

AccountPath	حساب
Description	توضیحات
Info	اطلاعات اضافه
Amount	مبلغ
CurrencyAmount	مبلغ در صورت چند ارزی بودن
Currency	واحد پول
Type	نوع تراکنش (جدول نوع تراکنش)
ContactCode	کد شخص
ProductCode	کد کالا
BankCode	کد بانک
CashCode	کد صندوق
PettyCashCode	کد تنخواه گردان

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "Id": 2497,
        "Number": 415,
        "Reference": 441,
        "Date": "2022-11-26T00:00:00",
        "Description": "پیش دریافت وجه از آقای محمدی",
        "Project": "",
        "Debit": 1000.0,
        "Credit": 1000.0,
        "Status": 1,
        "Transactions": [
            {
                "Id": 14572,
                "AccountPath": "بدهی ها : بدهیهای جاری : پیش دریافت ها : پیش دریافت فروش",
                "Description": "پیش دریافت وجه از آقای محمدی",
                "Info": "",
                "Amount": 1000.0,
                "CurrencyAmount": 1000.0,
                "Currency": "IRR",
                "Type": 1,
                "ContactCode": "000001",
                "ProductCode": "",
                "BankCode": "",
                "CashCode": "",
                "PettyCashCode": ""
            },
            {
                "Id": 14573,
                "AccountPath": "دارایی ها : دارایی های جاری : موجودی نقد و بانک : صندوق",
                "Description": "پیش دریافت وجه از آقای محمدی",
                "Info": "",
                "Amount": 1000.0,
                "CurrencyAmount": 1000.0,
                "Currency": "IRR",
                "Type": 0,
                "ContactCode": "",
                "ProductCode": "",
                "BankCode": "",
                "CashCode": "0001",
                "PettyCashCode": ""
            }
        ]
    }
}

دریافت لیست

URL: https://api.hesabfa.com/v1/document/getdocuments

Request
Response

پارامترها:

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

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

{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    queryInfo:{
        sortBy: 'Date',
        sortDesc: true,
        take: 20,
        skip: 0
    }
}

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

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

Result درون فیلد result آرایه ای از سندها قرار میگیرد.

TotalCount	تعداد کل
FilteredCount	تعداد فیلتر شده
From	شماره ردیف شروع
To	شماره ردیف خاتمه
List	لیستی از Objectهای نگهدارنده اطلاعات سند می باشد.هر Object سند شامل ساختار زیر می باشد:

Number	شماره سند
Reference	ارجاع
Date	تاریخ
Description	توضیحات
Project	پروژه
Debit	بدهکار
Credit	بستانکار
Status	وضعیت سند(جدول وضعیت سند)
Transactions	تراکنش ها

{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
        "TotalCount": 22,
        "FilteredCount": 22,
        "From": 1,
        "To": 10,
        "List": [
            {
                "Id": 2497,
                "Number": 415,
                "Reference": 441,
                "Date": "2022-11-26T00:00:00",
                "Description": "پیش دریافت وجه از آقای محمدی",
                "Project": "",
                "Debit": 1000.0000,
                "Credit": 1000.0000,
                "Status": 1,
                "Transactions": []
            },
            {...},
            {...}
                ]
}

حذف سند

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

Request
Response

پارامترها:

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

number شماره سند

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

نکات ضروری

توجه کنید که فقط اسناد دستی قابل حذف هستند.

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

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

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

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

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

دریافت

ذخیره

دریافت لیست

حذف سند