POST v1/Orders/{orderId}/Invoices
Auto create an Invoice for given order. An Invoice will be created for all order rows which are not invoiced yet. When there are no order rows to invoice, null will be returned.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderId |
The order identifier. |
integer |
Required. |
Body Parameters
None.
Response Information
Resource Description
The created (if any) Invoice.
InvoiceBase| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Gets or sets the identifier. |
integer |
Must be 0 (for insert operations) |
| InvoiceCode |
Gets or sets the invoice code. |
string |
Max length: 20 |
| InvoiceDate |
Gets or sets the date. |
date |
None. |
| InvoiceTotalIncVat |
Gets or sets the invoice total with the 'VAT'. |
decimal number |
Required |
| InvoiceTotalExVat |
Gets or sets the invoice total without the 'VAT'. |
decimal number |
Required |
| CurrencyId |
Gets or sets the currency identifier. |
integer |
None. |
| CurrencyCode |
Gets or sets the currency code. |
string |
None. |
| Deleted |
Gets or sets a value indicating whether this <see cref="T:ShopCtrl.API.Models.InvoiceBase" /> is deleted. |
boolean |
None. |
| ChangedTimestamp |
Gets or sets the change timestamp. |
date |
None. |
| MainStatusId |
Gets or sets the main status identifier. |
integer |
None. |
| PaymentStatusId |
Gets or sets the payment status identifier. |
integer |
None. |
| SentStatusId |
Gets or sets the payment status identifier. |
integer |
None. |
| CustomStatusId |
Gets or sets the custom status identifier. |
integer |
None. |
| DocumentFileId |
Gets the document File ID (pdf). |
integer |
None. |
| ShopId |
Gets the corresponding shop Id. |
integer |
Required |
| OrderId |
Gets or sets the corresponding Order Id. |
integer |
Required |
| OrderCode |
Gets or sets the corresponding Order code. |
string |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"InvoiceCode": "sample string 2",
"InvoiceDate": "2026-01-11T16:17:35.0304578+01:00",
"InvoiceTotalIncVat": 3.0,
"InvoiceTotalExVat": 4.0,
"CurrencyId": 5,
"CurrencyCode": "sample string 6",
"Deleted": true,
"ChangedTimestamp": "2026-01-11T16:17:35.0304578+01:00",
"MainStatusId": 1,
"PaymentStatusId": 1,
"SentStatusId": 1,
"CustomStatusId": 1,
"DocumentFileId": 1,
"ShopId": 0,
"OrderId": 9,
"OrderCode": "sample string 10"
}
application/xml, text/xml
<InvoiceBase xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Id>1</Id> <InvoiceCode>sample string 2</InvoiceCode> <InvoiceDate>2026-01-11T16:17:35.0304578+01:00</InvoiceDate> <InvoiceTotalIncVat>3</InvoiceTotalIncVat> <InvoiceTotalExVat>4</InvoiceTotalExVat> <CurrencyId>5</CurrencyId> <CurrencyCode>sample string 6</CurrencyCode> <Deleted>true</Deleted> <ChangedTimestamp>2026-01-11T16:17:35.0304578+01:00</ChangedTimestamp> <MainStatusId>1</MainStatusId> <PaymentStatusId>1</PaymentStatusId> <SentStatusId>1</SentStatusId> <CustomStatusId>1</CustomStatusId> <DocumentFileId>1</DocumentFileId> <OrderId>9</OrderId> <OrderCode>sample string 10</OrderCode> </InvoiceBase>