فاکتور



متد ها :

POST /invoices ایجاد فاکتور جدید

ایجاد فاکتور

ایجاد فاکتور جدید برای یک مشتری .

POST /invoices

محتوی درخواست (Body parameters)

title نوع:String عنوان:عنوان فاکتور عنوان فاکتور در پیام های ارسالی به کاربر نمایش داده می شود.
number نوع:String عنوان:شماره فاکتور شماره فاکتور به صورت پیش فرض برای هر فاکتور ایجاد می شود اما امکان تنظیم آن به صورت دلخواه هم وجود دارد .
date نوع:Timestamp عنوان:تاریخ فاکتور تاریخ فاکتور یک رشته عددی به صورت timestamp است که قبل از آن فاکتور برای مشتری در دسترس نخواهد بود .
due نوع:Timestamp عنوان:تاریخ سررسید تاریخ سررسید فاکتور یک رشته عددی به صورت timestamp است که فاکتور بعد از آن قابل پرداخت نخواهد بود .
online_payment نوع:Boolean عنوان:پرداخت آنلاین با قرار دادن مقدار 1 در این پارامتر پرداخت آنلاین برای فاکتور فعال خواهد شد.* توجه : برای استفاده از این قابلیت کاربر باید بسته فعال داشته باشد.
note نوع:String عنوان:یادداشت یادداشت فاکتور متنی است که زیر فاکتور نمایش داده خواهد شد و معمولا شرایط و قوانین فروش را دربر میگیرد .
theme_id نوع:Integer عنوان:قالب فاکتور به صورت پیش فرض قالب فاکتور بروی قالب مدرن با شناسه 1 تنظیم می شود و برای انتخاب یک قالب دیگر این مقدار را برابر با شناسه قالب دیگر قرار می دهیم، برای مثال برای فاکتور رسمی مقدار را برابر با 2 تنظیم می کنیم. * توجه : برای استفاده از این قابلیت کاربر باید بسته فعال داشته باشد.
  • 1 : مدرن
  • 2 : فاکتور رسمی
  • 3 : فیش
  • 4 : کاربن
auto_send نوع:Array عنوان:ارسال خودکار به صورت پیش فرض فاکتور به صورت ایمیل و پیامک برای مشتری ارسال می شود .
email نوع:Boolean عنوان:ارسال ایمیل ارسال فاکتور به صورت ایمیل برای مشتری . ایمیل یادآوری فقط در صورت فعال بودن این مقدار ارسال می شود .
sms نوع:Boolean عنوان:ارسال پیامک ارسال لینک فاکتور به صورت پیامک برای مشتری . پیامک یادآوری فقط در صورت فعال بودن این مقدار ارسال می شود .
Customer نوع:Array عنوان:مشتری مشتری باید قبل از صدور فاکتور ذخیره شده باشد * توجه : وجود یکی از پارامتر های زیر ضروری است
id نوع:String عنوان:شناسه مشتری شناسه مشتری یک رشته ۳۶ کاراکتری است .
email نوع:String عنوان:ایمیل مشتری ایمیل مشتری باید منحصر به فرد باشد .
mobile نوع:Integer عنوان:موبایل مشتری شماره موبایل مشتری یک عدد ۱۱ رقمی است و باید به منحصر به فرد باشد .
Item نوع:Array عنوان:محصول نیازی نیست محصولات از قبل تعریف شده باشد اما برای محصولات تعریف نشده پر کردن مشخصات اصلی لازم است و برای محصولات از پیش تعریف شده شناسه محصول کافی است . * توجه : برای محصول از قبل تعریف نشده این موارد ضروری هستند :
  • description
  • cost
  • quantity
id نوع:String عنوان:شناسه محصول شناسه محصول یک رشته ۳۶ کاراکتری است .
description نوع:String عنوان:شرح محصول شرح محصول نام کالا و یا خدمتی است که در هر یک از ردیف های جدول فاکتور قرار می گیرد .
cost نوع:Integer عنوان:قیمت محصول قیمت محصول به ریال به صورت عددی .
quantity نوع:Integer عنوان:تعداد محصول تعداد محوصل به صورت عددی .
tax نوع:Integer عنوان:تخفیف محصول درصد مالیاتی که به محصول تعلق می گیرد .
discount نوع:Integer عنوان:تخفیف محصول درصد تخفیفی که به محصول تعلق میگیرد .
code نوع:String عنوان:کد محصول کد محصول یک شناسه منحصر به فرد است که کاربر به دلخوله انتخاب خود کرده است .

نمونه کد درخواست

                        curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"title":"لپ تاپ","Customer":{"email":"[email protected]"},"Item":[{"description":"لپ تاپ macbook", "cost":3750000, "quantity":1, "discount":11, "tax":9}]}' "https://api.hesabit.com/v1/invoices/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"
                    

نمونه پاسخ

                        
HTTP/1.1 201 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": {
        "Item": [
            {
                "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                "cost": "27800000",
                "quantity": 1,
                "total": 27800000,
                "discount": 10,
                "tax": 9,
                "description": "لپ تاپ",
                "code": "1ab"
            }
        ],
        "Invoice": {
            "id": "57151ea8-1540-429b-8a68-49ef2e65ec41",
            "title": "لپ تاپ اپل",
            "number": "10005",
            "date": 1460952000,
            "due": 1461816000,
            "amount": 27800000,
            "link": "https://www.hesabit.com/invoice/57151ea8-1540-429b-8a68-49ef2e65ec41",
            "short_link": "http://hesab.it/1U2PRze",
            "seeing": 1460953000,
            "auto_send": {
                "email": 1,
                "sms": 0
            },
            "source": "api",
            "status": "invoice",
            "note": "پرداخت به موضع مزید امتنان است ."
        },
        "Customer": {
            "name": "علی فارمد",
            "company": "حسابان",
            "address": "تهران ، یوسف آباد ، کوچه شفق ، پلاک ۲۰",
            "tel": "02188624168",
            "email": "[email protected]",
            "mobile": "09121234455",
            "id": "52151ea1-1540-429b-8a68-49ef2e65ec41"
        },
        "Profile": {
            "id": "5711260c-ec00-4125-a9bd-6cbb2e65ec45",
            "name": "لپ تاپ ایران",
            "description": "بزرگترین فروشگاه آنلاین لپ تاپ",
            "slug": "sites",
            "address": "تهران، نارمک، خیابان دردشت، کوچه ابراهیمی، پلاک 21، واحد 2",
            "tel": "02188624168",
            "site": "http://www.site.ir",
            "email": "[email protected]",
            "telegram": "https://telegram.me/ali",
            "facebook": "https://www.facebook.com/ali",
            "twitter": "https://twitter.com/ali",
            "instagram": "https://instagram.com/ali",
            "logo": "https://cdn.hesabit.com/profiles/logo/2/12/small.png",
            "signature": "https://cdn.hesabit.com/profiles/signature/2/12/small.png"
        }
    },
    "success": true,
    "status": 201
}
                        
                    
GET /invoices خواندن لیست فاکتورها
GET /invoices/{invoice id} خواندن یک فاکتور از طریق شناسه فاکتور
GET /invoices/customer خواندن فاکتورهای یک مشتری

خواندن فاکتورها

GET /invoices

گرفتن لیست فاکتور ها .


پارامترهای درخواست (Query parameters)

limit نوع:Integer عنوان:تعداد به صورت پیش فرض ۱۰ فاکتور آخر بازگردانده می شود . این مقدار تا ۱۰۰ رکورد قابل تنظیم است .
offset نوع:Integer عنوان:نقطه شروع نقطه شروع یک مقدار عددی است که نقطه شروع رکورد ها را در کوئری مشخص می کند .
page نوع:Integer عنوان:صفحه صفحه یک مقدار عددی است که برای صفحه بندی در کوئری استفاده می شود .
date نوع:Timestamp عنوان:تاریخ فاکتور تاریخ فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها در یک تاریخ خاص قابل استفاده است .
from_date نوع:Timestamp عنوان:از تاریخ فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها از یک تاریخ به بعد قابل استفاده است .
to_date نوع:Timestamp عنوان:تا تاریخ فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها تا یک تاریخ به بعد قابل استفاده است .
due نوع:Timestamp عنوان:تاریخ سررسید تاریخ سررسید فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور هایی که سررسید آن در یک تاریخ خاص قابل استفاده است .
from_due نوع:Timestamp عنوان:از تاریخ سررسید یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها از یک تاریخ به بعد قابل استفاده است .
to_due نوع:Timestamp عنوان:تا تاریخ سررسید یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها تا یک تاریخ به بعد قابل استفاده است .
status نوع:String عنوان:وضعیت فاکتور وضعیت فاکتور برای گرفتن لیست فاکتور ها دارای یک وضعیت خاص قابل استفاده است . مقادیر قابل استفاده :
  • invoice
  • paid

نمونه کد درخواست

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/invoices/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48&limit=10"
                        
                    

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Item": [
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                    "code": "1ab",
                    "description": "لپ تاپ",
                    "cost": 27800000,
                    "quantity": 1,
                    "discount": 10,
                    "tax": 9,
                    "total": 27800000
                }
            ],
            "Invoice": {
                "id": "57151ea8-1540-429b-8a68-49ef2e65ec41",
                "title": "لپ تاپ اپل",
                "number": "10005",
                "date": 1460952000,
                "due": 1461816000,
                "amount": 27800000,
                "link": "https://www.hesabit.com/invoice/57151ea8-1540-429b-8a68-49ef2e65ec41",
                "short_link": "http://hesab.it/1U2PRze",
                "seeing": 0,
                "auto_send": {
                    "email": 1,
                    "sms": 0
                },
                "source": "api",
                "status": "invoice",
                "note": "پرداخت به موضع مزید امتنان است ."
            },
            "Customer": {
                "name": "علی فارمد",
                "company": "حسابان",
                "address": "تهران ، یوسف آباد ، کوچه شفق ، پلاک ۲۰",
                "tel": "02188624168",
                "email": "[email protected]",
                "mobile": "09121234455",
                "id": "52151ea1-1540-429b-8a68-49ef2e65ec41"
            },
            "Profile": {
                "id": "5711260c-ec00-4125-a9bd-6cbb2e65ec45",
                "name": "لپ تاپ ایران",
                "description": "بزرگترین فروشگاه آنلاین لپ تاپ",
                "slug": "sites",
                "address": "تهران، نارمک، خیابان دردشت، کوچه ابراهیمی، پلاک 21، واحد 2",
                "tel": "02188624168",
                "site": "http://www.site.ir",
                "email": "[email protected]",
                "telegram": "https://telegram.me/ali",
                "facebook": "https://www.facebook.com/ali",
                "twitter": "https://twitter.com/ali",
                "instagram": "https://instagram.com/ali",
                "logo": "https://cdn.hesabit.com/profiles/logo/2/12/small.png",
                "signature": "https://cdn.hesabit.com/profiles/signature/2/12/small.png"
            }
        },
        {
            "Item": [
                {
                    "id": "50151ea8-1540-429b-8a68-49ef2e65ec21",
                    "code": "irdomain",
                    "description": "دامنه ir",
                    "cost": 140000,
                    "quantity": 1,
                    "discount": 0,
                    "tax": 0,
                    "total": 140000
                },
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec50",
                    "code": "host200",
                    "description": "هاست 200‌MG",
                    "cost": 450000,
                    "quantity": 1,
                    "discount": 10,
                    "tax": 0,
                    "total": 405000
                }
            ],
            "Invoice": {
                "id": "51151ea8-1540-429b-8a68-49ef2e65ec44",
                "title": "وبسایت دیجیکا",
                "number": "10004",
                "date": 1460252000,
                "due": 1460844000,
                "amount": 545000,
                "link": "https://www.hesabit.com/invoice/51151ea8-1540-429b-8a68-49ef2e65ec44",
                "short_link": "http://hesab.it/a12Rc2",
                "seeing": 1460253000,
                "auto_send": {
                    "email": 0,
                    "sms": 1
                },
                "source": "panel",
                "status": "paid",
                "note": ""
            },
            "Customer": {
                "name": "آیدن تابش",
                "company": "دیجیکا",
                "address": "کرج ، مهرویلا ، کوچه یاس ، ساختمان ایرج",
                "tel": "",
                "email": "",
                "mobile": "09351234422",
                "id": "50151ea1-1540-429b-8a68-49ef2e65ec32"
            },
            "Profile": {
                "id": "5711260c-ec00-4125-a9bd-6cbb2e65ec45",
                "name": "لپ تاپ ایران",
                "description": "بزرگترین فروشگاه آنلاین لپ تاپ",
                "slug": "sites",
                "address": "تهران، نارمک، خیابان دردشت، کوچه ابراهیمی، پلاک 21، واحد 2",
                "tel": "02188624168",
                "site": "http://www.site.ir",
                "email": "[email protected]",
                "telegram": "https://telegram.me/ali",
                "facebook": "https://www.facebook.com/ali",
                "twitter": "https://twitter.com/ali",
                "instagram": "https://instagram.com/ali",
                "logo": "https://cdn.hesabit.com/profiles/logo/2/12/small.png",
                "signature": "https://cdn.hesabit.com/profiles/signature/2/12/small.png"
            },
            "Transaction": {
                "id": "1922557726611",
                "amount": 545000,
                "created": 1460253100
            }
        }
    ],
    "success": true,
    "status": 200
}
                        
                    

خواندن یک فاکتور

GET /invoices/{invoice_id}

خواندن فاکتور از طریق شناسه فاکتور .


مقادیر درخواست در آدرس (Path parameters)

invoice_id شناسه فاکتور یک رشته ۳۶ کاراکتری منحصر به فرد است .

نمونه کد درخواست

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/invoices/51fea353-98cc-4aac-9acf-3eb82e65ec42?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"
                        
                    

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Item": [
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                    "cost": 27800000,
                    "quantity": 1,
                    "total": 27800000,
                    "discount": 10,
                    "tax": 9,
                    "description": "لپ تاپ",
                    "code": "1ab"
                },
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                    "cost": 1700000,
                    "quantity": 1,
                    "total": 1700000,
                    "discount": 0,
                    "tax": 0,
                    "description": "کیف لپ تاپ",
                    "code": ""
                }
            ],
            "Invoice": {
                "id": "51fea353-98cc-4aac-9acf-3eb82e65ec42",
                "title": "لپ تاپ اپل",
                "number": "10005",
                "date": 1460952000,
                "due": 1461816000,
                "amount": 29500000,
                "link": "https://www.hesabit.com/invoice/57151ea8-1540-429b-8a68-49ef2e65ec41",
                "short_link": "http://hesab.it/1U2PRze",
                "seeing": 0,
                "auto_send": {
                    "email": 1,
                    "sms": 0
                },
                "source": "api",
                "status": "invoice",
                "note": "پرداخت به موضع مزید امتنان است ."
            },
            "Customer": {
                "id": "52151ea1-1540-429b-8a68-49ef2e65ec41",
                "name": "علی فارمد",
                "company": "حسابان",
                "address": "تهران ، یوسف آباد ، کوچه شفق ، پلاک ۲۰",
                "tel": "02188624168",
                "email": "[email protected]",
                "mobile": "09121234455"
            },
            "Profile": {
                "id": "5711260c-ec00-4125-a9bd-6cbb2e65ec45",
                "name": "لپ تاپ ایران",
                "description": "بزرگترین فروشگاه آنلاین لپ تاپ",
                "slug": "sites",
                "address": "تهران، نارمک، خیابان دردشت، کوچه ابراهیمی، پلاک 21، واحد 2",
                "tel": "02188624168",
                "site": "http://www.site.ir",
                "email": "[email protected]",
                "telegram": "https://telegram.me/ali",
                "facebook": "https://www.facebook.com/ali",
                "twitter": "https://twitter.com/ali",
                "instagram": "https://instagram.com/ali",
                "logo": "https://cdn.hesabit.com/profiles/logo/2/12/small.png",
                "signature": "https://cdn.hesabit.com/profiles/signature/2/12/small.png"
            }
        }
    ],
    "success": true,
    "status": 200
}
                        
                    

خواندن فاکتورهای یک مشتری

خواندن فاکتور های یک مشتری خاص .

GET /invoices/customer

پارامترهای درخواست (Query parameters)

customer_id نوع:String عنوان:شناسه مشتری شناسه مشتری یک رشته ۳۶ کاراکتری منحصر به فرد است .
email نوع:String عنوان:ایمیل مشتری آدرس ایمیل مشتری .
mobile نوع:String عنوان:موبایل مشتری شماره موبایل مشتری .
limit نوع:Integer عنوان:تعداد به صورت پیش فرض ۱۰ فاکتور آخر بازگردانده می شود . این مقدار تا ۱۰۰ رکورد قابل تنظیم است .
offset نوع:Integer عنوان:نقطه شروع نقطه شروع یک مقدار عددی است که نقطه شروع رکورد ها را در کوئری مشخص می کند .
page نوع:Integer عنوان:صفحه صفحه یک مقدار عددی است که برای صفحه بندی در کوئری استفاده می شود .
date نوع:Timestamp عنوان:تاریخ فاکتور تاریخ فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها در یک تاریخ خاص قابل استفاده است .
from_date نوع:Timestamp عنوان:از تاریخ فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها از یک تاریخ به بعد قابل استفاده است .
to_date نوع:Timestamp عنوان:تا تاریخ فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها تا یک تاریخ به بعد قابل استفاده است .
due نوع:Timestamp عنوان:تاریخ سررسید تاریخ سررسید فاکتور یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور هایی که سررسید آن در یک تاریخ خاص قابل استفاده است .
from_due نوع:Timestamp عنوان:از تاریخ سررسید یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها از یک تاریخ به بعد قابل استفاده است .
to_due نوع:Timestamp عنوان:تا تاریخ سررسید یک رشته عددی به صورت timestamp است که برای گرفتن لیست فاکتور ها تا یک تاریخ به بعد قابل استفاده است .
status نوع:String عنوان:وضعیت فاکتور وضعیت فاکتور برای گرفتن لیست فاکتور ها دارای یک وضعیت خاص قابل استفاده است . مقادیر قابل استفاده :
  • invoice
  • paid

نمونه کد درخواست

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/invoices/customer/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48&mobile=09121234455"
                        
                    

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Item": [
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                    "cost": 27800000,
                    "quantity": 1,
                    "total": 27800000,
                    "discount": 10,
                    "tax": 9,
                    "description": "لپ تاپ",
                    "code": "1ab"
                },
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                    "cost": 1700000,
                    "quantity": 1,
                    "total": 1700000,
                    "discount": 0,
                    "tax": 0,
                    "description": "کیف لپ تاپ",
                    "code": ""
                }
            ],
            "Invoice": {
                "id": "57151ea8-1540-429b-8a68-49ef2e65ec41",
                "title": "لپ تاپ اپل",
                "number": "10005",
                "date": 1460952000,
                "due": 1461816000,
                "amount": 29500000,
                "link": "https://www.hesabit.com/invoice/57151ea8-1540-429b-8a68-49ef2e65ec41",
                "short_link": "http://hesab.it/1U2PRze",
                "seeing": 0,
                "auto_send": {
                    "email": 1,
                    "sms": 0
                },
                "source": "api",
                "status": "invoice",
                "note": "پرداخت به موضع مزید امتنان است ."
            },
            "Customer": {
                "id": "52151ea1-1540-429b-8a68-49ef2e65ec41",
                "name": "علی فارمد",
                "company": "حسابان",
                "address": "تهران ، یوسف آباد ، کوچه شفق ، پلاک ۲۰",
                "tel": "02188624168",
                "email": "[email protected]",
                "mobile": "09121234455"
            },
            "Profile": {
                "id": "5711260c-ec00-4125-a9bd-6cbb2e65ec45",
                "name": "لپ تاپ ایران",
                "description": "بزرگترین فروشگاه آنلاین لپ تاپ",
                "slug": "sites",
                "address": "تهران، نارمک، خیابان دردشت، کوچه ابراهیمی، پلاک 21، واحد 2",
                "tel": "02188624168",
                "site": "http://www.site.ir",
                "email": "[email protected]",
                "telegram": "https://telegram.me/ali",
                "facebook": "https://www.facebook.com/ali",
                "twitter": "https://twitter.com/ali",
                "instagram": "https://instagram.com/ali",
                "logo": "https://cdn.hesabit.com/profiles/logo/2/12/small.png",
                "signature": "https://cdn.hesabit.com/profiles/signature/2/12/small.png"
            }
        }
    ],
    "success": true,
    "status": 200
}
                        
                    
PUT /invoices/{invoice_id} ویرایش یک فاکتور

ویرایش فاکتور

ویرایش یک فاکتور .

PUT /invoices/{invoice_id}

محتوی درخواست (Body parameters)

title نوع:String عنوان:عنوان فاکتور عنوان فاکتور در پیام های ارسالی به کاربر نمایش داده می شود.
number نوع:String عنوان:شماره فاکتور شماره فاکتور به صورت پیش فرض برای هر فاکتور ایجاد می شود اما امکان تنظیم آن به صورت دلخواه هم وجود دارد .
date نوع:Timestamp عنوان:تاریخ فاکتور تاریخ فاکتور یک رشته عددی به صورت timestamp است که قبل از آن فاکتور برای مشتری در دسترس نخواهد بود .
due نوع:Timestamp عنوان:تاریخ سررسید تاریخ سررسید فاکتور یک رشته عددی به صورت timestamp است که فاکتور بعد از آن قابل پرداخت نخواهد بود .
note نوع:String عنوان:یادداشت یادداشت فاکتور متنی است که زیر فاکتور نمایش داده خواهد شد و معمولا شرایط و قوانین فروش را دربر میگیرد .
auto_send نوع:Array عنوان:ارسال خودکار به صورت پیش فرض فاکتور به صورت ایمیل و پیامک برای مشتری ارسال می شود .
email نوع:Boolean عنوان:ارسال ایمیل ارسال فاکتور به صورت ایمیل برای مشتری . ایمیل یادآوری فقط در صورت فعال بودن این مقدار ارسال می شود .
sms نوع:Boolean عنوان:ارسال پیامک ارسال لینک فاکتور به صورت پیامک برای مشتری . پیامک یادآوری فقط در صورت فعال بودن این مقدار ارسال می شود .
Customer نوع:Array عنوان:مشتری مشتری باید قبل از صدور فاکتور ذخیره شده باشد * توجه : وجود یکی از پارامتر های زیر ضروری است
id نوع:String عنوان:شناسه مشتری شناسه مشتری یک رشته ۳۶ کاراکتری است .
email نوع:String عنوان:ایمیل مشتری ایمیل مشتری باید منحصر به فرد باشد .
mobile نوع:Integer عنوان:موبایل مشتری شماره موبایل مشتری یک عدد ۱۱ رقمی است و باید به منحصر به فرد باشد .
Item نوع:Array عنوان:محصول نیازی نیست محصولات از قبل تعریف شده باشد اما برای محصولات تعریف نشده پر کردن مشخصات اصلی لازم است و برای محصولات از پیش تعریف شده شناسه محصول کافی است . * توجه : برای محصول از قبل تعریف نشده این موارد ضروری هستند :
  • description
  • cost
  • quantity
id نوع:String عنوان:شناسه محصول شناسه محصول یک رشته ۳۶ کاراکتری است .
description نوع:String عنوان:شرح محصول شرح محصول نام کالا و یا خدمتی است که در هر یک از ردیف های جدول فاکتور قرار می گیرد .
cost نوع:Integer عنوان:قیمت محصول قیمت محصول به ریال به صورت عددی .
quantity نوع:Integer عنوان:تعداد محصول تعداد محوصل به صورت عددی .
tax نوع:Integer عنوان:تخفیف محصول درصد مالیاتی که به محصول تعلق می گیرد .
discount نوع:Integer عنوان:تخفیف محصول درصد تخفیفی که به محصول تعلق میگیرد .
code نوع:String عنوان:کد محصول کد محصول یک شناسه منحصر به فرد است که کاربر به دلخوله انتخاب خود کرده است .

نمونه کد درخواست

                        curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"title":"لپ تاپ","Customer":{"email":"[email protected]"},"Item":[{"description":"لپ تاپ macbook", "cost":3750000, "quantity":1, "discount":11, "tax":9}]}' "https://api.hesabit.com/v1/invoices/51fea353-98cc-4aac-9acf-3eb82e65ec42/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"
                    

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Item": [
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                    "cost": 27800000,
                    "quantity": 1,
                    "total": 27800000,
                    "discount": 10,
                    "tax": 9,
                    "description": "لپ تاپ",
                    "code": "1ab"
                },
                {
                    "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                    "cost": 1700000,
                    "quantity": 1,
                    "total": 1700000,
                    "discount": 0,
                    "tax": 0,
                    "description": "کیف لپ تاپ",
                    "code": ""
                }
            ],
            "Invoice": {
                "id": "57151ea8-1540-429b-8a68-49ef2e65ec41",
                "title": "لپ تاپ اپل",
                "number": "10005",
                "date": 1460952000,
                "due": 1461816000,
                "amount": 29500000,
                "link": "https://www.hesabit.com/invoice/57151ea8-1540-429b-8a68-49ef2e65ec41",
                "short_link": "http://hesab.it/1U2PRze",
                "seeing": 0,
                "auto_send": {
                    "email": 1,
                    "sms": 0
                },
                "source": "api",
                "status": "invoice",
                "note": "پرداخت به موضع مزید امتنان است ."
            },
            "Customer": {
                "id": "52151ea1-1540-429b-8a68-49ef2e65ec41",
                "name": "علی فارمد",
                "company": "حسابان",
                "address": "تهران ، یوسف آباد ، کوچه شفق ، پلاک ۲۰",
                "tel": "02188624168",
                "email": "[email protected]",
                "mobile": "09121234455"
            },
            "Profile": {
                "id": "5711260c-ec00-4125-a9bd-6cbb2e65ec45",
                "name": "لپ تاپ ایران",
                "description": "بزرگترین فروشگاه آنلاین لپ تاپ",
                "slug": "sites",
                "address": "تهران، نارمک، خیابان دردشت، کوچه ابراهیمی، پلاک 21، واحد 2",
                "tel": "02188624168",
                "site": "http://www.site.ir",
                "email": "[email protected]",
                "telegram": "https://telegram.me/ali",
                "facebook": "https://www.facebook.com/ali",
                "twitter": "https://twitter.com/ali",
                "instagram": "https://instagram.com/ali",
                "logo": "https://cdn.hesabit.com/profiles/logo/2/12/small.png",
                "signature": "https://cdn.hesabit.com/profiles/signature/2/12/small.png"
            }
        }
    ],
    "success": true,
    "status": 200
}
                        
                    
DELETE /invoices/{invoice_id} حذف یک فاکتور

حذف فاکتور

پاک کردن یک فاکتور .

DELETE /invoices/{invoice_id}

مقادیر درخواست در آدرس (Path parameters)

invoice_id شناسه فاکتور یک رشته ۳۶ کاراکتری منحصر به فرد است .

نمونه کد درخواست

                        curl -X DELETE -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/invoices/51fea353-98cc-4aac-9acf-3eb82e65ec42/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"
                        
                    

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding


{
  "data": {
    "Invoice": {
      "id": "51fea353-98cc-4aac-9acf-3eb82e65ec42"
    }
  },
  "success": true,
  "status": 200,
  "message": "Invoice deleted successfully"
}