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.

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.
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

Sample:

{
  "MainStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:13:37.1623045+01:00",
    "Id": 2,
    "BaseInvoiceStatusId": 3,
    "InvoiceStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "MainStatusComment": "sample string 1",
  "MainStatusActionDate": "2026-01-11T16:13:37.1623045+01:00",
  "PaymentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:13:37.1623045+01:00",
    "Id": 2,
    "BaseInvoiceStatusId": 3,
    "InvoiceStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "PaymentStatusComment": "sample string 2",
  "PaymentStatusActionDate": "2026-01-11T16:13:37.1623045+01:00",
  "SentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:13:37.1623045+01:00",
    "Id": 2,
    "BaseInvoiceStatusId": 3,
    "InvoiceStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "SentStatusComment": "sample string 3",
  "SentStatusActionDate": "2026-01-11T16:13:37.1623045+01:00",
  "CustomStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:13:37.1623045+01:00",
    "Id": 2,
    "BaseInvoiceStatusId": 3,
    "InvoiceStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "CustomStatusComment": "sample string 4",
  "CustomStatusActionDate": "2026-01-11T16:13:37.1623045+01: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-01-11T16:13:37.1623045+01:00",
  "InvoiceTotalIncVat": 19.0,
  "InvoiceTotalExVat": 20.0,
  "CurrencyId": 21,
  "CurrencyCode": "sample string 22",
  "Deleted": true,
  "ChangedTimestamp": "2026-01-11T16:13:37.1623045+01:00",
  "MainStatusId": 1,
  "PaymentStatusId": 1,
  "SentStatusId": 1,
  "CustomStatusId": 1,
  "DocumentFileId": 1,
  "OrderId": 25,
  "OrderCode": "sample string 26"
}

application/xml, text/xml

Sample:

<Invoice xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>17</Id>
  <InvoiceCode>sample string 18</InvoiceCode>
  <InvoiceDate>2026-01-11T16:13:37.1623045+01:00</InvoiceDate>
  <InvoiceTotalIncVat>19</InvoiceTotalIncVat>
  <InvoiceTotalExVat>20</InvoiceTotalExVat>
  <CurrencyId>21</CurrencyId>
  <CurrencyCode>sample string 22</CurrencyCode>
  <Deleted>true</Deleted>
  <ChangedTimestamp>2026-01-11T16:13:37.1623045+01:00</ChangedTimestamp>
  <MainStatusId>1</MainStatusId>
  <PaymentStatusId>1</PaymentStatusId>
  <SentStatusId>1</SentStatusId>
  <CustomStatusId>1</CustomStatusId>
  <DocumentFileId>1</DocumentFileId>
  <OrderId>25</OrderId>
  <OrderCode>sample string 26</OrderCode>
  <MainStatus>
    <Id>2</Id>
    <BaseInvoiceStatusId>3</BaseInvoiceStatusId>
    <InvoiceStatusTypeId>4</InvoiceStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:13:37.1623045+01:00</ActionDate>
  </MainStatus>
  <MainStatusComment>sample string 1</MainStatusComment>
  <MainStatusActionDate>2026-01-11T16:13:37.1623045+01:00</MainStatusActionDate>
  <PaymentStatus>
    <Id>2</Id>
    <BaseInvoiceStatusId>3</BaseInvoiceStatusId>
    <InvoiceStatusTypeId>4</InvoiceStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:13:37.1623045+01:00</ActionDate>
  </PaymentStatus>
  <PaymentStatusComment>sample string 2</PaymentStatusComment>
  <PaymentStatusActionDate>2026-01-11T16:13:37.1623045+01:00</PaymentStatusActionDate>
  <SentStatus>
    <Id>2</Id>
    <BaseInvoiceStatusId>3</BaseInvoiceStatusId>
    <InvoiceStatusTypeId>4</InvoiceStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:13:37.1623045+01:00</ActionDate>
  </SentStatus>
  <SentStatusComment>sample string 3</SentStatusComment>
  <SentStatusActionDate>2026-01-11T16:13:37.1623045+01:00</SentStatusActionDate>
  <CustomStatus>
    <Id>2</Id>
    <BaseInvoiceStatusId>3</BaseInvoiceStatusId>
    <InvoiceStatusTypeId>4</InvoiceStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:13:37.1623045+01:00</ActionDate>
  </CustomStatus>
  <CustomStatusComment>sample string 4</CustomStatusComment>
  <CustomStatusActionDate>2026-01-11T16:13:37.1623045+01:00</CustomStatusActionDate>
  <CultureCode>sample string 5</CultureCode>
  <CultureId>1</CultureId>
  <ShopId>6</ShopId>
  <ShippingCostsIncVat>7</ShippingCostsIncVat>
  <ShippingCostsExVat>8</ShippingCostsExVat>
  <PaymentFeeIncVat>9</PaymentFeeIncVat>
  <PaymentFeeExVat>10</PaymentFeeExVat>
  <DiscountExVat>11</DiscountExVat>
  <DiscountIncVat>12</DiscountIncVat>
  <PaymentTypeId>1</PaymentTypeId>
  <PaymentTermsId>1</PaymentTermsId>
  <CustomerId>1</CustomerId>
  <CustomerNumber>sample string 13</CustomerNumber>
  <CustomerReference>sample string 14</CustomerReference>
  <Note>sample string 15</Note>
  <ShopNote>sample string 16</ShopNote>
  <InvoiceRows />
</Invoice>