PUT api/Invoice/LineItem

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ID		integer	None.
InvoiceID		integer	None.
ExternalKey	for new lineitems, this should be empty: Filled in by backend service	string	None.
InvoiceDate		date	None.
ExternalProductID		string	None.
InternalProductID		integer	None.
SKU		string	None.
Quantity		decimal number	None.
UnitPrice		decimal number	None.
UnitPrice_IncludingTax		decimal number	None.
Price		decimal number	None.
Tax		decimal number	None.
Discount		decimal number	None.
Note		string	None.
Name		string	None.
Description		string	None.
Brand		string	None.
VariantID		string	None.
DiscountID		integer	None.
Approved		integer	None.
StockOnHand		integer	None.
SpecialOrderStatus		string	None.
FoundInPOS		boolean	None.
LineItemNote		string	None.
LinkedGear		Collection of InvoiceProductToGearLinkModel	None.
LightSpeedDiscounts		Collection of LightSpeedDiscountsModel	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "InvoiceID": 2,
  "ExternalKey": "sample string 3",
  "InvoiceDate": "2025-09-05T16:02:53.9810728+00:00",
  "ExternalProductID": "sample string 5",
  "InternalProductID": 6,
  "SKU": "sample string 7",
  "Quantity": 8.1,
  "UnitPrice": 9.1,
  "UnitPrice_IncludingTax": 10.1,
  "Price": 11.1,
  "Tax": 12.1,
  "Discount": 13.1,
  "Note": "sample string 14",
  "Name": "sample string 15",
  "Description": "sample string 16",
  "Brand": "sample string 17",
  "VariantID": "sample string 18",
  "DiscountID": 19,
  "Approved": 20,
  "StockOnHand": 21,
  "SpecialOrderStatus": "sample string 22",
  "FoundInPOS": true,
  "LineItemNote": "sample string 24",
  "LinkedGear": [
    {
      "ID": 1,
      "InvoiceProductID": 2,
      "GearTypeID": 3,
      "GearType": "sample string 4",
      "IsService": true,
      "IsReplacement": true
    },
    {
      "ID": 1,
      "InvoiceProductID": 2,
      "GearTypeID": 3,
      "GearType": "sample string 4",
      "IsService": true,
      "IsReplacement": true
    }
  ],
  "LightSpeedDiscounts": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "DiscountAmount": 3.1,
      "DiscountPercent": 4.1
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "DiscountAmount": 3.1,
      "DiscountPercent": 4.1
    }
  ]
}

application/xml, text/xml

Sample:

<LineItemModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO">
  <Approved>20</Approved>
  <Brand>sample string 17</Brand>
  <Description>sample string 16</Description>
  <Discount>13.1</Discount>
  <DiscountID>19</DiscountID>
  <ExternalKey>sample string 3</ExternalKey>
  <ExternalProductID>sample string 5</ExternalProductID>
  <FoundInPOS>true</FoundInPOS>
  <ID>1</ID>
  <InternalProductID>6</InternalProductID>
  <InvoiceDate>2025-09-05T16:02:53.9810728+00:00</InvoiceDate>
  <InvoiceID>2</InvoiceID>
  <LightSpeedDiscounts>
    <LightSpeedDiscountsModel>
      <DiscountAmount>3.1</DiscountAmount>
      <DiscountPercent>4.1</DiscountPercent>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </LightSpeedDiscountsModel>
    <LightSpeedDiscountsModel>
      <DiscountAmount>3.1</DiscountAmount>
      <DiscountPercent>4.1</DiscountPercent>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </LightSpeedDiscountsModel>
  </LightSpeedDiscounts>
  <LineItemNote>sample string 24</LineItemNote>
  <LinkedGear>
    <InvoiceProductToGearLinkModel>
      <GearType>sample string 4</GearType>
      <GearTypeID>3</GearTypeID>
      <ID>1</ID>
      <InvoiceProductID>2</InvoiceProductID>
      <IsReplacement>true</IsReplacement>
      <IsService>true</IsService>
    </InvoiceProductToGearLinkModel>
    <InvoiceProductToGearLinkModel>
      <GearType>sample string 4</GearType>
      <GearTypeID>3</GearTypeID>
      <ID>1</ID>
      <InvoiceProductID>2</InvoiceProductID>
      <IsReplacement>true</IsReplacement>
      <IsService>true</IsService>
    </InvoiceProductToGearLinkModel>
  </LinkedGear>
  <Name>sample string 15</Name>
  <Note>sample string 14</Note>
  <Price>11.1</Price>
  <Quantity>8.1</Quantity>
  <SKU>sample string 7</SKU>
  <SpecialOrderStatus>sample string 22</SpecialOrderStatus>
  <StockOnHand>21</StockOnHand>
  <Tax>12.1</Tax>
  <UnitPrice>9.1</UnitPrice>
  <UnitPrice_IncludingTax>10.1</UnitPrice_IncludingTax>
  <VariantID>sample string 18</VariantID>
</LineItemModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InvoiceModel

Name	Description	Type	Additional information
ID		integer	None.
JobcardID		integer	None.
JobCardNo		string	None.
CyclistID		integer	None.
CyclistSalutation		string	None.
BikeID		integer	None.
BikeSalutation		string	None.
SentApproval		boolean	None.
PartnerID		integer	None.
VATRate		decimal number	None.
CurrencySymbol		string	None.
StatusID		integer	None.
SynchStatusID	0 synched, all OK 1 waiting to be synched 2 synch errors occured, will retry 99 synch errors occured, needs a human	integer	None.
LastSynchDate		date	None.
SynchFeedback		string	None.
SynchStatus		string	None.
ExternalKey		string	None.
ExternalRefNo		string	None.
Note		string	None.
Currency		string	None.
EMail		string	None.
Phone		string	None.
Total_Discounts		decimal number	None.
Total_LineItems		decimal number	None.
Total_Tax		decimal number	None.
Total_Price		decimal number	None.
LineItems		Collection of LineItemModel	None.
OrderNeeded		boolean	None.
Payments		decimal number	None.
AskForApproval		boolean	None.
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "JobcardID": 2,
  "JobCardNo": "sample string 3",
  "CyclistID": 4,
  "CyclistSalutation": "sample string 5",
  "BikeID": 6,
  "BikeSalutation": "sample string 7",
  "SentApproval": true,
  "PartnerID": 9,
  "VATRate": 10.1,
  "CurrencySymbol": "sample string 11",
  "StatusID": 12,
  "SynchStatusID": 13,
  "LastSynchDate": "2025-09-05T16:02:53.9810728+00:00",
  "SynchFeedback": "sample string 15",
  "SynchStatus": "sample string 16",
  "ExternalKey": "sample string 17",
  "ExternalRefNo": "sample string 18",
  "Note": "sample string 19",
  "Currency": "sample string 20",
  "EMail": "sample string 21",
  "Phone": "sample string 22",
  "Total_Discounts": 23.1,
  "Total_LineItems": 24.1,
  "Total_Tax": 25.1,
  "Total_Price": 26.1,
  "LineItems": [
    {
      "ID": 1,
      "InvoiceID": 2,
      "ExternalKey": "sample string 3",
      "InvoiceDate": "2025-09-05T16:02:53.9810728+00:00",
      "ExternalProductID": "sample string 5",
      "InternalProductID": 6,
      "SKU": "sample string 7",
      "Quantity": 8.1,
      "UnitPrice": 9.1,
      "UnitPrice_IncludingTax": 10.1,
      "Price": 11.1,
      "Tax": 12.1,
      "Discount": 13.1,
      "Note": "sample string 14",
      "Name": "sample string 15",
      "Description": "sample string 16",
      "Brand": "sample string 17",
      "VariantID": "sample string 18",
      "DiscountID": 19,
      "Approved": 20,
      "StockOnHand": 21,
      "SpecialOrderStatus": "sample string 22",
      "FoundInPOS": true,
      "LineItemNote": "sample string 24",
      "LinkedGear": [
        {
          "ID": 1,
          "InvoiceProductID": 2,
          "GearTypeID": 3,
          "GearType": "sample string 4",
          "IsService": true,
          "IsReplacement": true
        },
        {
          "ID": 1,
          "InvoiceProductID": 2,
          "GearTypeID": 3,
          "GearType": "sample string 4",
          "IsService": true,
          "IsReplacement": true
        }
      ],
      "LightSpeedDiscounts": [
        {
          "ID": 1,
          "Name": "sample string 2",
          "DiscountAmount": 3.1,
          "DiscountPercent": 4.1
        },
        {
          "ID": 1,
          "Name": "sample string 2",
          "DiscountAmount": 3.1,
          "DiscountPercent": 4.1
        }
      ]
    },
    {
      "ID": 1,
      "InvoiceID": 2,
      "ExternalKey": "sample string 3",
      "InvoiceDate": "2025-09-05T16:02:53.9810728+00:00",
      "ExternalProductID": "sample string 5",
      "InternalProductID": 6,
      "SKU": "sample string 7",
      "Quantity": 8.1,
      "UnitPrice": 9.1,
      "UnitPrice_IncludingTax": 10.1,
      "Price": 11.1,
      "Tax": 12.1,
      "Discount": 13.1,
      "Note": "sample string 14",
      "Name": "sample string 15",
      "Description": "sample string 16",
      "Brand": "sample string 17",
      "VariantID": "sample string 18",
      "DiscountID": 19,
      "Approved": 20,
      "StockOnHand": 21,
      "SpecialOrderStatus": "sample string 22",
      "FoundInPOS": true,
      "LineItemNote": "sample string 24",
      "LinkedGear": [
        {
          "ID": 1,
          "InvoiceProductID": 2,
          "GearTypeID": 3,
          "GearType": "sample string 4",
          "IsService": true,
          "IsReplacement": true
        },
        {
          "ID": 1,
          "InvoiceProductID": 2,
          "GearTypeID": 3,
          "GearType": "sample string 4",
          "IsService": true,
          "IsReplacement": true
        }
      ],
      "LightSpeedDiscounts": [
        {
          "ID": 1,
          "Name": "sample string 2",
          "DiscountAmount": 3.1,
          "DiscountPercent": 4.1
        },
        {
          "ID": 1,
          "Name": "sample string 2",
          "DiscountAmount": 3.1,
          "DiscountPercent": 4.1
        }
      ]
    }
  ],
  "OrderNeeded": true,
  "Payments": 28.1,
  "AskForApproval": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<InvoiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO">
  <AskForApproval>true</AskForApproval>
  <BikeID>6</BikeID>
  <BikeSalutation>sample string 7</BikeSalutation>
  <Currency>sample string 20</Currency>
  <CurrencySymbol>sample string 11</CurrencySymbol>
  <CyclistID>4</CyclistID>
  <CyclistSalutation>sample string 5</CyclistSalutation>
  <EMail>sample string 21</EMail>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <ExternalKey>sample string 17</ExternalKey>
  <ExternalRefNo>sample string 18</ExternalRefNo>
  <ID>1</ID>
  <JobCardNo>sample string 3</JobCardNo>
  <JobcardID>2</JobcardID>
  <LastSynchDate>2025-09-05T16:02:53.9810728+00:00</LastSynchDate>
  <LineItems>
    <LineItemModel>
      <Approved>20</Approved>
      <Brand>sample string 17</Brand>
      <Description>sample string 16</Description>
      <Discount>13.1</Discount>
      <DiscountID>19</DiscountID>
      <ExternalKey>sample string 3</ExternalKey>
      <ExternalProductID>sample string 5</ExternalProductID>
      <FoundInPOS>true</FoundInPOS>
      <ID>1</ID>
      <InternalProductID>6</InternalProductID>
      <InvoiceDate>2025-09-05T16:02:53.9810728+00:00</InvoiceDate>
      <InvoiceID>2</InvoiceID>
      <LightSpeedDiscounts>
        <LightSpeedDiscountsModel>
          <DiscountAmount>3.1</DiscountAmount>
          <DiscountPercent>4.1</DiscountPercent>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </LightSpeedDiscountsModel>
        <LightSpeedDiscountsModel>
          <DiscountAmount>3.1</DiscountAmount>
          <DiscountPercent>4.1</DiscountPercent>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </LightSpeedDiscountsModel>
      </LightSpeedDiscounts>
      <LineItemNote>sample string 24</LineItemNote>
      <LinkedGear>
        <InvoiceProductToGearLinkModel>
          <GearType>sample string 4</GearType>
          <GearTypeID>3</GearTypeID>
          <ID>1</ID>
          <InvoiceProductID>2</InvoiceProductID>
          <IsReplacement>true</IsReplacement>
          <IsService>true</IsService>
        </InvoiceProductToGearLinkModel>
        <InvoiceProductToGearLinkModel>
          <GearType>sample string 4</GearType>
          <GearTypeID>3</GearTypeID>
          <ID>1</ID>
          <InvoiceProductID>2</InvoiceProductID>
          <IsReplacement>true</IsReplacement>
          <IsService>true</IsService>
        </InvoiceProductToGearLinkModel>
      </LinkedGear>
      <Name>sample string 15</Name>
      <Note>sample string 14</Note>
      <Price>11.1</Price>
      <Quantity>8.1</Quantity>
      <SKU>sample string 7</SKU>
      <SpecialOrderStatus>sample string 22</SpecialOrderStatus>
      <StockOnHand>21</StockOnHand>
      <Tax>12.1</Tax>
      <UnitPrice>9.1</UnitPrice>
      <UnitPrice_IncludingTax>10.1</UnitPrice_IncludingTax>
      <VariantID>sample string 18</VariantID>
    </LineItemModel>
    <LineItemModel>
      <Approved>20</Approved>
      <Brand>sample string 17</Brand>
      <Description>sample string 16</Description>
      <Discount>13.1</Discount>
      <DiscountID>19</DiscountID>
      <ExternalKey>sample string 3</ExternalKey>
      <ExternalProductID>sample string 5</ExternalProductID>
      <FoundInPOS>true</FoundInPOS>
      <ID>1</ID>
      <InternalProductID>6</InternalProductID>
      <InvoiceDate>2025-09-05T16:02:53.9810728+00:00</InvoiceDate>
      <InvoiceID>2</InvoiceID>
      <LightSpeedDiscounts>
        <LightSpeedDiscountsModel>
          <DiscountAmount>3.1</DiscountAmount>
          <DiscountPercent>4.1</DiscountPercent>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </LightSpeedDiscountsModel>
        <LightSpeedDiscountsModel>
          <DiscountAmount>3.1</DiscountAmount>
          <DiscountPercent>4.1</DiscountPercent>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </LightSpeedDiscountsModel>
      </LightSpeedDiscounts>
      <LineItemNote>sample string 24</LineItemNote>
      <LinkedGear>
        <InvoiceProductToGearLinkModel>
          <GearType>sample string 4</GearType>
          <GearTypeID>3</GearTypeID>
          <ID>1</ID>
          <InvoiceProductID>2</InvoiceProductID>
          <IsReplacement>true</IsReplacement>
          <IsService>true</IsService>
        </InvoiceProductToGearLinkModel>
        <InvoiceProductToGearLinkModel>
          <GearType>sample string 4</GearType>
          <GearTypeID>3</GearTypeID>
          <ID>1</ID>
          <InvoiceProductID>2</InvoiceProductID>
          <IsReplacement>true</IsReplacement>
          <IsService>true</IsService>
        </InvoiceProductToGearLinkModel>
      </LinkedGear>
      <Name>sample string 15</Name>
      <Note>sample string 14</Note>
      <Price>11.1</Price>
      <Quantity>8.1</Quantity>
      <SKU>sample string 7</SKU>
      <SpecialOrderStatus>sample string 22</SpecialOrderStatus>
      <StockOnHand>21</StockOnHand>
      <Tax>12.1</Tax>
      <UnitPrice>9.1</UnitPrice>
      <UnitPrice_IncludingTax>10.1</UnitPrice_IncludingTax>
      <VariantID>sample string 18</VariantID>
    </LineItemModel>
  </LineItems>
  <Note>sample string 19</Note>
  <OrderNeeded>true</OrderNeeded>
  <PartnerID>9</PartnerID>
  <Payments>28.1</Payments>
  <Phone>sample string 22</Phone>
  <SentApproval>true</SentApproval>
  <StatusID>12</StatusID>
  <SynchFeedback>sample string 15</SynchFeedback>
  <SynchStatus>sample string 16</SynchStatus>
  <SynchStatusID>13</SynchStatusID>
  <Total_Discounts>23.1</Total_Discounts>
  <Total_LineItems>24.1</Total_LineItems>
  <Total_Price>26.1</Total_Price>
  <Total_Tax>25.1</Total_Tax>
  <VATRate>10.1</VATRate>
</InvoiceModel>