Órdenes de compra

Recibir material de un pedido de compra

Declara qué ha llegado y en qué cantidad, línea por línea.

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

Ejemplos de petición

curl https://app.filmo.io/api/v1/purchase-orders/purc_8f2a1c/receive \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "spaceId": "spc_almacen_central",
  "lines": [
    {
      "lineId": "pol_00317",
      "receivedQuantity": 6,
      "newStockReceived": 4,
      "notes": "Dos vienen con la caja abierta"
    }
  ]
}'
{
  "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"
  },
  "meta": {
    "receivedLines": 1
  }
}

Generado a partir del esquema

Envía tu propia Idempotency-Key

Un reintento sin la misma clave duplica el efecto. Envía tu propia Idempotency-Key y sigue la tabla de reintentos. Ante un 409 o un 500 repetido, lee el pedido antes de reintentar.

newStockReceived registra inventario NUEVO, así que envía siempre la cabecera Idempotency-Key: sin ella, un reintento duplica el stock. El pedido puede quedar recibido parcialmente. El identificador de la línea es lineId. Devuelve el pedido de compra completo, la misma proyección que su GET. meta.receivedLines indica cuántas líneas declaró la llamada como recibidas. Un pedido en borrador o cancelado responde 409 conflict.

Autorizaciones

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

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

purchaseOrderIdstringObligatorio

Identificador del pedido de compra.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: PurchaseOrderReceiveBody

spaceIdstring

Almacén por el que entra el material. Por defecto, el almacén de la cuenta.

linesobject[]Obligatorio

Líneas recibidas. Al menos una.

Límites: mín. 1 elementos

Mostrar atributos hijos
lines.lineIdstringObligatorio

Línea del pedido de compra que se recibe.

Límites: longitud mín. 1

lines.receivedQuantitynumberObligatorio

Unidades recibidas de esa línea.

Límites: mín. 0

lines.newStockReceivednumber

De los recibidos, cuántos dan de alta inventario nuevo.

Límites: mín. 0

lines.notesstring

Notas de recepción.

Límites: longitud máx. 1000

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: PurchaseOrderDto

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

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

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

Límites: patrón ^-?\d+\.\d{2}$

data.discountTotalstring

Total de descuentos, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

data.taxesPricestring

Total de impuestos, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

data.netPricestring

Base imponible, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

data.grossPricestring

Total con impuestos, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

data.totalPaidstring | null

Importe ya pagado, como cadena decimal "1234.50"; null si no se ha registrado ningún pago.

Límites: patrón ^-?\d+\.\d{2}$

data.orderIdstring | null

Pedido de alquiler asociado; null si no tiene.

data.orderNumberstring | null

Número de ese pedido; null si no tiene.

data.projectIdstring | null

Proyecto asociado; null si no tiene.

data.repairTicketIdstring | null

Ticket de reparación que originó la compra; null si no procede de uno.

data.notesstring | null

Notas del pedido de compra; null si no tiene.

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

data.updatedAtstring<date-time>

Fecha de la última modificación en ISO 8601 UTC.

metaobject

Mostrar atributos hijos
meta.receivedLinesinteger

Líneas que la llamada declaró como recibidas.

meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
402addon_requiredEl plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones