*REST API › Endpoint reference › Finance › Purchase orders*

# Receive material from a purchase order

> Declares what arrived and in what quantity, line by line.

> **Send your own Idempotency-Key:** A retry without the same key duplicates the effect. Send your own Idempotency-Key and follow the retry table. A 409 or a repeated 500: read the order before retrying.

`newStockReceived` registers NEW inventory, so always send the `Idempotency-Key` header: without it, a retry duplicates the stock. The order may end up partially received. The line identifier is `lineId`. Returns the full purchase order, the same projection as its GET. `meta.receivedLines` says how many lines the call declared as received. A draft or cancelled order responds 409 `conflict`.

`POST /api/v1/purchase-orders/{purchaseOrderId}/receive` — scope `purchase-orders:write`

Scope: `purchase-orders:write` · 120/min · Strict tenancy · Add-on (402) · Idempotency-Key · If-Match · Send your own Idempotency-Key · MCP: `filmo_purchase_orders_receive`

## Authorizations

Bearer API key with the scope below. `purchase-orders:write`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 `validation_error`, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the `Idempotent-Replay: true` header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout. |
| `If-Match` | string | No | Optimistic locking: the `ETag` you read from the resource (or `*`). If the resource changed since, the write is rejected with `412 precondition_failed` before doing anything; read it again and retry. Without the header the write always proceeds. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `purchaseOrderId` | string | Yes | Purchase order identifier. |

## Body

Body schema: `PurchaseOrderReceiveBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `spaceId` | string | No | Warehouse where the material comes in. Defaults to the warehouse of the account. |
| `lines` | object[] | Yes | Received lines. At least one. |
| `lines.lineId` | string | Yes | Purchase order line being received. |
| `lines.receivedQuantity` | number | Yes | Units received for that line. |
| `lines.newStockReceived` | number | No | Of those received, how many register new inventory. |
| `lines.notes` | string | No | Reception notes. |

## Request examples

*Receive material from a purchase order*

**cURL**

```bash
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"
    }
  ]
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/purchase-orders/purc_8f2a1c/receive', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    spaceId: 'spc_almacen_central',
    lines: [
      {
        lineId: 'pol_00317',
        receivedQuantity: 6,
        newStockReceived: 4,
        notes: 'Dos vienen con la caja abierta'
      }
    ]
  })
})
```

**Python**

```python
import uuid
import requests

requests.post(
    "https://app.filmo.io/api/v1/purchase-orders/purc_8f2a1c/receive",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "spaceId": "spc_almacen_central",
      "lines": [
        {
          "lineId": "pol_00317",
          "receivedQuantity": 6,
          "newStockReceived": 4,
          "notes": "Dos vienen con la caja abierta"
        }
      ]
    }
)
```

## Response

Response schema: `PurchaseOrderDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 402 | Add-on required (addon_required): the account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 409 | Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | Precondition failed (precondition_failed): the `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | Idempotency-Key reused (idempotency_key_reused): the same key was used before with a different body. Change the key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Purchase order to a supplier. The amounts are COST amounts, because the object is a purchase. The lines are not published, so the expense cannot be attributed to a specific item of a rental. |
| `data.id` | string | Unique purchase order identifier. |
| `data.poNumber` | string | Purchase order number; null while it is a draft. |
| `data.status` | string | Purchase order status. `draft`, `pending`, `completed`, `cancelled` |
| `data.type` | string | Purchase order type. `subrental`, `stock_purchase`, `resale_purchase`, `consumable_purchase`, `technician`, `transport`, `repair`, `consignment` |
| `data.isDraft` | boolean | true if the purchase order is still a draft. |
| `data.poDate` | string<date-time> | Purchase order date in ISO 8601 UTC; null if not set. |
| `data.supplierId` | string | Supplier identifier; null while a draft has no supplier. Resolve it against `/api/v1/contacts`. |
| `data.reference` | string | Free-form reference of the purchase order; null if it has none. |
| `data.currency` | string | Currency of the purchase order, as an ISO 4217 code. |
| `data.subTotal` | string | Subtotal before discounts and taxes, as a decimal string "1234.50". |
| `data.discountTotal` | string | Discount total, as a decimal string "1234.50". |
| `data.taxesPrice` | string | Tax total, as a decimal string "1234.50". |
| `data.netPrice` | string | Taxable base, as a decimal string "1234.50". |
| `data.grossPrice` | string | Total including taxes, as a decimal string "1234.50". |
| `data.totalPaid` | string | Amount already paid, as a decimal string "1234.50"; null if no payment has been recorded. |
| `data.orderId` | string | Associated rental order; null if it has none. |
| `data.orderNumber` | string | Number of that order; null if it has none. |
| `data.projectId` | string | Associated project; null if it has none. |
| `data.repairTicketId` | string | Repair ticket that originated the purchase; null if it does not come from one. |
| `data.notes` | string | Purchase order notes; null if it has none. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |
| `meta` | object |  |
| `meta.receivedLines` | integer | Lines the call declared as received. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "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
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 402 | `addon_required` | The account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |
| 409 | `conflict` | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | `precondition_failed` | The `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | `idempotency_key_reused` | The same key was used before with a different body. Change the key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/purchase-orders/receive-material-from-a-purchase-order  
Last updated: 2026-10-25