Customers Queries

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

`Customer` — Returns a single customer by `id`

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

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.
`siret`	String	SIRET number of the company.
`e_invoice_address`	String	Address used on electronic invoices.
`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.
`files`	[File]	Attachments.
`variant_price`	VariantPrice	Variant-specific price for this customer. Requires `variant_id` argument.

`VariantPrice`

Field	Type	Description
`id`	ID	Unique identifier.
`amount`	Float	Price amount.
`currency`	Currency	Currency for this price.
`variant`	Variant	Linked product variant.
`priceable_type`	VariantPriceType	Type of priceable entity (`Customer`, `Supplier`, or `PriceLevel`).
`priceable_id`	Int	Priceable entity ID.
`created_at`	DateTime	Creation time.
`updated_at`	DateTime	Last update time.

Example Query:

query GetCustomerVariantPrice($customerId: ID!, $variantId: ID!) {
  Customer(id: $customerId) {
    id
    label
    variant_price(variant_id: $variantId) {
      id
      amount
      currency { code }
    }
  }
}

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": "%@example.com" }`
`country`	`{ "column": "COUNTRY", "operator": "EQ", "value": "FR" }`
`created_at`	`{ "column": "CREATED_AT", "operator": "GTE", "value": "2025-01-01" }`

Trashed records:

The trashed argument controls whether soft-deleted records are returned. It is a top-level argument of the Customers query, not a where condition:

Value	Effect
`ONLY`	Return only deleted records.
`WITH`	Return both deleted and non-deleted records.
`WITHOUT`	Return only non-deleted records (default).

`EInvoiceDirectoryLines` — Looks up official company details for e-invoicing

Looks up the legal name and addressing details registered for a company, so you can fill the electronic invoicing fields (siret, e_invoice_address) from an authoritative source instead of typing them.

Parameters:

Parameter	Type	Description
`siren`	String!	SIREN of the company to look up (9 digits).

Example Query:

query GetEInvoiceDirectoryLines($siren: String!) {
  EInvoiceDirectoryLines(siren: $siren) {
    addressingIdentifier
    addressingSuffix
    name
    routingIdentifier
    siret
  }
}

Return Type	Description
[EInvoiceDirectoryLine!]!	The directory entries matching this SIREN.

`EInvoiceDirectoryLine`

A single entry returned by the official company directory.

Field	Type	Description
`addressingIdentifier`	String!	Addressing identifier (code and key).
`addressingSuffix`	String	Addressing suffix (cedex, service, etc.).
`name`	String	Registered company name.
`routingIdentifier`	String	Routing identifier used for delivery.
`siret`	String	SIRET number of the establishment.

`PartnerCompany` — Returns a single partner company by `id`

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

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).

`VariantPriceType`

Value	Description
`Customer`	Customer entity.
`Supplier`	Supplier entity.
`PriceLevel`	Price level entity.

`TaxType`

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

Customer — Returns a single customer by id

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

Available fields

VariantPrice

Filters

EInvoiceDirectoryLines — Looks up official company details for e-invoicing

EInvoiceDirectoryLine

PartnerCompany — Returns a single partner company by id