Parts and Labor

Records planned or actual resources used to complete a maintenance Work order.

For example, a Work order may require three hours of Labor, a replacement bearing, and specialist equipment.

Parts and Labor can represent Labor, spare parts, equipment, utilities, chemicals, and other maintenance costs.

The Parts and Labor object

{
  "workOrder": "WO-8830",
  "category": "labour",
  "item": "CREW-MAINT",
  "plannedQuantity": 3,
  "actualQuantity": 3.4,
  "unit": "h",
  "unitValue": 31,
  "at": "2026-08-14T11:20:00+02:00"
}

Fields

Categories

Supported categories are:

Category	Item resource	Purpose
ingredient	Material	Spare parts, consumables, or other maintenance Materials.
labour	Crew	Labor resources.
equipment	Machine	Equipment resources.
expense	Cost line	Other maintenance expenses.
chemical	Material	Chemicals used during maintenance.
water	Cost line	Water use.
energy	Cost line	Energy use.

The API category value remains labour, while public prose uses Labor.

Each category is associated with a corresponding cost Measurement:

Category	Cost measurement
ingredient	ingredient-cost
labour	labour-cost
equipment	equipment-cost
expense	expense-cost
chemical	chemical-cost
water	water-cost
energy	energy-cost

Planned and actual quantities

A Parts and Labor record can contain a planned quantity, an actual quantity, or both.

plannedQuantity describes what was expected.

actualQuantity describes what was actually used.

For example:

{
  "workOrder": "WO-8830",
  "category": "labour",
  "item": "CREW-MAINT",
  "plannedQuantity": 3,
  "actualQuantity": 3.4,
  "unit": "h",
  "unitValue": 31
}

This preserves the two values separately:

Planned: 3.0 h
Actual:  3.4 h
Variance: +0.4 h

Either value can exist without the other. An unplanned resource may contain only actualQuantity, while a resource planned in advance may contain only plannedQuantity until actual use is reported later.

Parts and lot traceability

When a maintenance Material comes from a traceable Lot, include the Lot code:

{
  "workOrder": "WO-8830",
  "category": "ingredient",
  "item": "MAT-GASKET-P3",
  "lot": "IN-260701-088",
  "plannedQuantity": 8,
  "actualQuantity": 8,
  "unit": "pcs",
  "unitValue": 4.2,
  "at": "2026-08-14T11:20:00+02:00"
}

For a lot-tracked Material, lot is required.

Pulse also verifies that the supplied Lot belongs to the Material identified by item.

Actual-use time

at records when the actual resource use occurred.

When actualQuantity is supplied but at is omitted, Pulse associates the actual use internally with the start of the Work order.

The facade still returns:

{
  "at": null
}

when no actual-use timestamp was explicitly submitted.

Relationship to production resource use

Parts and Labor follows the same general planned-versus-actual pattern used elsewhere in the Food & Beverage model:

Production activities
  Planned use
      ↓
  Consumption

Maintenance
  Parts and Labor
      ↓
  plannedQuantity / actualQuantity

For maintenance, both quantities are exposed through the same resource because they belong to the same Work order, category, item, and optional Lot.

API resource

Resource	Base path
Parts and Labor	/manufacturing/food-beverage/v1/parts-and-labour

API methods

Submit parts and Labor

POST /manufacturing/food-beverage/v1/parts-and-labour/insert

Records one planned and/or actual maintenance resource row.

If a row with the same workOrder, category, item, and lot already exists, Pulse synchronizes the supplied values with that row.

Request

POST /manufacturing/food-beverage/v1/parts-and-labour/insert
Content-Type: application/json

{
  "workOrder": "WO-8830",
  "category": "labour",
  "item": "CREW-MAINT",
  "plannedQuantity": 3,
  "actualQuantity": 3.4,
  "unit": "h",
  "unitValue": 31,
  "at": "2026-08-14T11:20:00+02:00"
}

Parameters

Parameter	Type	Required	Description
workOrder	string	yes	Business code of the Work order.
category	string	yes	Resource category.
item	string	yes	Business code of the resource supported by the selected category.
lot	string or null	conditional	Required when item is a lot-tracked Material.
plannedQuantity	number or null	conditional	Planned resource quantity. At least one of plannedQuantity or actualQuantity is required.
actualQuantity	number or null	conditional	Actual resource quantity. At least one of plannedQuantity or actualQuantity is required.
unit	string	yes	Unit of the planned and actual quantities.
unitValue	number or null	no	Cost per unit.
at	string or null	no	Date and time associated with actual use.

Update parts and Labor

PUT /manufacturing/food-beverage/v1/parts-and-labour/update

Updates the row identified by workOrder, category, item, and lot.

Request

PUT /manufacturing/food-beverage/v1/parts-and-labour/update
Content-Type: application/json

{
  "workOrder": "WO-8830",
  "category": "labour",
  "item": "CREW-MAINT",
  "lot": null,
  "plannedQuantity": 3,
  "actualQuantity": 3.6,
  "unit": "h",
  "unitValue": 31,
  "at": "2026-08-14T11:25:00+02:00"
}

Patch parts and Labor

PATCH /manufacturing/food-beverage/v1/parts-and-labour/patch

Partially updates an existing Parts and Labor row.

The row is identified by properties.workOrder, properties.category, properties.item, and properties.lot.

All four key properties must be present. When the row has no Lot, supply:

{
  "lot": null
}

Fields omitted from properties keep their current values.

plannedQuantity, actualQuantity, unitValue, and at can be explicitly cleared by including them with a null value.

Request

PATCH /manufacturing/food-beverage/v1/parts-and-labour/patch
Content-Type: application/json

{
  "properties": {
    "workOrder": "WO-8830",
    "category": "labour",
    "item": "CREW-MAINT",
    "lot": null,
    "actualQuantity": 3.6
  }
}

Parameters

Parameter	Type	Required	Description
properties	object	yes	Fields included in the partial update.
properties.workOrder	string	yes	Work order business code identifying the row.
properties.category	string	yes	Resource category identifying the row.
properties.item	string	yes	Item business code identifying the row.
properties.lot	string or null	yes	Lot component of the composite key. Use null when the row has no Lot.
properties.plannedQuantity	number or null	no	New planned quantity, or null to remove it.
properties.actualQuantity	number or null	no	New actual quantity, or null to remove it.
properties.unit	string	no	New quantity unit.
properties.unitValue	number or null	no	New cost per unit, or null to clear it.
properties.at	string or null	no	New actual-use timestamp, or null to clear the explicitly supplied timestamp.

Retrieve parts and Labor

GET /manufacturing/food-beverage/v1/parts-and-labour/select

Returns the Parts and Labor row identified by its composite business key.

Request

For a row without a Lot:

GET /manufacturing/food-beverage/v1/parts-and-labour/select?workOrder=WO-8830&category=labour&item=CREW-MAINT

For a row with a Lot:

GET /manufacturing/food-beverage/v1/parts-and-labour/select?workOrder=WO-8830&category=ingredient&item=MAT-GASKET-P3&lot=IN-260701-088

Query parameters

Parameter	Type	Required	Description
workOrder	string	yes	Business code of the Work order.
category	string	yes	Resource category.
item	string	yes	Business code of the resource.
lot	string	no	Lot component of the composite key.

List parts and Labor

GET /manufacturing/food-beverage/v1/parts-and-labour/query

Returns Parts and Labor rows matching the supplied filters.

Request

GET /manufacturing/food-beverage/v1/parts-and-labour/query?workOrders=WO-8830&categories=labour

Query parameters

Parameter	Type	Required	Description
workOrders	string or array of strings	no	Limits results to the specified Work orders.
categories	string or array of strings	no	Limits results to the specified resource categories.
items	string or array of strings	no	Limits results to the specified resource business codes.
lots	string or array of strings	no	Limits results to the specified Lot business codes.
from	string	no	Earliest actual-use timestamp to include.
to	string	no	Latest actual-use timestamp to include.

When from or to is supplied, only rows with matching actual use are returned. Planned-only rows are not included in a time-bounded query.

Multiple values can be supplied by repeating the query parameter:

GET /manufacturing/food-beverage/v1/parts-and-labour/query?categories=labour&categories=equipment

Delete parts and Labor

DELETE /manufacturing/food-beverage/v1/parts-and-labour/delete

Deletes both the planned and actual values represented by the Parts and Labor row.

Request

For a row without a Lot:

DELETE /manufacturing/food-beverage/v1/parts-and-labour/delete?workOrder=WO-8830&category=labour&item=CREW-MAINT

For a row with a Lot:

DELETE /manufacturing/food-beverage/v1/parts-and-labour/delete?workOrder=WO-8830&category=ingredient&item=MAT-GASKET-P3&lot=IN-260701-088

Query parameters

Parameter	Type	Required	Description
workOrder	string	yes	Business code of the Work order.
category	string	yes	Resource category.
item	string	yes	Business code of the resource.
lot	string	no	Lot component of the composite key.