Skip to main content

SaveCustomFieldInput

A field to add, or the new settings of an existing one. The key, kind of record and type of an existing field cannot change.

input SaveCustomFieldInput {
  carryForward: Boolean
  defaultValue: JSON
  editPermission: String
  entity: String!
  group: String
  helpText: JSON
  id: ID
  key: String!
  labels: JSON!
  options: JSON
  placements: [String!]!
  required: Boolean!
  requiredWhen: JSON
  rules: JSON
  showWhen: JSON
  sortOrder: Int
  type: String!
  viewPermission: String
  visibility: String!
}

Fields

`SaveCustomFieldInput.carryForward` ● `Boolean` scalar

Carry the value to the next document (quote to order to invoice) when it has a field with the same key and type. Default false.

`SaveCustomFieldInput.defaultValue` ● `JSON` scalar

The starting value for new records.

`SaveCustomFieldInput.editPermission` ● `String` scalar

Permission needed to change the value.

`SaveCustomFieldInput.entity` ● `String!` non-null scalar

The kind of record, e.g. address.

`SaveCustomFieldInput.group` ● `String` scalar

A heading to group the field under.

`SaveCustomFieldInput.helpText` ● `JSON` scalar

Help text per language.

`SaveCustomFieldInput.id` ● `ID` scalar

The field to change; omit to add a new field.

`SaveCustomFieldInput.key` ● `String!` non-null scalar

Lower-case letters, digits and underscores, starting with a letter.

`SaveCustomFieldInput.labels` ● `JSON!` non-null scalar

The name per language: { [locale]: text }.

`SaveCustomFieldInput.options` ● `JSON` scalar

Choices for select fields.

`SaveCustomFieldInput.placements` ● `[String!]!` non-null scalar

Where the field appears.

`SaveCustomFieldInput.required` ● `Boolean!` non-null scalar

Whether a form that shows the field refuses to save without a value.

`SaveCustomFieldInput.requiredWhen` ● `JSON` scalar

{ field, in }: require only when another field matches.

`SaveCustomFieldInput.rules` ● `JSON` scalar

Length, range or item-count limits.

`SaveCustomFieldInput.showWhen` ● `JSON` scalar

{ field, in }: show only when another field matches.

`SaveCustomFieldInput.sortOrder` ● `Int` scalar

Order among the record's fields; lower comes first. Default 0.

`SaveCustomFieldInput.type` ● `String!` non-null scalar

The field type.

`SaveCustomFieldInput.viewPermission` ● `String` scalar

Permission needed to see the value.

`SaveCustomFieldInput.visibility` ● `String!` non-null scalar

staff, buyer_visible or buyer_editable.

Member Of

saveCustomField mutation

Fields
Member Of