Skip to main content

setSupplierOrderCustomFields

Merges the given custom fields into the supplier order. The payload is a JSON object keyed by custom field technical name; keys not present in the payload keep their current value, and a key present with value null is stored as null. Only keys defined for supplier orders are accepted. Returns the updated supplier order.

Required scopes​

The token needs the supplier_orders:write access scope.

setSupplierOrderCustomFields(
  id: ID!
  customFields: JSON!
): SupplierOrder!

Arguments​

setSupplierOrderCustomFields.id ● ID! non-null scalar​

ID of the supplier order to update.

setSupplierOrderCustomFields.customFields ● JSON! non-null scalar​

Custom fields to merge, as a JSON object keyed by custom field technical name (e.g. { myField: "value", anotherField: null }).

Type​

SupplierOrder object​

A purchase order raised against a supplier. Carries header data (supplier, currency, warehouse, dates), per-line procurement details, and the totals and tax status used by accounting. Goods are booked in against the supplier order via GoodsReceipt.