Project earmarks

A quantity of inventory set aside for a project or a project demand.

Fields

The API name is what the API, MCP and the CLI use.

NameAPI nameTypeRequiredDescription
IDidRecord IDYes
ProjectprojectIdReferenceYes
QuantityquantityQuantityYesQuantity in the catalog unit after any unit conversion on the line.
Consumed quantityquantityConsumedQuantityYesQuantity in the catalog unit after any unit conversion on the line.
ItemproductitemIdReference
ItemcustomitemIdReference
DemandprojectdemandIdReference
CatalogcatalogConstantYesFixed option from the allowed set for this field.
UnitcatalogunitUnit
IdentifierinventoryidentifierIdReference
Created bycreatedByUser
Created atcreatedAtDate and TimeYes
Updated byupdatedByUser
Updated atupdatedAtDate and TimeYes
Canceled bycanceledByUser
Canceled atcanceledAtDate and Time
Blocked byblockedByUser
Blocked atblockedAtDate and Time
Archived byarchivedByUser
Archived atarchivedAtDate and Time

Relations

FieldPoints toKind
Project projectIdProjectsreference
Demand projectdemandIdProject demandsreference
Identifier inventoryidentifierIdInventory identifiersreference

Actions

What you can do with a record. Every action also sends the webhook event inventoryearmarks.<action>. Reads (find, get, count) work on every table.

NameAPI nameDescriptionWhere
CreatecreateAdd an new earmark.App · WebMCP · API · MCP · CLI
EditupdateSave changes to this earmark.App · WebMCP · API · CLI
CancelcancelReverse the posted effect of this earmark.App · WebMCP · API · CLI
DeletedeleteDelete this earmark and the data that belongs with it. This cannot be undone.App · WebMCP · API · CLI

States

How a record moves from state to state. Archive and block can happen in any state.

CancelCreatedCanceled