GET v1/Invoices/{invoiceId}?includeDeleted={includeDeleted}
Get detailed information about an Invoice.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| invoiceId |
The id of the Invoice. |
integer |
Required. |
| includeDeleted |
Optionally specify if deleted invoices should be retrieved (not included by default). |
boolean |
Is Optional. Default value is False. |
Body Parameters
None.
Response Information
Resource Description
The <see cref="T:ShopCtrl.API.Models.Invoice" /> object.
Invoice| Name | Description | Type | Additional information |
|---|---|---|---|
| MainStatus |
Gets or sets the main status. |
InvoiceStatus |
None. |
| MainStatusComment | string |
Max length: 200 |
|
| MainStatusActionDate | date |
None. |
|
| PaymentStatus |
Gets or sets the payment status. |
InvoiceStatus |
None. |
| PaymentStatusComment | string |
Max length: 200 |
|
| PaymentStatusActionDate | date |
None. |
|
| SentStatus |
Gets or sets the payment status. |
InvoiceStatus |
None. |
| SentStatusComment | string |
Max length: 200 |
|
| SentStatusActionDate | date |
None. |
|
| CustomStatus |
Gets or sets the custom status. |
InvoiceStatus |
None. |
| CustomStatusComment | string |
Max length: 200 |
|
| CustomStatusActionDate | date |
None. |
|
| CultureCode |
Gets or sets the culture code. When adding/updating an Invoice, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode. |
string |
None. |
| CultureId |
Gets or sets the culture identifier. When adding/updating an Invoice, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode. |
integer |
None. |
| ExchangeRate |
Gets the exchange rate. |
decimal number |
None. |
| ShopId |
Gets or sets the shop identifier. |
integer |
Required |
| ShippingCostsIncVat |
Gets or sets the shipping costs (include VAT). |
decimal number |
Required |
| ShippingCostsExVat |
Gets or sets the shipping costs (exclude VAT). |
decimal number |
Required |
| PaymentFeeIncVat |
Gets or sets the payment fee (include VAT). |
decimal number |
Required |
| PaymentFeeExVat |
Gets or sets the payment fee (excluded VAT). |
decimal number |
Required |
| DiscountExVat |
Gets or sets the discount (exclude VAT). |
decimal number |
Required |
| DiscountIncVat |
Gets or sets the discount (include VAT). |
decimal number |
Required |
| PaymentTypeId |
Gets or sets the payment type identifier. |
integer |
None. |
| PaymentTermsId |
Gets or sets the payment terms identifier. |
integer |
Required |
| CustomerId |
Gets or sets the customer identifier. |
integer |
None. |
| CustomerNumber |
Gets or sets the CustomerCode, as defined for the Customer. When adding/updating an Invoice, ShopCtrl will first try to find the Customer based on the provided <see cref="P:ShopCtrl.API.Models.Invoice.CustomerId" /> If not provided, the customer will be determined based on the provided CustomerCode. |
string |
None. |
| CustomerReference |
Gets or sets the reference provided by the customer. |
string |
Max length: 200 |
| Note |
Gets or sets the customer note. |
string |
Max length: 2147483647 |
| ShopNote |
Gets or sets the shop note. |
string |
Max length: 2147483647 |
| BillToContact |
Gets the bill to contact. |
ContactInfo |
None. |
| ShipToContact |
Gets the ship to contact. |
ContactInfo |
None. |
| InvoiceRows |
Gets the invoice rows. |
Collection of InvoiceRow |
None. |
| Id |
Gets or sets the identifier. |
integer |
Required |
| 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. |
| InvoiceSourceType |
Gets invoice document source type. |
InvoiceSourceType |
None. |
| IsReadOnly |
Indicates if invoice document is readonly |
boolean |
Required |
| DocumentFileId |
Gets the document File ID (pdf). |
integer |
None. |
| 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
{
"MainStatus": {
"Comment": "sample string 1",
"ActionDate": "2026-06-21T21:32:44.1230531+02:00",
"Id": 2,
"BaseInvoiceStatusId": 3,
"InvoiceStatusTypeId": 4,
"Name": "sample string 5"
},
"MainStatusComment": "sample string 1",
"MainStatusActionDate": "2026-06-21T21:32:44.1230531+02:00",
"PaymentStatus": {
"Comment": "sample string 1",
"ActionDate": "2026-06-21T21:32:44.1230531+02:00",
"Id": 2,
"BaseInvoiceStatusId": 3,
"InvoiceStatusTypeId": 4,
"Name": "sample string 5"
},
"PaymentStatusComment": "sample string 2",
"PaymentStatusActionDate": "2026-06-21T21:32:44.1230531+02:00",
"SentStatus": {
"Comment": "sample string 1",
"ActionDate": "2026-06-21T21:32:44.1230531+02:00",
"Id": 2,
"BaseInvoiceStatusId": 3,
"InvoiceStatusTypeId": 4,
"Name": "sample string 5"
},
"SentStatusComment": "sample string 3",
"SentStatusActionDate": "2026-06-21T21:32:44.1230531+02:00",
"CustomStatus": {
"Comment": "sample string 1",
"ActionDate": "2026-06-21T21:32:44.1230531+02:00",
"Id": 2,
"BaseInvoiceStatusId": 3,
"InvoiceStatusTypeId": 4,
"Name": "sample string 5"
},
"CustomStatusComment": "sample string 4",
"CustomStatusActionDate": "2026-06-21T21:32:44.1230531+02:00",
"CultureCode": "sample string 5",
"CultureId": 1,
"ExchangeRate": 0.0,
"ShopId": 6,
"ShippingCostsIncVat": 7.0,
"ShippingCostsExVat": 8.0,
"PaymentFeeIncVat": 9.0,
"PaymentFeeExVat": 10.0,
"DiscountExVat": 11.0,
"DiscountIncVat": 12.0,
"PaymentTypeId": 1,
"PaymentTermsId": 1,
"CustomerId": 1,
"CustomerNumber": "sample string 13",
"CustomerReference": "sample string 14",
"Note": "sample string 15",
"ShopNote": "sample string 16",
"BillToContact": null,
"ShipToContact": null,
"InvoiceRows": [],
"Id": 17,
"InvoiceCode": "sample string 18",
"InvoiceDate": "2026-06-21T21:32:44.1230531+02:00",
"InvoiceTotalIncVat": 19.0,
"InvoiceTotalExVat": 20.0,
"CurrencyId": 21,
"CurrencyCode": "sample string 22",
"Deleted": true,
"ChangedTimestamp": "2026-06-21T21:32:44.1230531+02:00",
"MainStatusId": 1,
"PaymentStatusId": 1,
"SentStatusId": 1,
"CustomStatusId": 1,
"InvoiceSourceType": 0,
"IsReadOnly": true,
"DocumentFileId": 1,
"OrderId": 26,
"OrderCode": "sample string 27"
}