Customers
A customer is an organization or account you sell to — the recipient of a sales order. Customers carry the classification, billing, and relationship details that sales reporting and broker commissions are built on.
Key fields
| Field | Meaning |
|---|---|
name | Customer name |
customerTypeId | The customer type (required) |
customerSegmentId | An optional secondary segment |
brokerId | An optional broker who intermediates the relationship |
brokerFeePercent | The broker's commission rate, when a broker is set |
parentCustomerId | An optional parent customer, for hierarchies (chains, banners) |
address, city, state, country, zipCode | Mailing address |
qboId | Optional QuickBooks Online identifier |
notes | Free-form notes |
isActive | Whether the customer is available for new orders |
Relationships
- Classified by a required customer type and an optional segment.
- May roll up to a parent customer, forming a hierarchy.
- May be linked to a broker, which seeds the broker and fee on new sales orders.
- Can have contacts attached (billing, purchasing, and so on).
- Referenced by sales orders.
A customer with sales orders against it can't be deleted; deactivate it instead.
See also
Manage customers through the REST API or the MCP server.