N1Developer docsv1

TYPE REFERENCE

OrderEdge

Referenced by 1 generated operations.

Documented fields

  • cursorString!Required

    Opaque position of this row in the list.

    Example: "WyIyMDI2LTA5LTMwIiwiMDE5MmYwYzEtMDAwMC03MDAwLTgwMDAtMDAwMDAwZDAwMDAxIl0"

  • nodeOrder!Required

    The Order.

    Example: {"id":"0192f0c1-0000-7000-8000-000000d00001","poNumber":"PO-2026-0001","customerName":"Alpha Auto Components 1","partName":"Flange 120","quantity":40,"status":"NEW","priority":"HIGH","dueDate":"2026-09-30"}

    Show children
    • 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.

      Example: "Alpha Auto Components 1"

    • 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-09-30"

    • heatNumberStringOptional

      Heat number.

    • idID!Required

      Stable id (UUIDv7).

      Example: "0192f0c1-0000-7000-8000-000000d00001"

    • 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.

      Example: "Flange 120"

    • 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-0001"

    • 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.

      Example: 40

    • 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: "NEW"

      • 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.

Used by

Search documentation

Search operations, types and errors from the generated contract.