N1Developer docsv1

TYPE REFERENCE

InvoiceEdge

Referenced by 1 generated operations.

Documented fields

  • cursorString!Required

    Opaque position of this row in the list.

    Example: "WyIyMDI2LTEwLTA5IiwiMDE5MmYwYzEtMDAwMC03MDAwLTgwMDAtMDAwMDAwYjEwMDAxIl0"

  • nodeInvoice!Required

    The Invoice.

    Example: {"id":"0192f0c1-0000-7000-8000-000000b10001","number":"DPW/26-27/0012","customerName":"Alpha Auto Components 1","part":"Flange 120","status":"NEW","issuedAt":"2026-10-09","dueDate":"2026-11-08","totals":{"total":84960},"payment":null}

    Show children
    • createdAtString!Required

      UTC time the invoice was made.

    • customerIdID!Required

      The customer (see customer).

    • customerNameString!Required

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

      Example: "Alpha Auto Components 1"

    • discountInt!Required

      Paise discount asked for. The amount applied is totals.discount.

    • dueDateString!Required

      Payment due date, YYYY-MM-DD. Defaults to the issue date plus the customer’s payment terms.

      Example: "2026-11-08"

    • gstRateFloat!Required

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

    • idID!Required

      Stable id (UUIDv7).

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

    • issuedAtString!Required

      Invoice date, YYYY-MM-DD.

      Example: "2026-10-09"

    • jobCardIdIDOptional

      The job card this was raised from (see jobCard); null for a manual invoice.

    • lines[BillingLine!]!Required

      The priced operations, in the order given.

      Show children
      • amountFloat!Required

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

      • descriptionString!Required

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

      • idID!Required

        Stable id (UUIDv7).

      • minutesPerPieceFloat!Required

        Machine minutes for one piece.

      • operationString!Required

        The operation priced, such as Turning.

      • ratePerMinuteInt!Required

        Paise per machine minute.

      • setupMinutesFloat!Required

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

    • notesStringOptional

      Printed on the invoice.

    • numberString!Required

      The invoice number. Assigned by the server; gaps never happen.

      Example: "DPW/26-27/0012"

    • orderIdIDOptional

      The order this bills (see order).

    • partString!Required

      Part name or number.

      Example: "Flange 120"

    • paymentPaymentOptional

      Set once the invoice is paid; null before that.

      Example: null

      Show children
      • paidOnString!Required

        The day the money arrived, YYYY-MM-DD.

      • receivedAmountInt!Required

        Paise actually received: the invoice total less tdsAmount.

      • tdsAmountInt!Required

        Paise the customer deducted as tax at source; 0 when none.

      • tdsSectionStringOptional

        The income-tax section the deduction was made under, such as 194C.

    • poAmountIntOptional

      Paise: the amount on the customer’s PO, to compare against totals.total.

    • quantityInt!Required

      Pieces billed.

    • quoteIdIDOptional

      The quote this was priced from, if any (see quote).

    • routeCardStringOptional

      The route card number printed on the job card.

    • statusInvoiceStatus!Required

      NEW, OVERDUE or PAID. Derived from payment and dueDate.

      Example: "NEW"

      • NEWIssued, not paid, and not yet past its due date.
      • OVERDUENot paid and past its due date.
      • PAIDA payment has been recorded.
    • totalsTotals!Required

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

      Example: {"total":84960}

      Show children
      • cgstFloat!Required

        Central GST; 0 unless supply is INTRA.

      • discountFloat!Required

        The discount applied. Never more than the subtotal.

      • gstFloat!Required

        Total GST: cgst + sgst + igst.

      • gstRateFloat!Required

        The GST percentage applied; 0 when supply is NONE.

      • igstFloat!Required

        Integrated GST; 0 unless supply is INTER.

      • sgstFloat!Required

        State GST; 0 unless supply is INTRA.

      • subtotalFloat!Required

        Sum of the line amounts.

      • supplyGstSupply!Required

        Whether CGST + SGST or IGST applies.

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

      • totalFloat!Required

        Taxable plus GST.

        Example: 84960

    • updatedAtString!Required

      UTC time of the last change.

Used by

Search documentation

Search operations, types and errors from the generated contract.