N1Developer docsv1

TYPE REFERENCE

Quote

Referenced by 6 generated operations.

Documented fields

  • createdAtString!Required

    UTC time the quote was made.

    Example: "2026-08-29T04:30:00.000Z"

  • customerIdID!Required

    The customer (see customer).

    Example: "0192f0c1-0000-7000-8000-0000000c0002"

  • customerNameString!Required

    The customer’s name, so a list needs no second call.

    Example: "Bharat Hydraulics 2"

  • gstRateFloat!Required

    The GST percentage asked for. The rate applied is totals.gstRate.

    Example: 12

  • idID!Required

    Stable id (UUIDv7).

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

  • lines[BillingLine!]!Required

    The priced operations, in the order given.

    Example: [{"id":"0192f0c1-0000-7000-8000-000000b30015","operation":"Turning","description":"Pulley 90","minutesPerPiece":2.5,"setupMinutes":30,"ratePerMinute":800,"amount":424000},{"id":"0192f0c1-0000-7000-8000-000000b30016","operation":"Finishing","description":"","minutesPerPiece":0.5,"setupMinutes":0,"ratePerMinute":600,"amount":60000}]

    Show children
    • amountFloat!Required

      Integer paise: (quantity × minutesPerPiece + setupMinutes) × ratePerMinute, rounded half up to a whole paisa. Computed by the server.

      Example: 424000

    • descriptionString!Required

      Free text for the customer; empty when none was given.

      Example: "Pulley 90"

    • idID!Required

      Stable id (UUIDv7).

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

    • minutesPerPieceFloat!Required

      Machine minutes for one piece.

      Example: 2.5

    • operationString!Required

      The operation priced, such as Turning.

      Example: "Turning"

    • ratePerMinuteInt!Required

      Paise per machine minute.

      Example: 800

    • setupMinutesFloat!Required

      One-off machine minutes to set up, charged once per line.

      Example: 30

  • materialStringOptional

    Material to use.

    Example: "EN8"

  • numberString!Required

    The quote number, such as QTN/26-27/0001. Assigned by the server.

    Example: "QTN/26-27/0002"

  • orderIdIDOptional

    The order made from this quote; null until converted (see order).

    Example: null

  • partString!Required

    Part name or number.

    Example: "Pulley 90"

  • quantityInt!Required

    Pieces quoted.

    Example: 200

  • statusQuoteStatus!Required

    DRAFT or SENT. Whether it became an order is orderId.

    Example: "DRAFT"

    • DRAFTBeing prepared; it can still be edited.
    • SENTSent to the customer; no longer editable.
  • totalsTotals!Required

    Subtotal, GST and total, all in paise, worked out by the server.

    Example: {"subtotal":484000,"discount":0,"taxable":484000,"gstRate":12,"supply":"INTER","cgst":0,"sgst":0,"igst":58080,"gst":58080,"total":542080}

    Show children
    • cgstFloat!Required

      Central GST; 0 unless supply is INTRA.

      Example: 0

    • discountFloat!Required

      The discount applied. Never more than the subtotal.

      Example: 0

    • gstFloat!Required

      Total GST: cgst + sgst + igst.

      Example: 58080

    • gstRateFloat!Required

      The GST percentage applied; 0 when supply is NONE.

      Example: 12

    • igstFloat!Required

      Integrated GST; 0 unless supply is INTER.

      Example: 58080

    • sgstFloat!Required

      State GST; 0 unless supply is INTRA.

      Example: 0

    • subtotalFloat!Required

      Sum of the line amounts.

      Example: 484000

    • supplyGstSupply!Required

      Whether CGST + SGST or IGST applies.

      Example: "INTER"

      • INTERDifferent states: IGST.
      • INTRAShop and customer are in the same state: CGST + SGST.
      • NONEThe shop has no GSTIN, so no GST is charged.
    • taxableFloat!Required

      Subtotal less discount.

      Example: 484000

    • totalFloat!Required

      Taxable plus GST.

      Example: 542080

  • updatedAtString!Required

    UTC time of the last change.

    Example: "2026-10-12T04:30:00.000Z"

Used by

Search documentation

Search operations, types and errors from the generated contract.