TYPE REFERENCE

`CustomerConnection`

Referenced by 1 generated operations.

Documented fields

Required Optional

edges[CustomerEdge!]!Required
The rows on this page, in order.
Example: [{"cursor":"WyJhbHBoYSBhdXRvIGNvbXBvbmVudHMgMSIsIjAxOTJmMGMxLTAwMDAtNzAwMC04MDAwLTAwMDAwMDBjMDAwMSJd","node":{"id":"0192f0c1-0000-7000-8000-0000000c0001","name":"Alpha Auto Components 1","gstin":"33DEMOA0001A1Z5","phone":"+91 98000 10001","status":"ACTIVE","billingAddress":{"city":"Coimbatore"}}},{"cursor":"WyJhbHBoYSBhdXRvIGNvbXBvbmVudHMgMTkiLCIwMTkyZjBjMS0wMDAwLTcwMDAtODAwMC0wMDAwMDAwYzAwMTMiXQ","node":{"id":"0192f0c1-0000-7000-8000-0000000c0013","name":"Alpha Auto Components 19","gstin":"33DEMOD0019A1Z5","phone":"+91 98000 10019","status":"ACTIVE","billingAddress":{"city":"Chennai"}}},{"cursor":"WyJhbHBoYSBhdXRvIGNvbXBvbmVudHMgMzciLCIwMTkyZjBjMS0wMDAwLTcwMDAtODAwMC0wMDAwMDAwYzAwMjUiXQ","node":{"id":"0192f0c1-0000-7000-8000-0000000c0025","name":"Alpha Auto Components 37","gstin":"33DEMOB0037A1Z5","phone":"+91 98000 10037","status":"ACTIVE","billingAddress":{"city":"Pune"}}}]
Show children
- 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.
pageInfoPageInfo!Required
Whether more pages exist, and the cursors to reach them.
Example: {"hasNextPage":true,"hasPreviousPage":false,"endCursor":"WyJhbHBoYSBhdXRvIGNvbXBvbmVudHMgMzciLCIwMTkyZjBjMS0wMDAwLTcwMDAtODAwMC0wMDAwMDAwYzAwMjUiXQ"}
Show children
- endCursorStringOptional
  Cursor of the last row; pass it as after to get the next page. Null when the page is empty.
  Example: "WyJhbHBoYSBhdXRvIGNvbXBvbmVudHMgMzciLCIwMTkyZjBjMS0wMDAwLTcwMDAtODAwMC0wMDAwMDAwYzAwMjUiXQ"
- hasNextPageBoolean!Required
  Whether another page follows this one.
  Example: true
- hasPreviousPageBoolean!Required
  Whether another page comes before this one.
  Example: false
- 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.
Example: 45

Used by

customersLive