PATCH purchase-orders/{purchaseOrderId}/lines/{lineId}
Updates a single purchase order line. Fields on each line that are left null are not changed.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| purchaseOrderId | The ID of the Purchase Order | integer | Required |
| lineId | The ID of the Purchase Order line to update | integer | Required |
Body Parameters
The patch body containing the fields to update
PurchaseOrderLinePatchModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| PurchaseOrderLineID | The ID of the line to patch. | integer | None. |
| SinglePrice | The unit price of the line. If left null, this will not be modified. | decimal number | None. |
| QtyOrdered | The quantity ordered. If left null, this will not be modified. | integer | None. |
| QtyReceived | The quantity received. If left null, this will not be modified. | integer | None. |
| QtyWrittenOff | The quantity written off. If left null, this will not be modified. | integer | None. |
| TaxRate | The tax rate as a percentage. If left null, this will not be modified. | decimal number | None. |
| LineNotes | Notes on the line. If left null, this will not be modified. | string | None. |
| RemoveNotes | If true, clears the notes on the line (overrides ). | boolean | None. |
Request Formats
application/json, text/json
Sample:
{
"PurchaseOrderLineID": 1,
"SinglePrice": 1.0,
"QtyOrdered": 1,
"QtyReceived": 1,
"QtyWrittenOff": 1,
"TaxRate": 1.0,
"LineNotes": "sample string 1",
"RemoveNotes": true
}
application/xml, text/xml
Sample:
<PurchaseOrderLinePatchModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PurchaseOrderLineID>1</PurchaseOrderLineID> <SinglePrice>1</SinglePrice> <QtyOrdered>1</QtyOrdered> <QtyReceived>1</QtyReceived> <QtyWrittenOff>1</QtyWrittenOff> <TaxRate>1</TaxRate> <LineNotes>sample string 1</LineNotes> <RemoveNotes>true</RemoveNotes> </PurchaseOrderLinePatchModel>
Response Information
Resource Description
Updates a single purchase order line. Fields on each line that are left null are not changed.
PurchaseOrderLineModel| Name | Description | Type | Additional 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": 789,
"ProductSKU": "ABC",
"QtyOrdered": 10,
"QtyReceived": 0,
"PurchaseOrderDetailsStatus": "AwaitingProduct",
"SinglePrice": 1.99,
"LineVat": 1.78,
"LineTotal": 19.99,
"DeliveryStatusID": 1,
"DeliveryStatus": "Pending",
"QtyWrittenOff": 0.0,
"CartonQty": 10,
"AddedByUserID": 1,
"BookedInByUserID": 1,
"TotalUnitsOrdered": 10,
"TotalUnitsReceived": 0,
"TotalUnitsWrittenOff": 0,
"DateReceived": "2026-06-15T06:03:33.584411Z"
}
application/xml, text/xml
Sample:
<PurchaseOrderLineModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PurchaseOrderLineID>789</PurchaseOrderLineID> <ProductID xsi:nil="true" /> <ProductSKU>ABC</ProductSKU> <QtyOrdered>10</QtyOrdered> <QtyReceived>0</QtyReceived> <PurchaseOrderDetailsStatus>AwaitingProduct</PurchaseOrderDetailsStatus> <SinglePrice>1.99</SinglePrice> <TaxRate xsi:nil="true" /> <LineVat>1.78</LineVat> <LineTotal>19.99</LineTotal> <DeliveryStatusID>1</DeliveryStatusID> <DeliveryStatus>Pending</DeliveryStatus> <QtyWrittenOff>0</QtyWrittenOff> <CartonQty>10</CartonQty> <AddedByUserID>1</AddedByUserID> <BookedInByUserID>1</BookedInByUserID> <TotalUnitsOrdered>10</TotalUnitsOrdered> <TotalUnitsReceived>0</TotalUnitsReceived> <TotalUnitsWrittenOff>0</TotalUnitsWrittenOff> <DateReceived>2026-06-15T06:03:33.584411Z</DateReceived> </PurchaseOrderLineModel>