N1Developer docsv1

TYPE REFERENCE

Customer

Referenced by 4 generated operations.

Documented fields

  • activityActivityConnection!Required

    Customer activity, newest first.

    Field arguments
    • afterStringOptional

      endCursor of the previous page.

    • beforeStringOptional

      startCursor of the next page, when paging backwards.

    • firstIntOptional

      Page size, 1–100 (default 20).

    • lastIntOptional

      Page size when paging backwards, 1–100.

    Show children
    • edges[ActivityEdge!]!Required

      The rows on this page, in order.

      Show children
      • cursorString!Required

        Opaque position of this row in the list.

      • nodeActivityEntry!Required

        The Activity.

        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.
    • pageInfoPageInfo!Required

      Whether more pages exist, and the cursors to reach them.

      Show children
      • endCursorStringOptional

        Cursor of the last row; pass it as after to get the next page. Null when the page is empty.

      • hasNextPageBoolean!Required

        Whether another page follows this one.

      • hasPreviousPageBoolean!Required

        Whether another page comes before this one.

      • startCursorStringOptional

        Cursor of the first row; pass it as before to page backwards. Null when the page is empty.

    • totalCountInt!Required

      All rows matching the filter and search, not just this page.

  • addressAddress!Required

    Structured app address.

    Show children
    • addressString!Required

      Building and street, app spelling.

    • cityString!Required

      City or town.

    • countryString!Required

      Country; India by default.

    • line1String!Required

      Building, street.

    • line2StringOptional

      Area, landmark.

    • pinCodeString!Required

      Six digit postal code, app spelling.

    • pincodeString!Required

      6-digit PIN code.

    • stateString!Required

      State name.

  • alternateMobileString!Required

    alternateMobile customer detail.

  • billingAddressAddress!Required

    Where invoices go.

    Show children
    • addressString!Required

      Building and street, app spelling.

    • cityString!Required

      City or town.

    • countryString!Required

      Country; India by default.

    • line1String!Required

      Building, street.

    • line2StringOptional

      Area, landmark.

    • pinCodeString!Required

      Six digit postal code, app spelling.

    • pincodeString!Required

      6-digit PIN code.

    • stateString!Required

      State name.

  • contactPersonString!Required

    contactPerson customer detail.

  • contacts[CustomerContact!]!Required

    People at the customer, at most 20.

    Show children
    • designationStringOptional

      Job title.

    • emailStringOptional

      Email address.

    • idID!Required

      Stable id (UUIDv7).

    • nameString!Required

      Full name.

    • phoneStringOptional

      Phone number.

  • createdAtString!Required

    UTC time the customer was added.

  • currentProjectsInt!Required

    currentProjects from dashboard read model.

  • customerSinceString!Required

    First business date, YYYY-MM-DD.

  • emailStringOptional

    Main email.

  • gstinStringOptional

    GSTIN, if registered.

  • idID!Required

    Stable id (UUIDv7).

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

  • mobileString!Required

    mobile customer detail.

  • nameString!Required

    Company name.

    Example: "Cauvery Fasteners 3"

  • notesString!Required

    notes customer detail.

  • outstandingBalanceFloat!Required

    outstandingBalance in integer paise from dashboard read model.

  • paymentTermsDaysInt!Required

    Days after the invoice date that payment is due; 0 = on delivery.

    Example: 45

  • phoneStringOptional

    Main phone.

  • previousProjectsInt!Required

    previousProjects from dashboard read model.

  • shippingAddressAddressOptional

    Where parts go, when different from billing.

    Show children
    • addressString!Required

      Building and street, app spelling.

    • cityString!Required

      City or town.

    • countryString!Required

      Country; India by default.

    • line1String!Required

      Building, street.

    • line2StringOptional

      Area, landmark.

    • pinCodeString!Required

      Six digit postal code, app spelling.

    • pincodeString!Required

      6-digit PIN code.

    • stateString!Required

      State name.

  • statusCustomerStatus!Required

    Whether new orders can be taken.

    • ACTIVEOrders can be taken.
    • INACTIVEKept for history; hidden from pickers. Use this instead of deleting a customer who has orders.
  • totalRevenueFloat!Required

    totalRevenue in integer paise from dashboard read model.

  • typeCustomerType!Required

    Business or individual.

    • BUSINESSA business.
    • INDIVIDUALAn individual.
  • updatedAtString!Required

    UTC time of the last change.

    Example: "2026-10-12T05:00:00.000Z"

Used by

Search documentation

Search operations, types and errors from the generated contract.