GET v1/Invoices/{invoiceId}/Rows

Get a list with all Invoice rows for a given Invoice.

Request Information

URI Parameters

Name	Description	Type	Additional information
invoiceId	The Invoice identifier.	integer	Required.

Body Parameters

None.

Response Information

Resource Description

A list of the <see cref="T:ShopCtrl.API.Models.InvoiceRow" /> objects.

Collection of InvoiceRow

Name	Description	Type	Additional information
Id	Gets the identifier.	integer	Required
OrderRowId	Gets the identifier of the related OrderRow.	integer	Required
ProductCode	Gets or sets the product code.	string	Required Max length: 100
ProductName	Gets or sets the name of the product.	string	Max length: 500
ProductDescription	Gets or sets the product description.	string	Max length: 2147483647
ProductSelectionProductId	Gets or sets the product selection product identifier.	integer	None.
ItemQuantity	Gets or sets the item quantity. When a credit is made, the value must be < 0.	decimal number	Required
ItemPriceExVat	Gets or sets the item price (exclude VAT).	decimal number	Required
ItemPriceIncVat	Gets or sets the item price (include VAT).	decimal number	Required
DiscountExVat	Gets or sets the row discount (exclude VAT).	decimal number	Required
DiscountIncVat	Gets or sets the row discount (include VAT).	decimal number	Required
VatTariffId	Gets or sets the VAT tariff identifier.	integer	None.
VatTariffCode	Gets or sets the VAT tariff code.	string	None.
VatPercentage	Gets the VAT percentage.	decimal number	None.
RowTotalExVat	Gets or sets the row total (exclude VAT).	decimal number	Required
RowTotalIncVat	Gets or sets the row total (include VAT).	decimal number	Required
Comment	Gets or sets the comment.	string	Max length: 2147483647

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 0,
    "OrderRowId": 0,
    "ProductCode": "sample string 1",
    "ProductName": "sample string 2",
    "ProductDescription": "sample string 3",
    "ProductSelectionProductId": 1,
    "ItemQuantity": 4.0,
    "ItemPriceExVat": 5.0,
    "ItemPriceIncVat": 6.0,
    "DiscountExVat": 7.0,
    "DiscountIncVat": 8.0,
    "VatTariffId": 1,
    "VatTariffCode": "sample string 9",
    "VatPercentage": null,
    "RowTotalExVat": 10.0,
    "RowTotalIncVat": 11.0,
    "Comment": "sample string 12"
  },
  {
    "Id": 0,
    "OrderRowId": 0,
    "ProductCode": "sample string 1",
    "ProductName": "sample string 2",
    "ProductDescription": "sample string 3",
    "ProductSelectionProductId": 1,
    "ItemQuantity": 4.0,
    "ItemPriceExVat": 5.0,
    "ItemPriceIncVat": 6.0,
    "DiscountExVat": 7.0,
    "DiscountIncVat": 8.0,
    "VatTariffId": 1,
    "VatTariffCode": "sample string 9",
    "VatPercentage": null,
    "RowTotalExVat": 10.0,
    "RowTotalIncVat": 11.0,
    "Comment": "sample string 12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInvoiceRow xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InvoiceRow>
    <ProductCode>sample string 1</ProductCode>
    <ProductName>sample string 2</ProductName>
    <ProductDescription>sample string 3</ProductDescription>
    <ProductSelectionProductId>1</ProductSelectionProductId>
    <ItemQuantity>4</ItemQuantity>
    <ItemPriceExVat>5</ItemPriceExVat>
    <ItemPriceIncVat>6</ItemPriceIncVat>
    <DiscountExVat>7</DiscountExVat>
    <DiscountIncVat>8</DiscountIncVat>
    <VatTariffId>1</VatTariffId>
    <VatTariffCode>sample string 9</VatTariffCode>
    <RowTotalExVat>10</RowTotalExVat>
    <RowTotalIncVat>11</RowTotalIncVat>
    <Comment>sample string 12</Comment>
  </InvoiceRow>
  <InvoiceRow>
    <ProductCode>sample string 1</ProductCode>
    <ProductName>sample string 2</ProductName>
    <ProductDescription>sample string 3</ProductDescription>
    <ProductSelectionProductId>1</ProductSelectionProductId>
    <ItemQuantity>4</ItemQuantity>
    <ItemPriceExVat>5</ItemPriceExVat>
    <ItemPriceIncVat>6</ItemPriceIncVat>
    <DiscountExVat>7</DiscountExVat>
    <DiscountIncVat>8</DiscountIncVat>
    <VatTariffId>1</VatTariffId>
    <VatTariffCode>sample string 9</VatTariffCode>
    <RowTotalExVat>10</RowTotalExVat>
    <RowTotalIncVat>11</RowTotalIncVat>
    <Comment>sample string 12</Comment>
  </InvoiceRow>
</ArrayOfInvoiceRow>