Purchase orders

Get a purchase order

Returns the detail of a purchase order by its identifier.

Tool

filmo_purchase_orders_get

Readpurchase-orders:read

purchase-orders:read
120/min
May need an add-on
Server annotation: Read-only
Server annotation: Idempotent

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

{
  "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": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      },
      "etag": "\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
    }
  }
}

generated from the schema

Arguments

purchaseOrderIdstringRequired

Purchase order identifier.

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".