TYPE REFERENCE

`Order`

Referenced by 4 generated operations.

Documented fields

Required Optional

createdAtString!Required
UTC time the order was entered.
customerEmailStringOptional
The customer’s email, for the order screen.
customerIdID!Required
The customer (see customer).
customerNameString!Required
The customer’s name, so a list needs no second call.
dcDateStringOptional
Delivery challan date, YYYY-MM-DD.
dcNoStringOptional
Delivery challan number.
descriptionStringOptional
Description.
designFileAppFileReferenceOptional
The design file.
Show children
- idID!Required
  File id; obtain authorised download URL from files API.
- kindStringOptional
  Document category.
- nameString!Required
  Display filename.
- sizeBytesFloat!Required
  Size in bytes, safe integer.
documents[AppFileReference!]!Required
Attached documents.
Show children
- idID!Required
  File id; obtain authorised download URL from files API.
- kindStringOptional
  Document category.
- nameString!Required
  Display filename.
- sizeBytesFloat!Required
  Size in bytes, safe integer.
drawingNumberStringOptional
Drawing number.
dueDateString!Required
Promised delivery date, YYYY-MM-DD in the shop’s timezone.
Example: "2026-10-20"
heatNumberStringOptional
Heat number.
idID!Required
Stable id (UUIDv7).
Example: "0192f0c1-0000-7000-8000-000000d00003"
jobCardIdIDOptional
The job card made for this order (open it with jobCard).
jobNameStringOptional
Job name.
materialStringOptional
Material to use.
materialSourceMaterialSourceOptional
Where the material comes from; null until chosen.
- BOUGHT_OUTBought from a supplier.
- IN_HOUSECut from the shop’s own stock.
notesStringOptional
Notes.
partNameString!Required
Part name.
partNumberStringOptional
Part number.
poAmountFloatOptional
PO value in paise (integer). Not on the app’s type; shown when entered.
poNumberString!Required
The customer’s PO number.
Example: "PO-2026-0003"
priorityOrderPriority!Required
How urgently to take it.
Example: "HIGH"
- HIGHAhead of other orders.
- LOWFill gaps in the schedule.
- MEDIUMThe default.
projectIdStringOptional
Project id.
quantityInt!Required
Pieces ordered.
quoteIdIDOptional
The quote this order was converted from, if any (see quote).
rawMaterialGradeStringOptional
Raw material grade.
rawMaterialSizeStringOptional
Raw material size.
rmPartNumberStringOptional
Raw material part number.
routeCardNoStringOptional
Route card no.
shopOrderNumberStringOptional
Shop order number.
statusOrderStatus!Required
Worked out from the job card and invoice.
Example: "IN_PROGRESS"
- COMPLETEDProduction is complete and the invoice is paid.
- IN_PROGRESSAt least one operation is running or finished, and not all are.
- NEWEntered; work is not ready to start (design or material not cleared, nobody assigned).
- PAUSEDWork is paused.
- PAYMENT_DUEProduction is complete and the invoice is not paid (or not yet raised).
- YET_TO_STARTReady to start: cleared for work or an operator is assigned, nothing running.
statusHistory[ActivityEntry!]!Required
What happened to the order, oldest first.
Show children
- atString!Required
  UTC ISO timestamp.
- detailStringOptional
  Additional context.
- idID!Required
  Event id.
- labelString!Required
  Activity label.
- toneActivityTone!Required
  Badge tone.
  - DANGERFailure.
  - INFOInformation.
  - NEUTRALNeutral.
  - SUCCESSSuccess.
  - WARNINGWarning.
updatedAtString!Required
UTC time of the last change.
Example: "2026-10-12T04:30:00.000Z"

`Order`

Documented fields

Used by

Search documentation