Customer

Customers. Represents a customer entity.

type Customer {
  customerId: Int!
  customerNumber: String!
  customerName: String
  status: String!
  accountReference: String
  parentCustomer: Int
  currencyId: String
  customerClassId: String!
  customerClassDescription: String
  creditVerification: String
  creditLimit: Decimal!
  creditDaysPastDue: Int
  billAddressId: Int
  billContactId: Int
  attributesId: String
  printInvoices: Boolean!
  acceptAutoInvoices: Boolean
  sendInvoicesByEmail: Boolean!
  printStatements: Boolean!
  sendStatementsByEmail: Boolean!
  printMultiCurrencyStatements: Boolean!
  statementType: String
  printDunningLetters: Boolean
  sendDunningLettersViaEmail: Boolean
  invoiceToDefaultLocation: Boolean
  excludeDebtCollection: Boolean
  defaultPaymentMethodId: String
  vatRegistrationId: String @deprecated
  corporateId: String @deprecated
  note: String
  creditTermsId: String
  mainLocationId: Int
  mainAddressId: Int
  mainContactId: Int
  lastModifiedDateTime: DateTime!
  createdDateTime: DateTime!
  deletedDatabaseRecord: Boolean!
  companyId: Int!
  id: String!
  createdInDataMartDateTime: DateTime!
  updatedInDataMartDateTime: DateTime!
}

Fields

Customer.customerId ● Int! non-null scalar

customerId > (PK) The unique identifier of the customer.

Customer.customerNumber ● String! non-null scalar

customerNumber > The code of the customer.

Customer.customerName ● String scalar

customerName > The name of the customer.

Customer.status ● String! non-null scalar

status > The current status of the customer.

Customer.accountReference ● String scalar

accountReference > The account reference associated with the customer.

Customer.parentCustomer ● Int scalar

parentCustomer > The unique identifier of the parent business account associated with the customer.

Customer.currencyId ● String scalar

currencyId > The currency identifier used by the customer.

Customer.customerClassId ● String! non-null scalar

customerClassId > The class identifier of the customer.

Customer.customerClassDescription ● String scalar

customerClassDescription > The class description of the customer.

Customer.creditVerification ● String scalar

creditVerification > The credit verification rule applied to the customer. Possible values: Disabled, CreditLimit, DaysPastDue, LimitAndDaysPastDue.

Customer.creditLimit ● Decimal! non-null scalar

creditLimit > The credit limit assigned to the customer.

Customer.creditDaysPastDue ● Int scalar

creditDaysPastDue > The maximum number of days past due for the customer's credit.

Customer.billAddressId ● Int scalar

billAddressId > The billing address associated with the customer.

Customer.billContactId ● Int scalar

billContactId > The billing contact associated with the customer.

Customer.attributesId ● String scalar

attributesId > Links to the attributes (CSAnswers) associated with the customer.

Customer.printInvoices ● Boolean! non-null scalar

printInvoices > If set to true, indicates that invoices should be printed for the customer.

Customer.acceptAutoInvoices ● Boolean scalar

acceptAutoInvoices > Accept Autoinvoices - business route.

Customer.sendInvoicesByEmail ● Boolean! non-null scalar

sendInvoicesByEmail > If set to true, indicates that customer invoices should be sent by email to the customer.

Customer.printStatements ● Boolean! non-null scalar

printStatements > If set to true, indicates that customer statements should be printed for the customer.

Customer.sendStatementsByEmail ● Boolean! non-null scalar

sendStatementsByEmail > If set to true, indicates that customer statements should be sent to the customer by email.

Customer.printMultiCurrencyStatements ● Boolean! non-null scalar

printMultiCurrencyStatements > If set to true, indicates that customer statements should be generated for the customer in multi-currency format.

Customer.statementType ● String scalar

statementType > The type of customer statements generated for the customer. Possible values: OpenItem, BalanceBroughtForward.

Customer.printDunningLetters ● Boolean scalar

printDunningLetters > If set to true, indicates that dunning letters should be printed for the customer.

Customer.sendDunningLettersViaEmail ● Boolean scalar

sendDunningLettersViaEmail > If set to true, indicates that dunning letters should be sent to the customer by email.

Customer.invoiceToDefaultLocation ● Boolean scalar

invoiceToDefaultLocation > If set to true, indicates that invoices are addressed to the customer's default location.

Customer.excludeDebtCollection ● Boolean scalar

excludeDebtCollection > If set to true, indicates that the customer is excluded from debt collection (Autocollect).

Customer.defaultPaymentMethodId ● String scalar

defaultPaymentMethodId > The identifier of the customer's default payment method. Links to the PaymentMethods ETL.

Customer.note ● String scalar

note > The text of the note associated with the customer. This field is optional and can be null.

Customer.creditTermsId ● String scalar

creditTermsId > The credit terms identifier associated with the customer.

Customer.mainLocationId ● Int scalar

mainLocationId > The unique identifier of the main location associated with the customer.

Customer.mainAddressId ● Int scalar

mainAddressId > The unique identifier of the main address associated with the customer.

Customer.mainContactId ● Int scalar

mainContactId > The unique identifier of the main contact associated with the customer.

Customer.lastModifiedDateTime ● DateTime! non-null scalar

lastModifiedDateTime > The last modified date and time of the customer.

Customer.createdDateTime ● DateTime! non-null scalar

createdDateTime > The date and time when the customer record was created.

Customer.deletedDatabaseRecord ● Boolean! non-null scalar

deletedDatabaseRecord > Indicates whether this record has been marked as deleted in the database.

Customer.companyId ● Int! non-null scalar

companyId > (PK) The unique identifier of the company.

Customer.id ● String! non-null scalar

id > The unique identifier of the document in DataMart.

Customer.createdInDataMartDateTime ● DateTime! non-null scalar

createdInDataMartDateTime > The UTC DateTime when this document has been added to DataMart.

Customer.updatedInDataMartDateTime ● DateTime! non-null scalar

updatedInDataMartDateTime > The UTC DateTime when this document has been updated in DataMart.

Show deprecatedHide deprecated

Customer.vatRegistrationId ● String deprecated scalar

DEPRECATED

The value for this field is available in the Locations ETL. This property will be removed in the future.

vatRegistrationId > The customer VAT Registration ID.

Customer.corporateId ● String deprecated scalar

DEPRECATED

The value for this field is available in the Locations ETL. This property will be removed in the future.

corporateId > The corporate identifier associated with the customer.

Returned By

customers query