General

Objects

Codes

Invoice - POST

Stability: 2 - Stable

An invoice is primarily a merchant object, which represents a collection of items purchased by that merchant.

This API POST call allows you to insert and update invoices.

The endpoint you need to use for this is:

/invoice

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	POST	N/A
x-accept-version	{recommended_latest_version_number}	2

* Required header

Body

NOTE: To update just supply the object id.

Key	Details	Data Type
invoices[{invoieId}].id	Unique Invoice Id	Int
invoices[{invoieId}].supplierId	Supplier Id	Int
invoices[{invoieId}].storeId	Merchant Store Id	Int
invoices[{invoieId}].supplierStoreId	Supplier Store Id	Int
invoices[{invoieId}].reference	Supplier Invoice Reference	String
invoices[{invoieId}].completeDate	Supplier Invoice Date	Date
invoices[{invoieId}].note	Supplier Invoice Note	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].barcode	Barcode	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].note	Invoice Item Note	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].name	Invoice Item Name	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].price	Price	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].vatPercentage	Vat Percentage	Float
invoices[{invoieId}].invoiceItems[{invoiceItemId}].quantity	Invoice Item Qty	Int
invoices[{invoieId}].invoiceItems[{invoiceItemId}].productId	Product Id	Int
invoices[{invoieId}].invoiceItems[{invoiceItemId}].accountId	Account Id	Int

{
    "invoices": {
        "0": {
            "storeId": "1",
            "supplierStoreId": "122",
            "reference": "INV78340911",
            "completed": true,
            "note": "Summer festival stock",
            "invoiceItems": {
                "0": {
                    "barcode": "56789",
                    "note": "no description",
                    "name": "Hibiscus",
                    "price": "91.7",
                    "vatPercentage": 0.2,
                    "quantity": "10",
                    "productId": "58",
                    "accountId": 80
                },
                "1": {
                    "barcode": "",
                    "note": "",
                    "name": "Orange Juice",
                    "price": "220.0",
                    "vatPercentage": 0,
                    "quantity": "30",
                    "productId": "59369",
                    "accountId": 80
                },
                "2": {
                    "barcode": "",
                    "note": "",
                    "name": "Green Penguins",
                    "price": "275.0",
                    "vatPercentage": 0.2,
                    "quantity": "20",
                    "productId": "75025",
                    "accountId": 80
                },
                "3": {
                    "barcode": "123123455",
                    "note": "We make it our business to be there for you when you need the sort of inspiration that great coffee brings. uu This beverage is for those times when you can‚ ±§~` Äö√Ñ√∂‚àö√ë‚àö‚àÇ‚Äö√†√∂‚àö√´‚Äö√†√∂‚",
                    "name": "Pasta Salad",
                    "price": "83.3",
                    "vatPercentage": 0.2,
                    "quantity": 100,
                    "productId": "7",
                    "accountId": 80
                }
            }
        }
    }
}

Response

Headers

Key	Details	Data Type	Example
statusCode	Very important to check this for any error. 201 for success.	int	201

Body

Key	Details	Data Type
invoices[{invoieId}].id	Unique Invoice Id	Int
invoices[{invoieId}].supplierId	Supplier Id	Int
invoices[{invoieId}].storeId	Merchant Store Id	Int
invoices[{invoieId}].supplierStoreId	Supplier Store Id	Int
invoices[{invoieId}].reference	Supplier Invoice Reference	String
invoices[{invoieId}].completeDate	Supplier Invoice Date	Date
invoices[{invoieId}].note	Supplier Invoice Note	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].barcode	Barcode	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].note	Invoice Item Note	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].name	Invoice Item Name	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].price	Price	String
invoices[{invoieId}].invoiceItems[{invoiceItemId}].vatPercentage	Vat Percentage	Float
invoices[{invoieId}].invoiceItems[{invoiceItemId}].quantity	Invoice Item Qty	Int
invoices[{invoieId}].invoiceItems[{invoiceItemId}].productId	Product Id	Int
invoices[{invoieId}].invoiceItems[{invoiceItemId}].accountId	Account Id	Int

{
    "invoices": {
        "0": {
            "invoiceItems": {
                "0": {
                    "invoiceId": 848,
                    "name": "Hibiscus",
                    "price": "91.7",
                    "vatPercentage": 0.2,
                    "quantity": "10",
                    "accountId": 80,
                    "barcode": "56789",
                    "note": "no description",
                    "id": 5093,
                    "productId": "58"
                },
                "1": {
                    "invoiceId": 848,
                    "name": "Orange Juice",
                    "price": "220.0",
                    "vatPercentage": 0,
                    "quantity": "30",
                    "accountId": 80,
                    "barcode": "",
                    "note": "",
                    "id": 5094,
                    "productId": "59369"
                },
                "2": {
                    "invoiceId": 848,
                    "name": "Green Penguins",
                    "price": "275.0",
                    "vatPercentage": 0.2,
                    "quantity": "20",
                    "accountId": 80,
                    "barcode": "",
                    "note": "",
                    "id": 5095,
                    "productId": "75025"
                },
                "3": {
                    "invoiceId": 848,
                    "name": "Pasta Salad",
                    "price": "83.3",
                    "vatPercentage": 0.2,
                    "quantity": 100,
                    "accountId": 80,
                    "barcode": "123123455",
                    "note": "We make it our business to be there for you when you need the sort of inspiration that great coffee brings. uu This beverage is for those times when you can‚ ±§~` Äö√Ñ√∂‚àö√ë‚àö‚àÇ‚Äö√†√∂‚àö√´‚Äö√†√∂‚",
                    "id": 5096,
                    "productId": "7"
                }
            },
            "id": 848,
            "storeId": "1",
            "supplierStoreId": "122",
            "reference": "INV78340911",
            "completeDate": "2014-07-06 15:09:38",
            "note": "Summer festival stock"
        }
    },
    "api": {
        "message": {
            "success": {
                "202": {
                    "id": 202,
                    "title": "Token is valid",
                    "details": "Token is validated and found valid."
                },
                "206": {
                    "id": 206,
                    "title": "Resource Created",
                    "details": "Your resource is created partially or fully. Please check further message or process log"
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 45
    }
}

Status Codes

Error

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
908	401	Expired Token	Token expired or invalid. Please renew your token
911	401	Authorization Header Invalid	The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken}
919	429	Cannot handle too many request	There is a limit for every object you can send to our server and you are exceding that.
913	400	Required parameter or object missing in request	One or more of the required parameters or object formation is missing in your request. Please refer the documentation
904	401	Access Denied	Access denied for the request
912	403	Resource Not Allowed For Specified User	The user does not own this resource and its forbidden
899	500	Unknown Error	Something went wrong. Please contact the site administrator

Success

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
202	200	Token is valid	Token is validated and found valid.
206	201	Resource Created	Your resource is created partially or fully. Please check further message or process log

Request
- Headers
- Body
Response
- Headers
- Body
Status Codes
- Error
- Success
Top