Custom fields

Goal

Define tenant-governed custom fields on parties, catalog, commerce documents, CRM, support, projects, and other approved scopes — without raw schema changes.

Who it is for

custom_field.view to list; custom_field.manage to create/edit/delete.

Preconditions

• Signed into the correct tenant.
• Know the scope (entity) that should show the field (from GET /custom-fields/scopes).

Steps

1. Open Administration → Customization → Custom Fields.
2. Choose New field (or edit / open detail on a row).
3. Set Applies to (scope), Key (^[a-z0-9_]+$ — stable API key), Label (translatable), Type (text / number / boolean / date / select).
4. Configure Required, Reportable, Searchable, Portal visible, Visibility (internal / public / hidden), Options (for select), Copy to, Active.
5. Save. The field appears on matching forms/grids when the registry includes that scope.

Result

Definitions drive UI inputs and grid columns for that scope. Values validate on the entity save path.

Hard stops

Symptom	Cause	What to do
Unknown custom field scope	Scope not in catalogue	Pick a listed scope
Key validation	Bad characters / duplicate	Use lowercase snake_case unique key
Value 422 on documents	Required / type / option mismatch	Fix the value or loosen required/options
Field missing on form	Wrong scope or inactive	Check Applies to + Active

Related

• Saved reports
• Industry packs
• Document types