PATCH purchase-orders/{purchaseOrderId}/lines

Update multiple purchase order lines. Per-line fields set to null (or omitted) are not changed. A maximum of lines may be supplied per call.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
purchaseOrderId The ID of the Purchase Order integer Required

Body Parameters

The patch body containing the lines to update

PurchaseOrderLinesPatchModel
NameDescriptionTypeAdditional information
Lines The lines to patch. At least one line must be supplied. Collection of PurchaseOrderLinePatchModel None.

Request Formats

application/json, text/json

Sample: 
{
  "Lines": [
    {
      "PurchaseOrderLineID": 1,
      "SinglePrice": 1.0,
      "QtyOrdered": 1,
      "QtyReceived": 1,
      "QtyWrittenOff": 1,
      "TaxRate": 1.0,
      "LineNotes": "sample string 1",
      "RemoveNotes": true
    },
    {
      "PurchaseOrderLineID": 1,
      "SinglePrice": 1.0,
      "QtyOrdered": 1,
      "QtyReceived": 1,
      "QtyWrittenOff": 1,
      "TaxRate": 1.0,
      "LineNotes": "sample string 1",
      "RemoveNotes": true
    }
  ]
}

Response Information

Resource Description

Update multiple purchase order lines. Per-line fields set to null (or omitted) are not changed. A maximum of lines may be supplied per call.

Collection of PurchaseOrderLineModel
NameDescriptionTypeAdditional information
PurchaseOrderLineID Purchase Order Line ID integer None.
ProductID Product ID associated with the line integer None.
ProductSKU Product SKU associated with the line string None.
QtyOrdered Number of units ordered integer None.
QtyReceived Number of units received integer None.
PurchaseOrderDetailsStatus PurchaseOrderDetailsStatusEnum None.
SinglePrice decimal number None.
TaxRate The Tax Rate for the purchase order line item decimal number None.
LineVat decimal number None.
LineTotal decimal number None.
DeliveryStatusID integer None.
DeliveryStatus string None.
QtyWrittenOff decimal number None.
CartonQty integer None.
AddedByUserID integer None.
BookedInByUserID integer None.
TotalUnitsOrdered integer None.
TotalUnitsReceived integer None.
TotalUnitsWrittenOff integer None.
DateReceived The date the purchase order was recieved. date None.
LineNotes Any notes added to the purchase order line. string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "PurchaseOrderLineID": 1,
    "ProductID": 1,
    "ProductSKU": "sample string 2",
    "QtyOrdered": 1,
    "QtyReceived": 1,
    "PurchaseOrderDetailsStatus": "AwaitingProduct",
    "SinglePrice": 1.0,
    "TaxRate": 1.0,
    "LineVat": 1.0,
    "LineTotal": 1.0,
    "DeliveryStatusID": 1,
    "DeliveryStatus": "sample string 3",
    "QtyWrittenOff": 1.0,
    "CartonQty": 4,
    "AddedByUserID": 1,
    "BookedInByUserID": 1,
    "TotalUnitsOrdered": 5,
    "TotalUnitsReceived": 1,
    "TotalUnitsWrittenOff": 1,
    "DateReceived": "2026-06-10T00:47:49.6617399+00:00",
    "LineNotes": "sample string 6"
  },
  {
    "PurchaseOrderLineID": 1,
    "ProductID": 1,
    "ProductSKU": "sample string 2",
    "QtyOrdered": 1,
    "QtyReceived": 1,
    "PurchaseOrderDetailsStatus": "AwaitingProduct",
    "SinglePrice": 1.0,
    "TaxRate": 1.0,
    "LineVat": 1.0,
    "LineTotal": 1.0,
    "DeliveryStatusID": 1,
    "DeliveryStatus": "sample string 3",
    "QtyWrittenOff": 1.0,
    "CartonQty": 4,
    "AddedByUserID": 1,
    "BookedInByUserID": 1,
    "TotalUnitsOrdered": 5,
    "TotalUnitsReceived": 1,
    "TotalUnitsWrittenOff": 1,
    "DateReceived": "2026-06-10T00:47:49.6617399+00:00",
    "LineNotes": "sample string 6"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPurchaseOrderLineModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PurchaseOrderLineModel>
    <PurchaseOrderLineID>1</PurchaseOrderLineID>
    <ProductID>1</ProductID>
    <ProductSKU>sample string 2</ProductSKU>
    <QtyOrdered>1</QtyOrdered>
    <QtyReceived>1</QtyReceived>
    <PurchaseOrderDetailsStatus>AwaitingProduct</PurchaseOrderDetailsStatus>
    <SinglePrice>1</SinglePrice>
    <TaxRate>1</TaxRate>
    <LineVat>1</LineVat>
    <LineTotal>1</LineTotal>
    <DeliveryStatusID>1</DeliveryStatusID>
    <DeliveryStatus>sample string 3</DeliveryStatus>
    <QtyWrittenOff>1</QtyWrittenOff>
    <CartonQty>4</CartonQty>
    <AddedByUserID>1</AddedByUserID>
    <BookedInByUserID>1</BookedInByUserID>
    <TotalUnitsOrdered>5</TotalUnitsOrdered>
    <TotalUnitsReceived>1</TotalUnitsReceived>
    <TotalUnitsWrittenOff>1</TotalUnitsWrittenOff>
    <DateReceived>2026-06-10T00:47:49.6617399+00:00</DateReceived>
    <LineNotes>sample string 6</LineNotes>
  </PurchaseOrderLineModel>
  <PurchaseOrderLineModel>
    <PurchaseOrderLineID>1</PurchaseOrderLineID>
    <ProductID>1</ProductID>
    <ProductSKU>sample string 2</ProductSKU>
    <QtyOrdered>1</QtyOrdered>
    <QtyReceived>1</QtyReceived>
    <PurchaseOrderDetailsStatus>AwaitingProduct</PurchaseOrderDetailsStatus>
    <SinglePrice>1</SinglePrice>
    <TaxRate>1</TaxRate>
    <LineVat>1</LineVat>
    <LineTotal>1</LineTotal>
    <DeliveryStatusID>1</DeliveryStatusID>
    <DeliveryStatus>sample string 3</DeliveryStatus>
    <QtyWrittenOff>1</QtyWrittenOff>
    <CartonQty>4</CartonQty>
    <AddedByUserID>1</AddedByUserID>
    <BookedInByUserID>1</BookedInByUserID>
    <TotalUnitsOrdered>5</TotalUnitsOrdered>
    <TotalUnitsReceived>1</TotalUnitsReceived>
    <TotalUnitsWrittenOff>1</TotalUnitsWrittenOff>
    <DateReceived>2026-06-10T00:47:49.6617399+00:00</DateReceived>
    <LineNotes>sample string 6</LineNotes>
  </PurchaseOrderLineModel>
</ArrayOfPurchaseOrderLineModel>