Customers Mutations

CreateCustomer

Creates a new customer record.

Parameters:

ParameterTypeDescription
inputCustomerInput!All customer data.

Example Query:

mutation CreateCustomer($input: CustomerInput!) {
  CreateCustomer(input: $input) {
    id
    label
    email
    active
  }
}

UpdateCustomer

Updates an existing customer record.

Parameters:

ParameterTypeDescription
idInt!ID of the customer.
inputCustomerInput!Updated fields.

DeleteCustomer

Deletes a single customer.

Parameters:

ParameterTypeDescription
idID!Customer ID.

DeleteCustomers

Deletes multiple customers.

Parameters:

ParameterTypeDescription
ids[ID!]!List of customer IDs.

DisableCustomer

Deactivates a single customer (hidden from active lists).

Parameters:

ParameterTypeDescription
idID!Customer ID.

DisableCustomers

Deactivates multiple customers.

Parameters:

ParameterTypeDescription
ids[ID!]!List of customer IDs.

EnableCustomer

Re-activates a single customer.

Parameters:

ParameterTypeDescription
idID!Customer ID.

EnableCustomers

Re-activates multiple customers.

Parameters:

ParameterTypeDescription
ids[ID!]!List of customer IDs.

DuplicateCustomer

Creates a copy of an existing customer.


GenerateCustomerNumber

Generates the next available sequence number for a new customer.


CreateCustomerAddresses

Adds one or several addresses to a customer.

ParameterTypeDescription
input[AddressInput]!List of addresses to add.

UpdateCustomerAddress / DeleteCustomerAddress

Manage specific addresses linked to a customer.


Input Data Types

CustomerInput

FieldTypeDescription
idIntID for updates.
labelStringCustomer name or company name.
first_nameStringPrimary contact first name.
last_nameStringPrimary contact last name.
emailStringPrimary email address.
addressesCustomerAddressInputInitial addresses list.
customer_numberStringReference number.
customer_typeCustomerTypeIndividual or Company.
websiteStringWebsite URL.
phoneStringPhone number.
statusStringLifecycle status.
notesStringPublic notes.
private_messageStringPrivate internal notes.
currencyCurrencyInputPreferred currency.
location_idIntPrimary location ID.
locationLocationInputLocation details.
price_level_idIntPrice level ID.
price_levelPriceLevelInputPrice level data.
account_representative_idIntRep ID.
account_representativeAccountRepresentativeInputRep data.
tax_numberStringVAT/Tax ID.
company_registration_numberStringRegistration ID.
payment_information_idIntPayment details link ID.
payment_informationPaymentInformationInputPayment details.
discountFloatDefault discount %.
minimum_order_amountFloatMinimum order value.
term_of_payment_daysIntPayment term days.
term_of_payment_typeTermModelTerm calculation logic.
credit_limitFloatMaximum allowed credit.
location_idIntDefault location ID.
locationLocationInputDefault location data.
languageStringPreferred language code.
tax_typeTaxType"exclusive" or "inclusive".
tax_codes[TaxCodeInput]List of applied tax codes.
customer_tags[CustomerTagInput]Segmentation labels.
files[FileInput]Attachments.
order_templatePdfTemplateInputDefault Order PDF design.
shipping_order_templatePdfTemplateInputDefault Shipping PDF design.
invoice_templatePdfTemplateInputDefault Invoice PDF design.
product_return_templatePdfTemplateInputDefault Return PDF design.
credit_note_templatePdfTemplateInputDefault Credit Note PDF design.
refund_templatePdfTemplateInputDefault Refund PDF design.
picking_list_templatePdfTemplateInputDefault Picking PDF design.
estimate_templatePdfTemplateInputDefault Estimate PDF design.
custom_fields[EntityCustomFieldInput]Custom fields for this entity.

CustomerAddressInput

FieldTypeDescription
data[AddressInput]Array of initial addresses.

Enums

CustomerType

Value
company
individual

TermModel

ValueDescription
netDue after X days from document date.
eomDue at End of Month after X days.
eom_firstDue at End of Month (first day focus).

TaxType

ValueDescription
exclusiveTax calculated on top of the net price.
inclusiveTax included in the displayed price.