Skip to navigation

get_customers

List, get or search customers. Entitlements, contacts, seats, shipping addresses, VAT check

Live server: available on mcp.solvimon.com as well as on the test server.

Read-only access to customers and what hangs off them. Customers are the legal counterparties on invoices.

Actions: list, get, search, entitlements, contacts, contact, seat_assignments, shipping_addresses, validate_tax_id

  • get resolves a reference as well as an id.
  • search takes a body of search_fields and filter_fields. search_fields does a substring match on name, reference, email or custom field value. filter_fields does an exact match on status, role, type, id, parent_customer_id, processing_only or custom_field. type, id, parent_customer_id, processing_only and custom_field take a single value, not values. Paging and ordering go in filter.
  • entitlements returns the feature values from the customer’s active pricing plan, including per-subscription overrides.
  • contacts lists the people at a customer who receive its invoices or sign its quotes, with receives_invoice_email. contact reads one.
  • seat_assignments shows who holds the seats of a parent customer’s per-seat items.
  • validate_tax_id checks VAT numbers against VIES without storing anything. UNKNOWN means VIES couldn’t answer, not that the number is wrong.
Search active customers
{
"action": "search",
"body": {
"search_fields": [{"value": "acme"}],
"filter_fields": [{"name": "status", "values": ["ACTIVE"]}]
},
"filter": {"limit": "15"}
}
Check a VAT number
{"action": "validate_tax_id", "country": "NL", "tax_ids": [{"id": "NL859048767B01"}]}

Customers have no top-level name. Organizations have organization.legal_name. To identify an individual, use email. reference is an external id (often a CRM record id), not a display name.