Customers Queries

Access customer records, contact details, payment history, and associated addresses.

Customer — Returns a single customer by id

GraphQL

query GetCustomer($id: ID!) {
  Customer(id: $id) {
    id
    label
    email
    active
    customer_number
    customer_type
    currency { id label }
    default_billing_address { id city country }
    default_shipping_address { id city country }
  }
}

Customers — Returns a paginated list of customers with sorting and filters

GraphQL

query Customers(
  $where: QueryCustomersWhereWhereConditions,
  $orderBy: [QueryCustomersOrderByOrderByClause!],
  $search: String,
  $first: Int,
  $page: Int,
  $trashed: Trashed
) {
  Customers(
    where: $where,
    orderBy: $orderBy,
    search: $search,
    first: $first,
    page: $page,
    trashed: $trashed
  ) {
    paginatorInfo {
      total
      currentPage
    }
    data {
      id
      label
      email
      active
      customer_type
    }
  }
}

---

Available fields

Field	Type	Description
id	Int	Unique identifier.
label	String	Customer name or company name.
first_name	String	Primary contact first name.
last_name	String	Primary contact last name.
email	String	Primary email address.
active	Boolean	Whether the customer is active.
customer_number	String	Internal reference number.
customer_type	CustomerType	Individual or Company.
website	String	Website URL.
phone	String	Primary phone number.
status	String	Current lifecycle status.
notes	String	Public notes for documents.
private_message	String	Internal private notes.
currency	Currency	Preferred billing currency.
location	Location	Primary stock location.
price_level	PriceLevel	Assigned price level.
account_representative	AccountRepresentative	Assigned sales rep.
tax_number	String	VAT or Tax ID.
company_registration_number	String	Commercial registration ID.
discount	Float	Default discount rate.
minimum_order_amount	Float	Minimum purchase amount.
term_of_payment_days	Int	Number of days for payment.
term_of_payment_type	TermModel	Calculation method for due date.
credit_limit	Float	Maximum allowed credit.
current_balance	Float	Current unpaid amount.
last_shipping_cost	Float	Most recent shipping cost recorded.
language	String	Preferred communication language.
tax_type	TaxType	Exclusive or Inclusive tax application.
tax_codes	[TaxCode]	Applied tax configurations.
customer_tags	[CustomerTag]	Labels for segmentation.
addresses	[Address]	List of all linked addresses.
default_billing_address	Address	Default for invoices.
default_shipping_address	Address	Default for deliveries.
employees	[Employee]	List of subsidiary contacts.
integrations	[Integration]	Linked external platforms.
created_at	DateTime	Creation time.
updated_at	DateTime	Last update time.
custom_fields	[EntityCustomField]	Custom fields for this entity.

---

Filters

The following fields can be used in the where parameter:

id, label, first_name, last_name, email, active, company_id, company_registration_number, created_at, updated_at, country, city.

Example Filters:

Field	Example
active	{ "column": "ACTIVE", "operator": "EQ", "value": true }
email	{ "column": "EMAIL", "operator": "LIKE", "value": "[e-mail]" }
country	{ "column": "COUNTRY", "operator": "EQ", "value": "FR" }
created_at	{ "column": "CREATED_AT", "operator": "GTE", "value": "2025-01-01" }
trashed	Filter by trashed status. Accepts ALL, TRASHED, or NOT_TRASHED.

---

PartnerCompany — Returns a single partner company by id

A partner company is a company that is linked to your account through a partnership.

GraphQL

query GetPartnerCompany($id: ID!) {
  PartnerCompany(id: $id) {
    id
    label
    email
    phone
    website
    company_registration_number
    vat_number
    active
  }
}

Field	Type	Description
id	ID!	Unique identifier.
label	String	Company name.
email	String	Email address.
phone	String	Phone number.
website	String	Website URL.
company_number	String	Company registration number.
vat_number	String	VAT number.
active	Boolean	Whether the partner company is active.

---

Sorting

You can sort results using the orderBy parameter:

• id
• label
• first_name
• last_name
• email
• active
• created_at
• updated_at

---

Enums

CustomerType

Value	Description
company	Corporate entity.
individual	Private person.

TermModel

Value	Description
net	Due after X days from document date.
eom	Due at End of Month after X days.
eom_first	Due at End of Month (first day focus).

TaxType

Value	Description
exclusive	Taxes added on top of subtotal.
inclusive	Prices already include taxes.