Skip to main content

ControlCustomFact

One of the organization's own fields an approval rule can test: a yes/no, select or number field on the checked document or its customer or vendor.

type ControlCustomFact {
  archived: Boolean!
  checkpoints: [String!]!
  entity: String!
  id: String!
  key: String!
  labels: JSON!
  options: [ControlCustomFactOption!]!
  type: String!
}

Fields​

ControlCustomFact.archived ● Boolean! non-null scalar​

An archived field still names itself on the rules that tested it, but no rule can add it or be switched on while testing it.

ControlCustomFact.checkpoints ● [String!]! non-null scalar​

The checkpoints whose rules can test the field: those that check its kind of record or that record's customer or vendor.

ControlCustomFact.entity ● String! non-null scalar​

The kind of record the field belongs to, e.g. sales_order or customer.

ControlCustomFact.id ● String! non-null scalar​

The fact id a condition names: custom:<entity>.<key>, e.g. custom:sales_order.rush.

ControlCustomFact.key ● String! non-null scalar​

The field's stored key.

ControlCustomFact.labels ● JSON! non-null scalar​

The field's name per language, as the organization wrote it: { [locale]: text }.

ControlCustomFact.options ● [ControlCustomFactOption!]! non-null object​

A select field's choices; empty for yes/no and number.

ControlCustomFact.type ● String! non-null scalar​

The fact type, which fixes the operators: boolean (is), choice (is, is_not, in) or number (gt, gte, lt, eq).

Returned By​

controlCustomFacts query