Planned use

Defines the resources that an Operation, a subcontract operation, a Job, or a Treatment batch is expected to use.

For example, an Operation may be planned to use 125 kg of a material, two cutting tools, and 6.5 hours of machine time.

Each Planned-use record identifies one specific item, its planned quantity, and optionally its planned cost. In the Excel template, planned use is registered on the Planned use sheet.

The Planned use object

{
  "usedBy": "OP-2026-00417-10",
  "category": "material",
  "item": "STEEL-S355",
  "quantity": 125,
  "unit": "kg",
  "amount": 350
}

Fields

Pulse looks up usedBy among Operations first, then subcontract operations, Jobs, and Treatment batches, and uses the first match.

Planned use for maintenance work is recorded through Parts and labour (shared).

Categories

Categories are not case-sensitive. Other categories are refused.

Each category is recorded against its own cost measurement, for example material-cost for material and scrap-recovery for scrap-credit.

Planned cost

amount is the planned cost of the whole planned quantity, for example 350 for 125 kg at 2.80 per kg. It is a total rather than a price per unit, because the quantity actually used may come from deliveries bought at different prices.

Planned and actual use

Planned use describes what an activity was expected to consume. Actual use is submitted separately through Consumption.

Planned use
    ↓
STEEL-S355 — 125 kg

Actual consumption
    ↓
STEEL-S355 — 131 kg

Keeping the planned and actual records separate allows Pulse to compare expected and actual resource use for the same item.

API resource

API methods

Create planned use

POST /manufacturing/metal-machining/v1/planned-use/insert

Creates a Planned-use record and returns its Pulse identifier. If a record with the same usedBy, category, and item already exists, it is updated instead.

Request

POST /manufacturing/metal-machining/v1/planned-use/insert
Content-Type: application/json

{
  "usedBy": "OP-2026-00417-10",
  "category": "material",
  "item": "STEEL-S355",
  "quantity": 125,
  "unit": "kg",
  "amount": 350
}

Parameters

Update planned use

PUT /manufacturing/metal-machining/v1/planned-use/update

Updates the Planned-use record identified by usedBy, category, and item. If the record does not exist yet, it is created.

An update replaces quantity, unit, and amount. If you leave out amount, it is removed.

Request

PUT /manufacturing/metal-machining/v1/planned-use/update
Content-Type: application/json

{
  "usedBy": "OP-2026-00417-10",
  "category": "material",
  "item": "STEEL-S355",
  "quantity": 130,
  "unit": "kg",
  "amount": 364
}

Parameters

The parameters are the same as for creating planned use.

Patch planned use

PATCH /manufacturing/metal-machining/v1/planned-use/patch

Partially updates an existing Planned-use record.

The record is identified by properties.usedBy, properties.category, and properties.item. All three are required. Fields you leave out keep their current values.

amount cannot be cleared through a patch: a null value keeps the current amount. To remove it, use update.

Request

PATCH /manufacturing/metal-machining/v1/planned-use/patch
Content-Type: application/json

{
  "properties": {
    "usedBy": "OP-2026-00417-10",
    "category": "material",
    "item": "STEEL-S355",
    "quantity": 130
  }
}

Parameters

Retrieve planned use

GET /manufacturing/metal-machining/v1/planned-use/select

Returns the Planned-use record identified by usedBy, category, and item. If no record matches, the response is empty. An unknown usedBy is refused.

Request

GET /manufacturing/metal-machining/v1/planned-use/select?usedBy=OP-2026-00417-10&category=material&item=STEEL-S355

Query parameters

List planned use

GET /manufacturing/metal-machining/v1/planned-use/query

Returns Planned-use records matching the supplied filters.

Request

GET /manufacturing/metal-machining/v1/planned-use/query?usedBy=OP-2026-00417-10&categories=material

Query parameters

Multiple values can be supplied by repeating the query parameter:

GET /manufacturing/metal-machining/v1/planned-use/query?categories=material&categories=tooling

Delete planned use

DELETE /manufacturing/metal-machining/v1/planned-use/delete

Deletes the Planned-use record identified by usedBy, category, and item. If no record matches, nothing happens. An unknown usedBy is refused.

Request

DELETE /manufacturing/metal-machining/v1/planned-use/delete?usedBy=OP-2026-00417-10&category=material&item=STEEL-S355

Query parameters