AVB LINQ Public API

SalesOrderInvoiceCreateRequest

Magento Sales

The following routes are available for this service:
PUT	/salesOrderInvoice	Allows you to create a new invoice for an order.

**SalesOrderInvoiceCreateRequest** Parameters:
Name	Parameter	Data Type	Required	Description
InvoiceIncrementId	body	string	Yes	Order increment ID
ItemsQty	body	List<OrderItemIdQty>	No	Array of orderItemIdQty (quantity of items to invoice)
Comment	body	string	No	Shipment comment
Email	body	string	No	Send invoice on email. Default (0)
IncludeComment	body	string	No	Include comments in email. Default (0)

**OrderItemIdQty** Parameters:
Name	Parameter	Data Type	Required	Description
OrderItemId	form	int	No	Order item ID
Qty	form	double	No	Quantity

**SalesOrderInvoiceCreateResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
InvoiceId	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /salesOrderInvoice HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	invoiceIncrementId: String,
	itemsQty: 
	[
		{
			orderItemId: 0,
			qty: 0
		}
	],
	comment: String,
	email: String,
	includeComment: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	invoiceId: String
}