فاکتور

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

apiKey userId password loginToken

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

id	Id فاکتور مورد نظر

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

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

apiKey userId password loginToken

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

type	نوع فاکتور ( جدول نوع فاکتور )

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

queryInfo

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

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	loginToken: 'f6b912...45fdc',
	type: 0,
	queryInfo:{
		SortBy: 'Date',
		SortDesc: true,
		Take: 20,
		Skip: 0
	}
} 

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

Success ErrorCode ErrorMessage

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

Result

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

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

Number	شماره فاکتور
Reference	شماره ارجاع
Date	تاریخ فاکتور
DueDate	تاریخ سررسید فاکتور
ContactCode	کد شخص
Contact	Object مشخصات شخص
ContactTitle	عنوان شخص در فاکتور
Sum	جمع مبلغ فاکتور
Payable	مبلغ قابل پرداخت فاکتور
Paid	مبلغ پرداخت شده فاکتور
Rest	مبلغ باقیمانده فاکتور
Note	یادداشت
Sent	وضعیت ارسال فاکتور
Returned	وضعیت برگشتی فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور)
Status	وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag	فیلد متنی قابل استفاده توسط برنامه نویس
Freight	هزینه حمل
WarehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
Project	پروژه
SalesmanCode	کد فروشنده
SalesmanPercent	درصد پورسانت فروشنده
Currency	واحد پول

{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: {
		TotalCount:2,         
		FilteredCount:2,     
		From:1,               
		To:2,                
		List:[{               
			Number: '1002',
			Reference: '',
			Date: '2018-07-19 14:22:50',
			DueDate: '2018-07-19 14:22:50',
			ContactCode: '000001',
			Contact: {...}
			ContactTitle: 'سعید محمدی',
			Sum: '228000',
			Payable: '228000',
			Paid: 0,
			Rest: 228000,
			Note: '',
			Sent: false,
			Returned: false,
			InvoiceType: 0,
			Status: 2,
			Tag: '',
			Freight: 0,
			WarehouseReceiptStatus: 1,
			Project: 'پروژه یک',
			SalesmanCode: 10001,
                   SalesmanPercent: 30,
                   Currency: 'IRR',

		},{
			Number: '1001',
			Reference: '',
			Date: '2018-07-17 17:30:12',
			DueDate: '2018-07-17 17:30:12',
			ContactCode: '000001',
			Contact: {...}
			ContactTitle: 'سعید محمدی',
			Sum: '109000',
			Payable: '109000',
			Paid: 0,
			Rest: 109000,
			Note: '',
			Sent: false,
			Returned: false,
			InvoiceType: 0,
			Status: 2,
			Tag: '',
			Freight: 0,
			WarehouseReceiptStatus: 1,
			Project: 'پروژه یک',
			SalesmanCode: 10001,
                   SalesmanPercent: 30,
                   Currency: 'IRR',

		}]
	}
} 

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

apiKey userId password loginToken

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

invoice

Object نگهدارنده اطلاعات فاکتور می باشد.هر Object شامل ساختار زیر می باشد: * آیتم های ستاره دار ضروری هستند.

Number	شماره فاکتور در صورتی که شماره فاکتور را وارد نکنید، فاکتور با شماره اتوماتیک ذخیره می شود. در صورتی که شماره فاکتور وارد شود و موجود باشد، اطلاعات ویرایش می شود. در صورتی که شماره فاکتور وارد شود و موجود نباشد، فاکتور با آن شماره ذخیره خواهد شد.
Reference	شماره ارجاع
*Date	تاریخ فاکتور
*DueDate	تاریخ سر رسید فاکتور
*ContactCode	کد شخص
ContactTitle	عنوان مشتری/فروشنده در فاکتور
Note	یادداشت
Sent	وضعیت ارسال فاکتور
*InvoiceType	نوع فاکتور ( جدول نوع فاکتور )
Status	وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag	فیلد متنی قابل استفاده توسط برنامه نویس
Freight	هزینه حمل
WarehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
Project	پروژه
SalesmanCode	کد فروشنده
SalesmanPercent	درصد پورسانت فروشنده
InvoiceItems	آرایه ای از اقلام فاکتور، شامل ساختار زیر:

RowNumber	شماره ردیف
*Description	توضیحات کالا یا خدمات
*ItemCode	کد کالا یا خدمات
Unit	واحد کالا
*Quantity	تعداد یا مقدار
*UnitPrice	قیمت واحد
*Discount	تخفیف
*Tax	مالیات
Others	آرایه ای از اضافات و کسورات فاکتور، شامل ساختار زیر:

Title	عنوان اضافات و کسورات
Amount	مقدار اضافات و کسورات
Add	true:اضافات false:کسورات

Currency	واحد پول
CurrencyRate	نرخ برابری ارز به ارز پایه

{
    apiKey: 'asdfASR^%FDHdsfg456',
    userId: 'mail@example.com',
    password: '123456',
    loginToken: 'f6b912...45fdc',
    invoice:{
       Number: '1001',
       Reference: '',
       Date: '2018-07-17 17:30:12',
       DueDate: '2018-07-17 17:30:12',
       ContactCode: '000001',
       ContactTitle: 'سعید محمدی',
       Note: '',
       Sent: false,
       InvoiceType: 0,
       Status: 2,
       Tag: '',
       Freight: 0,
       WarehouseReceiptStatus: 1,
       Project: 'پروژه یک',
       SalesmanCode: 10001,
       SalesmanPercent: 30,
       Currency: 'IRR',
       InvoiceItems: [{
           RowNumber: 1,
           Description: 'Galaxy J7 گوشی سامسونگ',
           ItemCode: '0000001',
           Unit: 'عدد',
           Quantity: 1,
           UnitPrice: 100000,
           Discount: 0,
           Tax: 9000
       }],
     Others : [
        {
           "Title": "هزینه های گمرکی",
           "Amount": 1540000.0,
           "Add": true 
        }
    ],
     Currency: "IRR",
     CurrencyRate: 1.0000000000
   }
} 

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

Success ErrorCode ErrorMessage

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

Result

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

Number	شماره فاکتور
Reference	شماره ارجاع
Date	تاریخ فاکتور
DueDate	تاریخ سر رسید فاکتور
ContactCode	کد شخص
ContactTitle	عنوان مشتری/فروشنده در فاکتور
Sum	جمع مبلغ فاکتور
Payable	مبلغ قابل پرداخت فاکتور
Paid	مبلغ پرداخت شده فاکتور
Rest	مبلغ باقیمانده فاکتور
Note	یادداشت
Sent	وضعیت ارسال فاکتور
Returned	وضعیت برگشتی فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور )
Status	وضعیت فاکتور ( جدول وضعیت فاکتور )
Tag	فیلد متنی قابل استفاده توسط برنامه نویس
Freight	هزینه حمل
WarehouseReceiptStatus	وضعیت رسید یا حواله انبار فاکتور( جدول وضعیت رسید یا حواله انبار فاکتور )
Project	پروژه
SalesmanCode	کد فروشنده
SalesmanPercent	درصد پورسانت فروشنده
InvoiceItems	آرایه ای از اقلام فاکتور، شامل ساختار زیر:

RowNumber	شماره ردیف
Description	شرح کالا یا خدمات
ItemCode	کد کالا یا خدمات
Unit	واحد کالا
Quantity	تعداد یا مقدار
UnitPrice	قیمت واحد
Sum	سرجمع قیمت بدون تخفیف و مالیات
Discount	تخفیف
Tax	مالیات
TotalAmount	مبلغ کل با احتساب تخفیف و مالیات

{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: {
		Number: '1001',
		Reference: '',
		Date: '2018-07-17 17:30:12',
		DueDate: '2018-07-17 17:30:12',
		ContactCode: '000001',
		Contact: {...}
		ContactTitle: 'سعید محمدی',
		Sum: '109000',
		Payable: '109000',
		Paid: 0,
		Rest: 109000,
		Note: '',
		Sent: false,
		Returned: false,
		InvoiceType: 0,
		Status: 2,
		Tag: '',
		Freight: 0,
		WarehouseReceiptStatus: 1,
		Project: 'پروژه یک',
           SalesmanCode: 10001,
           SalesmanPercent: 30,
           Currency: 'IRR',
		InvoiceItems: [{
			RowNumber: 1,
			Description: 'Galaxy J7 گوشی سامسونگ',
			ItemCode: '0000001',
			Item: {...}
			Unit: 'عدد',
			Quantity: 1,
			UnitPrice: 100000,
			Sum: 100000,
			Discount: 0,
			Tax: 9000,
			TotalAmount: 109000
		}]
	}
} 

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

apiKey userId password loginToken

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

number	شماره فاکتور مورد نظر
type	نوع فاکتور ( جدول نوع فاکتور)

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

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

Success ErrorCode ErrorMessage

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

Result

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

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

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

apiKey userId password loginToken

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

type	نوع فاکتور ( جدول نوع فاکتور)
number	شماره فاکتور فروش
bankCode	کد بانک
date	تاریخ تراکنش
amount	مبلغ تراکنش
transactionNumber	شماره تراکنش
description	توضیحات تراکنش
transactionFee	هزینه یا کارمزد تراکنش
Currency	واحد پول
CurrencyRate	نرخ برابری ارز به ارز پایه
CashCode	کد صندوق
PettyCashCode	کد تنخواه گردان

{
	apiKey: 'asdfASR^%FDHdsfg456',
	userId: 'mail@example.com',
	password: '123456',
	loginToken: 'f6b912...45fdc',
	type: 0,
	number: 1001,
	bankCode: '0001',
	date: '2018-07-17 17:32:11',
	amount: 109000,
	transactionNumber: '255496387',
	description: 'پرداخت آنلاین',
	transactionFee: 0
} 

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

Success ErrorCode ErrorMessage

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

Result

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

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

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

apiKey userId password loginToken

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

number	شماره فاکتور مورد نظر
type	نوع فاکتور ( جدول نوع فاکتور)

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

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

Success ErrorCode ErrorMessage

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

Result

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

{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: '',
	Result: "https://app.hesabfa.com/public/invoice?token=FT2bEEe134vmseXMK"
} 

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

apiKey userId password loginToken

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

deleteOldReceipts	آیا رسید یا حواله های قدیمی برای این فاکتور حذف شوند؟
receipt	Object نگهدارنده اطلاعات حواله می باشد.هر Objectشامل ساختار زیر می باشد : * آیتم های ستاره دار ضروری هستند.

*WarehouseCode	کد انبار
*InvoiceNumber	شماره فاکتور
*InvoiceType	نوع فاکتور ( جدول نوع فاکتور )
Date	تاریخ حواله
Note	یادداشت و توضیحات
Freight	هزینه حمل
Delivery	تحویل (در محل انبار)
Project	پروژه
*Items	آرایه ای از اقلام حواله، شامل ساختار زیر:

*ItemCode	کد کالا
*Quantity	تعداد
Reference	ارجاع
Note	توضیحات

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     loginToken: 'f6b912...45fdc',
     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,
		},
		...
		]
	}
} 

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

Success ErrorCode ErrorMessage

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

Result

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

Number	شماره حواله انبار
InvoiceNumber	شماره فاکتور
InvoiceType	نوع فاکتور ( جدول نوع فاکتور )
WarehouseCode	کد انبار
Date	تاریخ حواله
Note	یادداشت و توضیحات
Delivery	تحویل (در محل انبار)
Freight	هزینه حمل
Project	پروژه
Items	آرایه ای از اقلام حواله، شامل ساختار زیر:

ItemCode	کد کالا
Reference	ارجاع
Note	توضیحات
Quantity	تعداد

{
	Success: true,
	ErrorCode: 0,
	ErrorMessage: "",
	Result: {
        "Id": 1060, 
        "Number": 1004, 
        "InvoiceNumber": "1004",
        "InvoiceType": 0, 
        "WarehouseCode": 11, 
        "Date": "2018-06-07T00:00:00", 
        "Notes": " حواله خروج از انبار - فاکتور فروش # 1004", 
        "Delivery": "در محل انبار", 
        "Freight": "توسط خودشان", 
        "Project": 'پروژه فروشگاه آنلاین',
        "Items": [ 
            { 
                "Id": 2062, 
                "ItemCode": “000006”, 
                "Reference": "PQ-1224", 
                "Notes": "", 
                "Item": {…}, 
                "Quantity": 1.0 
            }, 
            { 
                "Id": 2063, 
                "ItemCode": “000007”, 
                "Reference": "", 
                "Notes": "", 
                "Item": {…}, 
                "Quantity": 2.0 
            } 
        ] 
    } 
}