Skip to main content

Customer

A customer: a partner with the customer role.

type Customer {
  addresses: [Address!]
  assignedSalesRep: CreatedByUser
  assignedSalesRepId: String
  code: String!
  contacts: [Contact!]
  createdAt: DateTime!
  createdByUser: CreatedByUser
  creditLimit: Float!
  currentBalance: Float!
  customerAccount: CustomerAccount
  customerTier: String
  customerTierName: String
  deletedAt: DateTime
  deletedBy: String
  description: String
  displayName: String
  enteredBy: String!
  id: ID!
  industry: String
  legalName: String
  metadata: JSON
  name: String!
  notes: String
  organizationId: String!
  outstandingReceivable: Float
  paymentTerms: String!
  previousSalesRep: CreatedByUser
  previousSalesRepId: String
  reassignmentAcknowledgedAt: DateTime
  registrationNumber: String
  repReassignedAt: DateTime
  roles: [PartnerRole!]!
  status: PartnerStatus!
  tags: [String!]
  taxId: String
  type: String
  updatedAt: DateTime!
  updatedBy: String!
  vendorAccount: VendorAccount
  website: String
}

Fields​

Customer.addresses ● [Address!] list object​

The customer's addresses.

Customer.assignedSalesRep ● CreatedByUser object​

The sales rep who owns the customer.

Customer.assignedSalesRepId ● String scalar​

The ID of the sales rep who owns the customer.

Customer.code ● String! non-null scalar​

The customer code.

Customer.contacts ● [Contact!] list object​

The customer's contacts.

Customer.createdAt ● DateTime! non-null scalar​

When the record was created.

Customer.createdByUser ● CreatedByUser object​

The user who created the customer.

Customer.creditLimit ● Float! non-null scalar​

The credit limit. 0 or less means unlimited.

Customer.currentBalance ● Float! non-null scalar​

The customer's current balance.

Customer.customerAccount ● CustomerAccount object​

The customer-side account details.

Customer.customerTier ● String scalar​

The customer's tier label, set automatically or by hand, for example GOLD or SILVER.

Customer.customerTierName ● String scalar​

The name of the customer's tier.

Customer.deletedAt ● DateTime scalar​

When the record was deleted. Empty while the record is live.

Customer.deletedBy ● String scalar​

The ID of the user who deleted the record.

Customer.description ● String scalar​

What the customer is.

Customer.displayName ● String scalar​

The name to show for the customer.

Customer.enteredBy ● String! non-null scalar​

The ID of the user who created the record.

Customer.id ● ID! non-null scalar​

The unique ID of this record.

Customer.industry ● String scalar​

The customer's industry.

The legal name of the customer.

Customer.metadata ● JSON scalar​

Additional data attached to the record, as JSON.

Customer.name ● String! non-null scalar​

The name of the customer.

Customer.notes ● String scalar​

Notes about the customer.

Customer.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

Customer.outstandingReceivable ● Float scalar​

What the customer still owes: the total outstanding on open sales invoices, in the organization's base currency.

Customer.paymentTerms ● String! non-null scalar​

The payment terms agreed with the customer.

Customer.previousSalesRep ● CreatedByUser object​

The rep the customer was moved away from.

Customer.previousSalesRepId ● String scalar​

The ID of the rep the customer was moved away from.

Customer.reassignmentAcknowledgedAt ● DateTime scalar​

When the previous rep acknowledged the move.

Customer.registrationNumber ● String scalar​

The customer's company registration number.

Customer.repReassignedAt ● DateTime scalar​

When the customer was moved to the current rep.

Customer.roles ● [PartnerRole!]! non-null enum​

The roles of the partner, such as customer or vendor.

Customer.status ● PartnerStatus! non-null enum​

The status of the customer.

Customer.tags ● [String!] list scalar​

Tags on the customer.

Customer.taxId ● String scalar​

The customer's tax ID.

Customer.type ● String scalar​

The kind of customer.

Customer.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Customer.updatedBy ● String! non-null scalar​

The ID of the user who last changed the record.

Customer.vendorAccount ● VendorAccount object​

The vendor-side account details, when the partner is also a vendor.

Customer.website ● String scalar​

The customer's website.

Returned By​

activateCustomer mutation ● adjustCustomerCredit mutation ● convertCustomerToVendor mutation ● createCustomer mutation ● customer query ● customers query ● deactivateCustomer mutation ● removeCustomer mutation ● updateCustomer mutation

Member Of​

CustomersPage object