Customer
A customer: the CRM record every project, contact, subscription and sales invoice hangs off.
- Summary view
- CustomerList, 36 fields. What a list returns by default.
- Detail view
- Customer, 36 fields. The default for a single read and for every write.
- Read with
- api:
read: andcustomers::customers read - Write with
- api:
write: andcustomers::customers create
Soft-deleted, and deleting one cascades to its projects.
Used by
Fields
- Detail only
- Only in the detail view.
- Only with include
- Only when you ask for it with include.
- Server-assigned
- Set by plnnrly, never by a request.
Short customer code, e.g. ACM. Prefixes every work item's issue key, is enforced unique on write, and is one of the fields ?q= searches.
Chip colour as a CSS hex triplet or sextet, e.g. #1d4ed8. A stored value that is not valid hex reads back as #6b7280.
Where the customer sits in the sales lifecycle.
suspectprospectfuture-opportunityactiveinactive
New values may be added.
Country as an ISO 3166-1 alpha-2 code, e.g. NL, as plnnrly writes it. Older records may hold any string.
Latitude, geocoded from the address whenever address, zip or city changes. Not writable.
Longitude, geocoded from the address whenever address, zip or city changes. Not writable.
Payment term in days, as held by the accounting integration. Read by the invoice composer; written only by the Exact sync.
Debtor number in the accounting system. Writing it requires billing_settings::update.
Account identifier in Exact Online, written by the sync.
When the Exact sync last handled this customer, or null if never.
Whether the Exact sync leaves this customer's local address alone although it differs from the one in Exact. Set when a user accepts the difference on the Exact customers screen in plnnrly; not writable.
Responsible account manager. Required on create; unassigned when the user is deleted.
Company type, or null. Company types are your organisation's own list, maintained in plnnrly and not exposed as a collection.
Company size band, or null. Company sizes are your organisation's own list, maintained in plnnrly and not exposed as a collection.
The customer's category. Rendered as {"id": N} until named in ?include=customer_category, and null where none is assigned.
The customer's industry branch. Rendered as {"id": N} until named in ?include=company_branch, and null where none is assigned.
Number of live projects for this customer. Soft-deleted projects are not counted.
Variants
CustomerList 36 fields
What a collection returns, and what ?view=summary returns on a single record.
The same fields as the detail object.
CustomerSummary 3 fields
The embedded form: what you get when another resource carries this one and you did not include it.
Leaves out: color, status, email, phone, address, zip, city, country, lat, lng, founded_at, customer_since, is_vat_exempt, payment_days, debtor_code, exact_account_id, exact_synced_at, exact_keep_local_address, account_manager_id, customer_category_id, company_type_id, company_size_id, company_branch_id, created_at, updated_at, deleted_at, customer_category, company_branch, tags, projects_count, contacts_count, tags_count, links
CustomerLinks 3 fields
The links object on this resource.
Keys: self, projects, contacts
Columns deliberately not published
exact_sync_issuesHolds free-form sync messages with no stable shape, so it has no honest published type. exact_synced_at is published instead, so a client can still tell whether a sync has run.locationNot stored on its own: it combines lat and lng, both of which are published as their own read-only fields.Something wrong or missing on this page? Tell us