Órdenes de compra

Obtener una orden de compra

Devuelve el detalle de un pedido de compra por su identificador.

GET

/api/v1/purchase-orders/{purchaseOrderId}

curl https://app.filmo.io/api/v1/purchase-orders/purc_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/purchase-orders/purc_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/purchase-orders/purc_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "purchase_order_9f3a2b",
    "poNumber": "2026-0001",
    "status": "draft",
    "type": "subrental",
    "isDraft": true,
    "poDate": "2026-09-01T08:00:00.000Z",
    "supplierId": "supplier_9f3a2b",
    "reference": "2026-0001",
    "currency": "EUR",
    "subTotal": "120.00",
    "discountTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "totalPaid": "120.00",
    "orderId": "order_9f3a2b",
    "orderNumber": "2026-0001",
    "projectId": "project_9f3a2b",
    "repairTicketId": "repair_ticket_9f3a2b",
    "notes": "Example text.",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// Sin cuerpo.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/addon_required",
  "title": "Add-on required",
  "status": 402,
  "code": "addon_required",
  "detail": "Your plan does not include the add-on this operation requires",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredAddon": "purchases"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "purchase-orders:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generado a partir del esquema

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. purchase-orders:read

Cabeceras

If-None-Matchstring

Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

purchaseOrderIdstringObligatorio

Identificador del pedido de compra.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: PurchaseOrderDto

Sobre: PurchaseOrderResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Pedido de compra a un proveedor. Los importes son importes de COSTE, porque el objeto es una compra. Las líneas no se publican, así que el gasto no se puede atribuir a un artículo concreto de un alquiler.

Mostrar atributos hijos

data.idstring

Identificador único del pedido de compra.

data.poNumberstring | null

Número del pedido de compra; null mientras es un borrador.

data.statusstring

Estado del pedido de compra.

Opciones disponibles: draft, pending, completed, cancelled

data.typestring

Tipo de pedido de compra.

Opciones disponibles: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment

data.isDraftboolean

true si el pedido de compra sigue siendo un borrador.

data.poDatestring<date-time> | null

Fecha del pedido de compra en ISO 8601 UTC; null si no se ha fijado.

data.supplierIdstring | null

Identificador del proveedor; null mientras un borrador no tiene proveedor. Resuélvelo contra /api/v1/contacts.

data.referencestring | null

Referencia de formato libre del pedido de compra; null si no tiene.

data.currencystring

Moneda del pedido de compra, como código ISO 4217.

data.subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50".