TYPE REFERENCE

`JobCard`

Referenced by 8 generated operations.

Documented fields

Required Optional

billingJobCardBilling!Required
Whether the job has been invoiced.
- INVOICEDAn invoice exists for the job.
- NOT_INVOICEDNo invoice yet.
codeString!Required
The label on the paper card (“JOB1”).
Example: "JOB1"
createdAtString!Required
UTC time the card was made.
Example: "2026-09-03T05:00:00.000Z"
customerIdID!Required
The customer (see customer).
Example: "0192f0c1-0000-7000-8000-0000000c0001"
customerNameString!Required
The customer’s name.
Example: "Alpha Auto Components 1"
designApprovalDesignApproval!Required
Whether the drawing is approved. Work is ready only once it is.
Example: "APPROVED"
- APPROVEDThe design is approved.
- PENDINGWaiting for a decision.
- REJECTEDThe design was rejected.
designFileAppFileReferenceOptional
The drawing.
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.
dueDateString!Required
The order’s promised date, YYYY-MM-DD in the shop’s timezone.
Example: "2026-09-30"
idID!Required
Stable id (UUIDv7).
Example: "0192f0c1-0000-7000-8000-000000d2000b"
jobNameStringOptional
Job name.
Example: "Flange 120 batch"
lastActivityAtString!Required
UTC time anything on the card last moved. “Stuck” is measured from here.
Example: "2026-10-12T04:30:00.000Z"
materialStringOptional
Material.
Example: "SS304"
materialQcAcceptance!Required
The incoming material check. Work is ready only once it is accepted.
Example: "REJECTED"
- ACCEPTEDPassed.
- PENDINGWaiting for a decision.
- REJECTEDFailed.
materialSourceMaterialSourceOptional
Where the material comes from; null until it is recorded.
Example: null
- BOUGHT_OUTBought from a supplier.
- IN_HOUSECut from the shop’s own stock.
operations[JobOperation!]!Required
The steps, in order.
Example: [{"id":"0192f0c1-0000-7000-8000-000000d3006f","seq":1,"name":"Drilling","status":"PENDING","operatorId":null,"operatorName":null,"machineId":null,"machineName":null,"startedAt":null,"completedAt":null},{"id":"0192f0c1-0000-7000-8000-000000d30070","seq":2,"name":"Deburring","status":"PENDING","operatorId":null,"operatorName":null,"machineId":null,"machineName":null,"startedAt":null,"completedAt":null},{"id":"0192f0c1-0000-7000-8000-000000d30071","seq":3,"name":"Finishing","status":"PENDING","operatorId":null,"operatorName":null,"machineId":null,"machineName":null,"startedAt":null,"completedAt":null}]
Show children
- completedAtStringOptional
  UTC time the step finished.
  Example: null
- idID!Required
  Stable id (UUIDv7).
  Example: "0192f0c1-0000-7000-8000-000000d3006f"
- machineIdIDOptional
  The machine it runs on, if one is assigned.
  Example: null
- machineNameStringOptional
  That machine’s name.
  Example: null
- nameString!Required
  What the step does.
  Example: "Drilling"
- operatorIdIDOptional
  The operator it is assigned to, if any.
  Example: null
- operatorNameStringOptional
  That operator’s name.
  Example: null
- seqInt!Required
  Order of the step, from 1.
  Example: 1
- startedAtStringOptional
  UTC time the step started.
  Example: null
- statusJobOperationStatus!Required
  Where the step is.
  Example: "PENDING"
  - COMPLETEDFinished.
  - PAUSEDStopped part-way.
  - PENDINGNot started.
  - RUNNINGBeing worked on now.
orderIdID!Required
The work order (see order).
Example: "0192f0c1-0000-7000-8000-000000d00001"
partNameString!Required
Part name.
Example: "Flange 120"
poNumberString!Required
The order’s PO number.
Example: "PO-2026-0001"
priorityOrderPriority!Required
The order’s priority.
Example: "HIGH"
- HIGHAhead of other orders.
- LOWFill gaps in the schedule.
- MEDIUMThe default.
qcHistory[QcRecord!]!Required
Every check made on this card, oldest first.
Show children
- idID!Required
  Stable id (UUIDv7).
- inspectorStringOptional
  Inspector’s name.
- jobCardIdID!Required
  The job card checked.
- jobOperationIdIDOptional
  The step checked; null for a raw material check.
- kindQcKind!Required
  What was checked.
  - MACHINEA finished operation.
  - RMThe raw material, before the first operation.
- operationNameStringOptional
  What the step does; null for a raw material check.
- qrValueString!Required
  The job card’s QR text.
- recordedAtString!Required
  UTC time the check was recorded.
- recordedByIdID!Required
  Who made the check (User.id).
- recordedByNameString!Required
  That person’s name.
- rejectedMaterialRejectedMaterialOptional
  Set on a raw material rejection.
  Show children
  - gradeString!Required
    Raw material grade.
  - heatNumberString!Required
    Heat number.
  - sizeString!Required
    Raw material size.
- remarkStringOptional
  Inspector’s remark.
- reportAppFileReferenceOptional
  The inspection report.
  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.
- resultQcResult!Required
  The outcome.
  - ACCEPTEDRaw material accepted.
  - FAILEDOperation failed.
  - PASSEDOperation passed.
  - REJECTEDRaw material rejected.
- stageString!Required
  Label shown in the app: “Incoming inspection”, “In-process QC” or “Final QC”.
qrValueString!Required
The text printed as a QR code on the card. Unique in the shop; jobCardByQr resolves it.
Example: "JC-00001"
quantityInt!Required
Pieces to make.
Example: 40
quotationAcceptance!Required
Whether the customer accepted the quotation behind this job.
- ACCEPTEDPassed.
- PENDINGWaiting for a decision.
- REJECTEDFailed.
statusJobCardStatus!Required
Worked out from the operations.
Example: "NOT_STARTED"
- COMPLETEDEvery operation is done.
- IN_PROGRESSAt least one operation has started and not every one is done.
- NOT_STARTEDNo operation has started.
- PAUSEDAn operation is paused and none is running.

`JobCard`

Documented fields

Used by

Search documentation