N1Developer docsv1

TYPE REFERENCE

CustomerEdge

Referenced by 1 generated operations.

Documented fields

  • cursorString!Required

    Opaque position of this row in the list.

    Example: "WyJhbHBoYSBhdXRvIGNvbXBvbmVudHMgMSIsIjAxOTJmMGMxLTAwMDAtNzAwMC04MDAwLTAwMDAwMDBjMDAwMSJd"

  • nodeCustomer!Required

    The Customer.

    Example: {"id":"0192f0c1-0000-7000-8000-0000000c0001","name":"Alpha Auto Components 1","gstin":"33DEMOA0001A1Z5","phone":"+91 98000 10001","status":"ACTIVE","billingAddress":{"city":"Coimbatore"}}

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

      • pageInfoPageInfo!Required

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

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

      Example: {"city":"Coimbatore"}

      Show children
      • addressString!Required

        Building and street, app spelling.

      • cityString!Required

        City or town.

        Example: "Coimbatore"

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

      Example: "33DEMOA0001A1Z5"

    • idID!Required

      Stable id (UUIDv7).

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

    • mobileString!Required

      mobile customer detail.

    • nameString!Required

      Company name.

      Example: "Alpha Auto Components 1"

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

    • phoneStringOptional

      Main phone.

      Example: "+91 98000 10001"

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

      Example: "ACTIVE"

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

Used by

Search documentation

Search operations, types and errors from the generated contract.