Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

PurchaseOrders

Update a purchase order

Update a purchase order (required scope finance:write)

patch/v1/finance/purchaseOrders/{purchaseOrderId}

Path parameters

purchaseOrderIdinteger required

The id of the purchase order to update

Headers

Customer-Idinteger required

The customer identifier

Request body

deliverySiteContactIdinteger nullable

The unique identifier of the delivery site contact associated with this purchase order, if applicable<br/><br/>Optional: Omit to retain current value or provide null to unset

clientNotesstring nullable

Notes on the purchase order. Length must not exceed 3000 characters when provided.<br/><br/>Optional: Omit to retain current value or provide null to unset

internalNotesstring nullable

Internal notes not visible to the client. Length must not exceed 3000 characters when provided.<br/><br/>Optional: Omit to retain current value or provide null to unset

nominalCodeIdinteger nullable

The unique identifier of the nominal code associated with this purchase order, if applicable.<br/>Validation: When provided and not null must be a positive integer within 32-bit bounds and must exist.<br/><br/>Optional: Omit to retain current value or provide null to unset

departmentCodeIdinteger nullable

The unique identifier of the department code associated with this purchase order, if applicable.<br/>Validation: When provided and not null must be a positive integer within 32-bit bounds and must exist.<br/><br/>Optional: Omit to retain current value or provide null to unset

seriesIdinteger

The unique identifier of the purchase order series. Required if you have PO Series setup, otherwise it must be omitted<br/><br/>Optional: Omit to retain current value

Example request

{
  "deliverySiteContactId": 56789,
  "clientNotes": "Please pay within 30 days",
  "internalNotes": "Follow up in two weeks",
  "nominalCodeId": 45678,
  "departmentCodeId": 23456,
  "seriesId": 1234,
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content