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

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

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

پارامترها:

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره رسید یا حواله
Copyed 
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     number: 1002            
 }

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

Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result object از رسید یا حواله. شامل ساختار زیر می باشد:
Number شماره رسید یا حواله
InvoiceNumber شماره فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode کد انبار
DestinationWarehouseCode کد حوالۀ انتقال
Date تاریخ حواله
Notes یادداشت و توضیحات
Delivery تحویل
Freight حمل و نقل
Project پروژه
Receiving دریافت شده (رسید ورود به انبار یا حواله خروج از انبار)
Items آرایه‌ای از اقلام حواله، شامل ساختار زیر:
ItemCode کد کالا
Reference ارجاع
Notes توضیحات
Item کالا
Code کد کالا
Name نام کالا
Quantity تعداد
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: {
         { 
            "Id": 6, 
            "Number": 1002, 
            "InvoiceNumber": "1007",
            "InvoiceType": 0,
            "WarehouseCode": 11,
            "DestinationWarehouseCode": 0,
            "Date": "2016-08-27T00:00:00",
            "Notes": "حواله خروج از انبار - فاکتور فروش # 1007",
            "Delivery": "",
            "Freight": "",
            "Project": "",
            "Receiving": false,
        }, 
        "Items":[
        {
            "Id": 43,            
            "ItemCode": "000002", 
            "Reference": 12, 
            "Notes": "توضیحات",
            "Item": {
                "Id": 34,
                "Code": "000002",
                "Name": "کالای تست 1",
                ...
        },
            "Quantity":1.000000            
        }, 
        … 
    }
}
Copyed
URL: https://api.hesabfa.com/v1/warehouse/GetById

پارامترها:

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
id id رسید و حوالۀ انبار
idList لیست id های رسید و حوالۀ انبار
Copyed 
{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     id: 23,
     idList: [23,24,25]            
 }
نکات ضروری
    یکی از پارامترهای id یا idList ارسال شود.

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

Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result آرایه‌ای از رسید با حواله‌های موجود می باشد. هر رسید یا حواله شامل ساختار زیر می باشد:
Number شماره رسید یا حواله
InvoiceNumber شماره فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode کد انبار
DestinationWarehouseCode کد حوالۀ انتقال
Date تاریخ حواله
Notes یادداشت و توضیحات
Delivery تحویل
Freight حمل و نقل
Project پروژه
Receiving دریافت شده (رسید ورود به انبار یا حواله خروج از انبار)
Items آرایه‌ای از اقلام حواله
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": [
        {
            "Id": 23,
            "Number": 1019,
            "InvoiceNumber": "",
            "InvoiceType": 1,
            "WarehouseCode": 11,
            "DestinationWarehouseCode": 0,
            "Date": "2016-08-27T00:00:00",
            "Notes": "رسید ورود به انبار - فاکتور خرید - ارجاع: 456456",
            "Delivery": "",
            "Freight": "",
            "Project": "",
            "Receiving": true,
            "Items": [
             {…
             }
            ]
        },
        {…},
        {…}
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/warehouse/getReceipts

پارامترها:

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
type نوع رسید یا حوالۀ انبار ( جدول نوع حوالۀ انبار )
queryInfo Object فیلتر و مرتب‌سازی (مشاهدۀ توضیحات)
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    type: 1,
      queryInfo:{
        sortBy: 'Date',
        sortDesc: true,
        take: 20,
        skip: 0
    }
}

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

Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result آرایه‌ای از رسید یا حواله‌های موجود می باشد. هر رسید یا حواله شامل ساختار زیر می باشد:
Number شماره رسید یا حواله
InvoiceNumber شماره فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode کد انبار
DestinationWarehouseCode کد حوالۀ انتقال
Date تاریخ حواله
Notes یادداشت و توضیحات
Delivery تحویل
Freight حمل و نقل
Project پروژه
Receiving دریافت شده (رسید ورود به انبار یا حواله خروج از انبار)
Items آرایه‌ای از اقلام حواله:
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": [
        {
            "Id": 23,
            "Number": 1019,
            "InvoiceNumber": "",
            "InvoiceType": 1,
            "WarehouseCode": 11,
            "DestinationWarehouseCode": 0,
            "Date": "2016-08-27T00:00:00",
            "Notes": "رسید ورود به انبار - فاکتور خرید - ارجاع: 456456",
            "Delivery": "",
            "Freight": "",
            "Project": "",
            "Receiving": true,
            "Items": [
             {…
             }
            ]
        },
        {…
        },
        {…
        }
    ]
}
Copyed
URL: https://api.hesabfa.com/v1/warehouse/save

پارامترها:

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
* آیتم‌های ستاره دار ضروری هستند.
deleteOldReceipts آیا رسید یا حواله‌های قدیمی برای این فاکتور حذف شوند؟
receipt
number شماره رسید یا حواله
invoiceNumber شماره فاکتور
*invoiceType نوع فاکتور ( جدول نوع فاکتور )
warehouseCode کد انبار
destinationWarehouseCode کد حوالۀ انتقال
date تاریخ حواله
notes یادداشت و توضیحات
delivery تحویل
freight هزینه حمل
project پروژه
receiving دریافت شده (رسید ورود به انبار یا حواله خروج از انبار
items آرایه‌ای از اقلام حواله، شامل ساختار زیر
itemCode کد کالا
quantity تعداد
reference ارجاع
notes توضیحات
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    deleteOldReceipts: true,
      "receipt": 
        {
            "number": 1019,
            "invoiceNumber": "",
            "invoiceType": 1,
            "warehouseCode": 11,
            "destinationWarehouseCode": 11,
            "date": "2016-08-27T00:00:00",
            "notes": "رسید ورود به انبار - فاکتور خرید - ارجاع: 456456",
            "delivery": "",
            "freight": 0,
            "project": "	هزینه حمل",
            "receiving": true,
            "items": [
             { 
              itemCode: 6,
              quantity: 1,
              reference: 'PQ-1224',
              notes: ""
             },
             { 
              itemCode: 7,
              quantity: 2,
             },
              ...
            ]
        }
    }
نکات ضروری
  1. با فراخوانی این متد رسید یا حوالۀ انبار برای فاکتور خرید یا فروش صادر می گردد. در صورتی که کالاهای فاکتور در چندین انبار مختلف وجود داشته باشند به ازای هر انبار باید یکبار این متد را فراخوانی کرد و در هر فراخوانی کالاها و تعداد مورد نیاز به تفکیک انبار ذکر گردد.
  2. در صورتی که مقدار پارامتر deleteOldReceipts=true باشد، کلیه حواله‌های قبلی صادر شده برای فاکتور حذف خواهند شد و حواله جدید صادر می‌شود.
  3. کلیه آیتم‌های باید از نوع کالا و با قابلیت کنترل موجودی باشند در غیر اینصورت حواله ثبت نخواهد شد.
  4. در صورتی که فیلد destinationWarehouseCode دارای مقدار باشد، فیلدهای شماره و نوع فاکتور نادیده گرفته می شوند و حوالۀ انتقال صادر خواهد شد.

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

Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن، Object رسید یا حواله ذخیره شده یا ویرایش شده درون Result قرار می گیرد.:
Number شماره رسید یا حواله
InvoiceNumber شماره فاکتور
InvoiceType نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode کد انبار
DestinationWarehouseCode کد حوالۀ انتقال
Date تاریخ حواله
Notes یادداشت و توضیحات
Delivery تحویل
Freight حمل و نقل
Project پروژه
Receiving دریافت شده (رسید ورود به انبار یا حواله خروج از انبار
Items آرایه‌ای از اقلام حواله، شامل ساختار زیر:
ItemCode
Reference ارجاع
Notes توضیحات
Item کالا
Code کد کالا
Name نام کالا
Quantity تعداد
Copyed 
{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": "",
    "Result": [
        {
            "Id": 23,
            "Number": 1019,
            "InvoiceNumber": "",
            "InvoiceType": 1,
            "WarehouseCode": 11,
            "DestinationWarehouseCode": 0,
            "Date": "2016-08-27T00:00:00",
            "Notes": "رسید ورود به انبار - فاکتور خرید - ارجاع: 456456",
            "Delivery": "",
            "Freight": "",
            "Project": "",
            "Receiving": true,
            "Items": [
             {…
             }
            ]
        },
        {…
        },
        {…
        }
    ]
}
Copyed
URL:https://api.hesabfa.com/v1/warehouse/delete

پارامترها:

apiKey
userId
password
loginToken 		پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
number شماره رسید یا حواله مورد نظر
Copyed 
{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    number: 1001,
}

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

Success
ErrorCode
ErrorMessage
 (مشاهدۀ توضیحات)
Result در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد.
Copyed 
{
    Success: true,
    ErrorCode: 0,
    ErrorMessage: "",
    Result: true
}