Customers
Commercial party that buys goods or services from the organization.
- API name:
customers - Domain: Parties
- Modules: Sales analytics, Sales, Stores, Services, Finances, Inventory, Manufacturing, Logistics, Human resources, Directory
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | Yes | |
| Group | customergroupId | Reference | ||
| Industry | commercialindustryId | Reference | ||
| Generic | isGeneric | Boolean | Yes | One generic customer per organization. Used for transactions with the general public and has no group, branches, or contacts. |
| Country | countryCode | Constant | Yes | ISO country code for this party. |
| Emails | emails | Email | Emails | ||
| Phones | phones | Phone | Phones | ||
| Links | links | Link | Links | ||
| Tax ID | taxId | Text | ||
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| Branches | customerbranches | References | ||
| Contacts | customercontacts | References | ||
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Group customergroupId | Customer groups | reference |
Industry commercialindustryId | Commercial industries | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event customers.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new customer. | App · API · MCP · CLI |
| Edit | update | Save changes to this customer. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this customer. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · CLI |
| Unblock | unblock | Allow edits and deletion of this customer again. | App · API · CLI |
| Archive | archive | Retire this customer from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this customer to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this customer and the data that belongs with it. This cannot be undone. | App · API · CLI |