Purchase orders

Update a purchase order

Changes the header of a purchase order.

Tool

filmo_purchase_orders_update

Writepurchase-orders:write

purchase-orders:write
120/min
May need an add-on
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_purchase_orders_update",
    "arguments": {
      "purchaseOrderId": "purc_8f2a1c",
      "type": "subrental"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "poNumber": "<poNumber>",
      "status": "draft",
      "type": "subrental",
      "isDraft": true,
      "poDate": "2026-09-01T08:00:00Z",
      "supplierId": "supp_8f2a1c",
      "reference": "<reference>",
      "currency": "EUR",
      "subTotal": "1234.50",
      "discountTotal": "1234.50",
      "taxesPrice": "1234.50",
      "netPrice": "1234.50",
      "grossPrice": "1234.50",
      "totalPaid": "1234.50",
      "orderId": "orde_8f2a1c",
      "orderNumber": "<orderNumber>",
      "projectId": "proj_8f2a1c",
      "repairTicketId": "repa_8f2a1c",
      "notes": "<notes>",
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z"
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

type always goes, even if it does not change: the approval flow and the numbering series depend on it. LINES are not touched from here, because they are not published; the server calculates the totals from them. The supplier snapshot, the numbering series and the custom fields are left out of the public body. It requires the purchases add-on (402 without it); a consignment purchase order —the stored type or the one you send is consignment— also requires the consignments add-on, and without it the response is 402 with requiredAddon: consignments and nothing is written. A cancelled purchase order, or one locked in the app, cannot be edited: 409 conflict and nothing is written. Returns the full purchase order, the same projection as its GET.

Arguments

purchaseOrderIdstringRequired

Purchase order identifier.

Limits: min length 1

typestringRequired

Purchase order type.

Available options: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment

supplierIdstring | null

Supplier of the purchase order; null leaves it without a supplier (drafts only).

poDatestring<date-time> | null

Issue date, in ISO 8601 with offset; null clears it.

supplierQuoteRefstring | null

Reference of the supplier quote; null clears it.

Limits: max length 200

referencestring | null

Internal reference of the document; null clears it.

Limits: max length 200

currencystring

Currency, as an ISO 4217 code.

Limits: min length 3, max length 3

projectIdstring | null

Associated project; null unlinks it.

orderIdstring | null

Associated rental order; null unlinks it.

notesstring | null

Notes; null clears them.

Limits: max length 5000

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique purchase order identifier.

poNumberstring | null

Purchase order number; null while it is a draft.

statusstring

Purchase order status.

Available options: draft, pending, completed, cancelled

typestring

Purchase order type.

Available options: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment

isDraftboolean

true if the purchase order is still a draft.

poDatestring<date-time> | null

Purchase order date in ISO 8601 UTC; null if not set.

supplierIdstring | null

Supplier identifier; null while a draft has no supplier. Resolve it against /api/v1/contacts.

referencestring | null

Free-form reference of the purchase order; null if it has none.

currencystring

Currency of the purchase order, as an ISO 4217 code.

subTotalstring

Subtotal before discounts and taxes, as a decimal string "1234.50".