Skip to main content
inputCreateScalarCustomFieldCommandRequestInput

Fields

entityType
String!
required

The kind of record the field belongs to. It cannot be changed afterwards. Known keys: 'ITEM', 'CATEGORY', 'CUSTOMER', 'SALES_ORDER', 'SALES_ORDER_LINE_ITEM', 'COMPANY', 'OPERATION', 'PRODUCTION_ITEM', 'PRODUCTION_ORDER', 'RESOURCE'. New keys can be added; handle an unknown key as not known, never as a failure.

dataType
String!
required

The data type of the field. It cannot be changed afterwards. Known keys: 'INTEGER', 'DECIMAL', 'TEXT', 'SHORT_TEXT', 'CHECKBOX', 'URL', 'EMAIL', 'PHONE', 'COUNTRY_ISO', 'PRICE', 'DATE'; a value list is created with 'CreateValueListCustomField'. An unknown key is refused (error code CUSTOM_FIELD_DATA_TYPE_UNKNOWN).

groupName
String!
required

The name of the group the field is displayed under. A name that matches an existing group of the same entity type apart from letter case uses the existing spelling.

name
String!
required

The name of the field. It must be unique among the fields of the same entity type, ignoring letter case.

description
String

An internal description of the field.

displayLocation
String

Where user interfaces show the field. Defaults to the custom fields section. Not available for sales orders and sales order line items. Known keys: 'GENERAL', 'CUSTOM_FIELDS_TAB'. New keys can be added; handle an unknown key as not known, never as a failure.

isRequired
Boolean

Indicates that a value is expected for this field. A hint for user interfaces, not enforced by the API.

isHidden
Boolean

Indicates that user interfaces hide the field.

sortOrder
Int

The position within the group, starting at 1. Defaults to the end of the group; a larger value also places the field at the end.

productGroupRestriction
ProductGroupRestrictionInput

Restricts the field to items of certain product groups in user interfaces; the API does not enforce it when values are written. Only for item fields. Both properties must be given. If omitted, the field applies to all current product groups and to items without a product group; product groups created later are not included.

disableAutomaticWorkflows
Boolean

If true, automatic workflows are not triggered by this call.

idempotencyKey
String

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.