Types: F

Each type links to the repository page that documents it; the types several repositories share are documented below, with their fields.

A B C D E F G H I J L M N O P Q R S T U V W X Y

FeedEmailPreviewFilterTab FeedFilterSender FeedFilterTab FeedPivotReportProfile FeedPreviewFilterTab FeedReportProfileInterface FeedRoleTab FeedsNotificationSettings FeedsNotificationSettingsParams FeedTableReportProfile FeedTag FieldAiGeneralOptions FieldAiGeneralOptionsParams FieldAiOptions FieldAiOptionsParams FieldAiOptionsRelatedRecord FieldAiOptionsRelatedRecordParams FieldAiValueUpdateOptions FieldAiValueUpdateOptionsParams FieldAiValueUpdateSchedule FieldAiValueUpdateScheduleParams FieldDataContainer FieldDataSetItem FieldDataSetRelation FieldDescriptor FieldEntity FieldEntityConnection FieldEntityEdge FieldError FieldFilter FieldFilterInput FieldFilterParams FieldFilterRule FieldFilterRuleParams FieldMappingEntity FieldMappingEntityConnection FieldMappingEntityEdge FieldMappingFilterInput FieldMappingOperation FieldMappingOperationEnum FieldMappingOperationParams FieldMappingOperationTypeEnum FieldMappingOperationTypeEnumFilterInput FieldMappingOrderByInput FieldMappingOrderByNestedInput FieldMappingRepository FieldMappingTemplate FieldMappingTemplateJSONString FieldMappingTemplateParams FieldOperator FieldOptionsProperty FieldOptionsPropertyJSONString FieldOrderByInput FieldOrderByNestedInput FieldPermissionEntity FieldPermissionEntityConnection FieldPermissionEntityEdge FieldPermissionFilterInput FieldPermissionNoFieldBackrefInput FieldPermissionOrderByInput FieldPermissionRepository FieldRepository FieldSequenceEntity FieldSequenceEntityConnection FieldSequenceEntityEdge FieldSequenceFilterInput FieldSequenceOrderByInput FieldSequenceRepository FieldSystemType FieldUseOptions FieldValidator FieldValueOption FieldValueOptionFilterInput FileTypeEnum FileUploadProperty FilterBox FilterBoxInterface FilterBoxParams FilterFieldRuleInterface FilterGroupOperator FilterSiblingBox FinishTargetInput FinishTargetPayload FitnessCustomRule FitnessDescription FitnessDescriptionIndicator FitnessIndicatorSettings FitnessIndicatorSettingsJSONString FitnessIndicatorTypeEnum FitnessIndicatorTypeEnumFilterInput FitnessPeriodEnum FitnessSystemRule Float FloatProperty ForecastBaseValueEnum ForecastColumn ForecastColumnsType ForecastEntity ForecastEntityConnection ForecastEntityEdge ForecastFilterInput ForecastItem ForecastItemValue ForecastListViewOptions ForecastOpenValueTypeEnum ForecastOrderByInput ForecastOwner ForecastPerformanceComparisonType ForecastPerformanceItem ForecastPeriodKind ForecastPeriodOption ForecastPipelineViewOptions ForecastRepository ForecastSchema ForecastTabItem ForecastTrendViewOptions ForecastType ForecastValueComparisonEnum ForeignCurrencyOption Form FormColumn FormContainer FormContainerItemInterface FormContainerItemKind FormField FormItemInterface FormItemKindEnum FormSeparator FormSubsection FormTypeEnum FormTypeEnumFilterInput FormulaValidator FormViewEntity FormViewEntityConnection FormViewEntityEdge FormViewFilterInput FormViewItemColor FormViewItemColorInput FormViewOrderByInput FormViewOrderByNestedInput FormViewRepository FormViewSharingClientRelationEntity FormViewSharingClientRelationEntityConnection FormViewSharingClientRelationEntityEdge FormViewSharingClientRelationFilterInput FormViewSharingClientRelationOrderByInput FormViewSharingClientRelationRepository FormViewSharingSalesUnitRelationEntity FormViewSharingSalesUnitRelationEntityConnection FormViewSharingSalesUnitRelationEntityEdge FormViewSharingSalesUnitRelationFilterInput FormViewSharingSalesUnitRelationOrderByInput FormViewSharingSalesUnitRelationRepository FrozenPaneType

Shared types: F

Types several repositories use, or none does, with their fields and their descriptions.

FeedEmailPreviewFilterTab object isEnabled: Boolean!, hasAttachment: Boolean!, filterBySender: [FeedFilterSender!], filterByPeriod: PeriodOption!

Filter of the email feed: limits the emails shown by attachment, sender and period.

Field	Type	Description
`isEnabled`	Boolean!	Whether the filter is applied. When false, the filter conditions are ignored.
`hasAttachment`	Boolean!	When true, only emails that have an attachment are shown.
`filterBySender`	[FeedFilterSender!]	If null or empty - filter is ignored.
`filterByPeriod`	PeriodOption!	Time period the emails are restricted to.

FeedFilterSender object entity: EntityNameEnum!, id: ID!

Sender whose messages a feed filter keeps: a user, a sales unit or an application.

Field	Type	Description
`entity`	EntityNameEnum!	Type of the sender: Client (a user), SalesUnit or Application; senders of other types are ignored.
`id`	ID!	Identifier of the sender record (of the type given by `entity`) whose feed items are kept by this filter.

FeedPreviewFilterTab object 5 fields: isEnabled, hasAttachment, showOnlyFavorite, …

Filter of a record's feed that narrows the messages shown by attachment, favorite flag, sender and period.

Field	Type	Description
`isEnabled`	Boolean!	Whether the filter is applied. When false, the filter conditions are ignored.
`hasAttachment`	Boolean!	When true, only feed items that have an attachment are shown.
`showOnlyFavorite`	Boolean!	When true, only feed items the current user has marked as favorite are shown.
`filterBySender`	[FeedFilterSender!]	If null or empty - filter is ignored.
`filterByPeriod`	PeriodOption!	Time period the feed items are restricted to.

FieldDescriptor object 37 fields: id, name, nameTranslated, …

Description of a field: its names, type, the access level of the current user and its type-specific settings.

Field	Type	Description
`id`	ID!	Unique identifier of the field.
`name`	String!	Name of the field; a translation key when useLang is true.
`nameTranslated`	String	Field name in the current user's language, taken from nameTranslations. Null when no translation is available for that language.
`nameTranslations`	JSONString!	Map of locale codes to translated field names (e.g. {"en-US": "First name"}). Empty when no translations are defined.
`apiName`	String	Immutable name of the field used in the REST API and integrations; null for fields without an API name.
`graphqlName`	String	Name of the field in the GraphQL API: apiName in camelCase. Null when the field has no apiName.
`entity`	EntityNameEnum	Entity the field belongs to; CustomEntity for custom entities (see entityApiName). Null for fields of an external service (see externalEntity).
`entityApiName`	String	API name of the custom entity the field belongs to; null for fields of other entities.
`externalEntity`	String	Name of the entity in an external service (e.g. HubSpot or Salesforce) when the descriptor describes a field of that service; null for Coevera fields.
`useLang`	Boolean!	When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown.
`primitiveType`	PrimitiveType!	Primitive value type of the field type (e.g. STRING, INT, BOOL, DATE).
`typeId`	String!	Id of the field type (e.g. input, dropdown, currency, lookup).
`type`	TypeEntity!	Field type with its properties, such as whether it is filterable or sortable.
`sourceTypeId`	String!	Type id of the values the field effectively holds: currency for a foreign currency field, the type of the aggregated field for a rollup (integer for a count), the result type of an advanced formula; otherwise the same as typeId.
`sourceFieldId`	ID	Id of the field that provides the values: the base value part of a foreign currency field or the field aggregated by a rollup; otherwise the field itself. Null for a rollup that counts records.
`permissionLevel`	AccessLevelFieldEnum!	Access level of the current user to the field.
`typeEnumClassName`	String	For enum fields, name of the enum type that lists the allowed values (e.g. AccountClassEnum); null for other fields.
`isDeleted`	Boolean!	True when the field is deleted.
`defaultValue`	String	Default value of the field, as text; null when none is set.
`compositeFieldId`	ID	Id of this fields composite parent (main) field.
`dataSetId`	ID	Id of the data set holding the options of a dropdown, radio or multiselect field; null for other fields.
`parentOptionsFieldId`	ID	For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field.
`calcFormula`	String	Formula used to calculate value of this field.
`sequenceSetId`	ID	Id of sequence set used for this fields for auto incremented fields.
`systemRequired`	Boolean	Marks if field is required no matter what form validator says.
`systemReadonly`	Boolean	Marks if field is readonly by default - cannot be updated.
`systemType`	FieldSystemType!	Origin of the field: built-in, created by the space, or derived.
`sharedWithFieldId`	ID	When the field is shared between abstract entities (e.g. Lead and Opportunity), id of the counterpart field on the other entity; null otherwise.
`allowedEntityTypes`	[AllowedEntityType!]!	Entities where field is allowed to be used, for relation fields both left relation entity and right relation entity record is returned. Abstract Entity (e.g. LeadOppty, Activity) are not returned they have to be evaluated by receiver.
`lookup`	LookupProperty	Properties for fields of type lookup. Otherwise null.
`rollup`	RollupProperty	Properties for fields of type rollup. Otherwise null.
`advancedFormula`	AdvancedFormulaProperty	Formula used to calculate value of this field.
`options`	FieldOptionsProperty	Type-specific settings of the field, such as the decimal places of a number or the display of a record card; the union member depends on typeId. Null for types without settings.
`aiOptions`	FieldAiOptions	AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency field types.
`fieldUseOptions`	FieldUseOptions	Describes possible usage of field in application.
`valueOptions`	[FieldValueOption!] (7 args)	Values the field can take, with their labels, e.g. to offer them in a filter. Empty when the field cannot be used in filters. Exactly one of entity or externalEntity must be set.
`relatedEntity`	String	For relation fields, the entity the field points to (e.g. Contact, Account); null for other fields.

FieldFilterParams input 5 fields: operator, formula, filterMainBox, …

Filter definition: conditions on a record type and on related records, grouped in filter boxes and combined with And, Or or a custom formula.

Input field	Type	Description
`operator`	FilterGroupOperator!	How the filter boxes combine — And or Or.
`formula`	String	Optional boolean formula combining the filter boxes by their number.
`filterMainBox`	MainFilterBoxParams!	Primary group of filter conditions.
`filterSiblingBoxes`	[FilterBoxParams!]!	Additional condition groups, combined per operator/formula.
`isEnabled`	Boolean!	When false, the filter is ignored and all records match.

FieldFilterRuleParams input id: UUID, field: String!, operator: FieldOperator, values: [[String]]

Filter condition that compares one field with a set of values.

Input field	Type	Description
`id`	UUID	Identifier of this condition within the filter box. Used to reference the condition from the box formula.
`field`	String!	Identifier of the field this condition is evaluated against.
`operator`	FieldOperator	Comparison applied between the field and the supplied values (for example Is, IsNot, Contains, Between, IsEmpty).
`values`	[[String]]	Values the field is compared against. The outer list holds alternatives combined with OR; the inner list holds the parts of a single value (such as the two bounds of a Between comparison).

FieldMappingRepository object 6 fields: getById, getByIds, getAll, …

Read operations for FieldMapping records.

Field	Type	Description
`getById`	FieldMappingEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[FieldMappingEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[FieldMappingEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	FieldMappingEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getChangedFieldsSinceRevision`	[UUID!]! (2 args)	Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
`getForEntity`	[FieldMappingEntity!]! (2 args)	Returns the field mappings whose source is the given record type, i.e. the mappings used to pre-fill records created from it.

FieldMappingTemplateJSONString scalar scalar

JSON object, sent as a string, conforming to the FieldMappingTemplate type.

FieldOptionsPropertyJSONString scalar scalar

JSON object, sent as a string, conforming to the FieldOptionsProperty type.

FieldOrderByNestedInput input 26 fields: id, isDeleted, modified, …

Sorting by a field of the related Field record. Set exactly one field in each item.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	True when the field is marked as deleted (soft-delete).
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`entityName`	OrderByEnum	Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...). Must be a concrete entity: abstract parents such as LeadOppty or Activity are rejected. To share a field between Lead and Opportunity (or Task and Appointment), create it on one of them and set mapDependency to the other.
`apiName`	OrderByEnum	Immutable and generated name. This name is used for integrations.
`name`	OrderByEnum	User friendly name for field.
`useLang`	OrderByEnum	When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown.
`columnName`	OrderByEnum	Storage column name for the field; used as the filter key in API queries.
`columnSource`	OrderByEnum	Storage origin of the field: on the main entity record, on the custom-field data record, or computed.
`relationId`	OrderByEnum	For relation-typed fields, identifier of the relation kind that connects this entity to the related entity. Empty for non-relation fields.
`relationWithEntityId`	OrderByEnum	For relation-typed fields, the entity the field points to (e.g. Contact, Account). Empty for non-relation fields.
`sharedWithFieldId`	OrderByEnum	When the field is shared between abstract entities (e.g. Lead and Opportunity), id of the counterpart field on the other entity. Empty when the field is not shared.
`systemType`	OrderByEnum	Whether the field is System (built-in, immutable), Protected (built-in, limited changes), or Custom (user-created).
`typeId`	OrderByEnum	Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url
`compositeFieldId`	OrderByEnum	For sub-fields of a composite field (e.g. the value/currency parts of a foreign currency field), id of the parent composite field. Empty for top-level fields.
`dataSetId`	OrderByEnum	Optional custom data set id can be set.
`parentOptionsFieldId`	OrderByEnum	For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field.
`calcFormula`	OrderByEnum	Calculated formula used for fields which supports calculation.
`defaultValue`	OrderByEnum	Value pre-filled into this field on newly created records, as text converted to the field type; empty for no default. Accepted only by field types that support a default value.
`systemRequired`	OrderByEnum	True when the field cannot be made optional (enforced by the platform).
`isPublished`	OrderByEnum	True when the field configuration is published; false while the field exists only as an unpublished draft.
`systemReadonly`	OrderByEnum	True when the field cannot be made writable (enforced by the platform).
`useInGlobalSearch`	OrderByEnum	If this field is allowed in global search.
`isUnique`	OrderByEnum	If true, then there will be an API validation if value of entity is unique.
`sequencePattern`	OrderByEnum	Deprecated - previously returned sequence pattern used for sequence type of field.

FieldPermissionRepository object 7 fields: getById, getByIds, getAll, …

Read operations for FieldPermission records.

Field	Type	Description
`getById`	FieldPermissionEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[FieldPermissionEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[FieldPermissionEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	FieldPermissionEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getPublished`	[FieldPermissionEntity!]! (5 args)	Returns the published records that match the filter, paged with limit and offset.
`getDrafts`	[FieldPermissionEntity!]! (2 args)	Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
`getDraftById`	FieldPermissionEntity! (1 args)	Returns the record with the given id, with its pending unpublished changes applied when a draft exists.

FieldRepository object 7 fields: getById, getByIds, getAll, …

Read operations for Field records.

Field	Type	Description
`getById`	FieldEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[FieldEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[FieldEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	FieldEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getPublished`	[FieldEntity!]! (5 args)	Returns the published records that match the filter, paged with limit and offset.
`getDrafts`	[FieldEntity!]! (2 args)	Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
`getDraftById`	FieldEntity! (1 args)	Returns the record with the given id, with its pending unpublished changes applied when a draft exists.

FieldSequenceRepository object 7 fields: getById, getByIds, getAll, …

Read operations for FieldSequence records.

Field	Type	Description
`getById`	FieldSequenceEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[FieldSequenceEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[FieldSequenceEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	FieldSequenceEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getPublished`	[FieldSequenceEntity!]! (5 args)	Returns the published records that match the filter, paged with limit and offset.
`getDrafts`	[FieldSequenceEntity!]! (2 args)	Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
`getDraftById`	FieldSequenceEntity! (1 args)	Returns the record with the given id, with its pending unpublished changes applied when a draft exists.

FieldSystemType enum SYSTEM, PROTECTED, CUSTOM, VIRTUAL, COMPUTED

Origin of a field: built into Coevera, created by the space, or derived by the server.

Value	Description
`SYSTEM`	Core built-in field the entity always has; it cannot be deleted.
`PROTECTED`	Standard built-in field that cannot be deleted.
`CUSTOM`	Field created by the space's administrators.
`VIRTUAL`	Field whose value is not stored on the record itself but assembled from related data, such as tags or watchers.
`COMPUTED`	Field whose value is calculated and stored by the server; read-only.

FieldUseOptions object 17 fields: isDisplayable, isFilterable, isGroupable, …

Describes possible usage of field in application.

Field	Type	Description
`isDisplayable`	Boolean!	Field can retrieved in result set. E.g. as grid view column.
`isFilterable`	Boolean!	Field can be used in entity filter.
`isGroupable`	Boolean!	Results can be grouped by this field.
`isSortable`	Boolean!	Results can be sorted by this field.
`isDisplayableOnPivot`	Boolean!	True when the field can be used as a row or column of a pivot report.
`isAvailableForAggregation`	Boolean!	True when report results can be aggregated by this field.
`isAvailableForTargetCalculation`	Boolean!	True when the field can be the measured value of a sales target.
`isAvailableForPivotDataField`	Boolean!	True when the field can be a value field of a pivot report; numeric fields only.
`isAvailableForWebresource`	Boolean!	True when the field can be referenced from a Webresource URL template.
`isAvailableForCalculationFormula`	Boolean!	Field can be used in other field's calculation formula
`isAvailableForAdvancedCalcFormula`	Boolean!	Field can be used in advanced calculation formula
`isAvailableForChangeLog`	Boolean!	True when changes to the field's value are recorded in the change log, which also makes the field usable in history reports and change highlighting.
`isAvailableForHistoryReport`	Boolean!	True when the field can be used in history reports, which show how values changed over time.
`isAvailableForAdvancedFormula`	Boolean!	True when the field can be used as an input in an advanced formula on this entity.
`isAvailableForWhiteSpaceComparison`	Boolean!	True when the field can be used to find similar accounts in the product white space analysis.
`isAvailableForMerge`	Boolean!	True when the value of the field can be chosen when merging duplicate records.
`isReadonlyOnRecurrentAppointment`	Boolean!	True when the field cannot be edited on individual occurrences of a recurring appointment.

FieldValidator object 15 fields: required, requiredOnlyOnCurrentStep, minValue, …

Validation rules of a field placed on a form.

Field	Type	Description
`required`	Boolean	When true, the field must be filled in.
`requiredOnlyOnCurrentStep`	Boolean	When true, the field is required only while its own step is the active step of a multi-step form.
`minValue`	String	Minimum accepted value — a number or ISO date depending on the field type.
`maxValue`	String	Maximum accepted value — a number or ISO date depending on the field type.
`formula`	FormulaValidator	Conditional formula that must evaluate to true for the value to be accepted.
`isEmail`	Boolean	When true, the value must be a valid email address.
`isUrl`	Boolean	When true, the value must be a valid URL.
`requiredCombined`	String	Key grouping this field with others, of which at least one must be filled in.
`requiredMinItems`	Int	Minimum number of selections required for a multi-select field.
`isParentAccountRelationType`	Boolean	When true, the relation must point to a parent-account relationship.
`isDaterange`	Boolean	When true, the field accepts a date range rather than a single date.
`intEnum`	[IntEnumItem]	Allowed integer-valued options, as name/value pairs.
`flagEnum`	[IntEnumItem]	Allowed bit-flag options, as name/value pairs.
`nullable`	Boolean	When true, an empty value is explicitly allowed.
`requiredExactlyOne`	Boolean	When true, exactly one field in the combined group must be filled in.

FieldValueOption object 9 fields: value, label, labelTranslated, …

Value a field can take, with its label and color, for example to offer it in a filter.

Field	Type	Description
`value`	String	Value of the option as used in filter conditions and field values, typically the id of the option or of the referenced record.
`label`	String!	Label of the option; a translation key when useLang is true.
`labelTranslated`	String!	Label of the option in the current user's language.
`useLang`	Boolean!	When true, the label is treated as a translation key and resolved through the translation system; otherwise the literal label is shown.
`isDeleted`	Boolean!	True when the option, or the record it points to, is deleted.
`isArchived`	Boolean!	True when the option points to an archived record.
`color`	Int	Color of the option, encoded as an integer; null when the option has no color.
`extraInfo`	String	Secondary line shown under the label. For an option that is a user it is the sign-in email, null when the caller cannot read it. Null for other options.
`pictureUrl`	String	URL of the picture of the option. Set only for an option that is a user, null when the user has no picture.

FieldValueOptionFilterInput input 8 fields: valueIn, value, labelContains, …

Conditions that limit the value options returned for a field.

Input field	Type	Description
`valueIn`	[String!]	Returns only the options with these values.
`value`	String	Returns only the option with this value.
`labelContains`	String	Returns only the options whose label contains this text (case insensitive). For options that are users it matches the words of the name in any order, or any part of the sign-in email; accents are ignored.
`pipelineIds`	[UUID]	For the opportunity step field, returns only the steps of these pipelines.
`leadProcessIds`	[UUID]	For the lead step field, returns only the steps of these lead processes.
`quoteProcessIds`	[UUID]	For the quote step field, returns only the steps of these quote processes.
`excludeArchived`	Boolean	Leaves out options that point to archived records.
`excludeNonArchived`	Boolean	Returns only options that point to archived records.

FilterBox object 5 fields: id, entity, lookupFieldId, …

Group of filter conditions evaluated on records related to the main record type, reached through a lookup field or a predefined relation.

Field	Type	Description
`id`	String!	Identifier of this filter box within the filter tab.
`entity`	String!	Name of the record type whose fields the conditions in this box are evaluated against.
`lookupFieldId`	UUID	Identifier of the lookup field that connects this box to the main record type when the box filters a related record reached through a lookup.
`relation`	HardCodedRelation	Predefined relationship linking this sibling box to the main record type. Null when the box is connected through a lookup field instead.
`filterFields`	[FieldFilterRule!]!	Conditions evaluated on this box, each comparing one field against a set of values.

FilterBoxParams input 5 fields: id, entity, lookupFieldId, …

Group of filter conditions evaluated on records related to the main record type, reached through a lookup field or a predefined relation.

Input field	Type	Description
`id`	String!	Identifier of this filter box within the filter tab.
`entity`	String!	Name of the record type whose fields the conditions in this box are evaluated against.
`lookupFieldId`	UUID	Identifier of the lookup field that connects this box to the main record type when the box filters a related record reached through a lookup.
`relation`	HardCodedRelationParams	Predefined relationship linking this sibling box to the main record type. Null when the box is connected through a lookup field instead.
`filterFields`	[FieldFilterRuleParams!]!	Conditions evaluated on this box, each comparing one field against a set of values.

FilterGroupOperator enum And, Or, Custom

How the conditions of a filter are combined.

Value	Description
`And`	A record must match all conditions.
`Or`	A record must match at least one condition.
`Custom`	Conditions are combined by the custom boolean formula that references them by number.

FitnessDescription object isWon: Boolean!, isArchived: Boolean!, fitness: WarningLevelEnum!, indicators: [FitnessDescriptionIndicator!]!

Fitness of a lead or opportunity: its overall warning level and the indicators that apply to it.

Field	Type	Description
`isWon`	Boolean!	True when the opportunity is won; always false for leads.
`isArchived`	Boolean!	True when the record is archived.
`fitness`	WarningLevelEnum!	Overall fitness of the record: the most severe level among its indicators, Ok when there are none.
`indicators`	[FitnessDescriptionIndicator!]!	Fitness indicators that apply to the record with their current level, most severe first.

FitnessDescriptionIndicator object fitness: WarningLevelEnum!, indicator: EntityFitnessIndicatorEntity!

Current warning level of one fitness indicator for a record.

Field	Type	Description
`fitness`	WarningLevelEnum!	Level the indicator currently reports for the record.
`indicator`	EntityFitnessIndicatorEntity!	Fitness indicator that is evaluated.

FitnessIndicatorSettingsJSONString scalar scalar

JSON object, sent as a string, conforming to the FitnessIndicatorSettings type.

Float scalar scalar

The Float scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).

ForecastColumnsType enum WonValueCurrentPeriod, WonValueSamePeriodInPreviousYear, WonValueSamePeriodInPreviousYearPercentage, WonOpenValueUnweighted, OpenValueUnweighted, OpenValueWeighted, … (13 values)

Value shown in a column of the opportunity forecast table.

Value	Description
`WonValueCurrentPeriod`	Value of opportunities won in the period.
`WonValueSamePeriodInPreviousYear`	Value of opportunities won in the same period one year earlier.
`WonValueSamePeriodInPreviousYearPercentage`	Difference between the current won value and the previous-year won value, as a percentage.
`WonOpenValueUnweighted`	Full value of won and open opportunities.
`OpenValueUnweighted`	Full value of open opportunities.
`OpenValueWeighted`	Value of open opportunities multiplied by step probability.
`OpenValueRanked`	Value of open opportunities multiplied by ranking.
`OpenValueBalanced`	Value of open opportunities multiplied by both step probability and ranking.
`LostValueUnweighted`	Full value of lost opportunities.
`WonVsForecast`	Won value as a percentage of the forecast.
`WonOpenVsForecast`	Won and open value as a percentage of the forecast.
`WonValueVsQuota`	Won value as a percentage of the quota.
`WonOpenValueVsQuotaUnweighted`	Full won and open value as a percentage of the quota.

ForecastOwner object id: ID!, isActive: Boolean!, forecastPerformance: [ForecastPerformanceItem]!

User included in an opportunity forecast, with their performance over the forecast periods.

Field	Type	Description
`id`	ID!	Identifier of the user this forecast row belongs to.
`isActive`	Boolean!	False when the user is deactivated but still shown for history.
`forecastPerformance`	[ForecastPerformanceItem]!	Time series of the owner's forecast performance across the forecast periods.

ForecastPerformanceItem object dateTime: DateTime!, value: Float!, period: Date!

Performance value of a forecast owner for one forecast period.

Field	Type	Description
`dateTime`	DateTime!	Timestamp the performance value was recorded at.
`value`	Float!	Forecast performance value for the period.
`period`	Date!	Period the performance value applies to.

ForecastPeriodOption object period: ForecastPeriodKind!, periodFrom: Date!, periodTo: Date!, financialYear: Boolean

Date range of an opportunity forecast and the granularity (monthly, quarterly or yearly) it is broken down by.

Field	Type	Description
`period`	ForecastPeriodKind!	Granularity the forecast is broken down by: Monthly, Quarterly, or Yearly.
`periodFrom`	Date!	First day of the forecast range (inclusive).
`periodTo`	Date!	Last day of the forecast range (inclusive).
`financialYear`	Boolean	Set only if period set to Quarterly or Yearly.

ForecastRepository object 5 fields: getById, getByIds, getAll, …

Read operations for Forecast records.

Field	Type	Description
`getById`	ForecastEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[ForecastEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[ForecastEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	ForecastEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getChangedFieldsSinceRevision`	[UUID!]! (2 args)	Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

Form object label: String!, useLang: Boolean, items: [FormItemInterface]

Form layout of a record type: its headings, field containers and step sections in display order.

Field	Type	Description
`label`	String!	Display name of the form layout.
`useLang`	Boolean	When true, the label is shown using the workspace's translated language strings.
`items`	[FormItemInterface]	Top-level layout items (separators, subsections, containers, step containers) in display order.

FormColumn object id: UUID!, size: Int!, items: [FormContainerItemInterface]

Column of a form container, holding fields and web resources in display order.

Field	Type	Description
`id`	UUID!	Unique id of the column.
`size`	Int!	Relative width of the column within its container.
`items`	[FormContainerItemInterface]	Fields and web resources placed in this column, in display order.

FormContainer object id: UUID!, onMobile: Boolean, kind: FormItemKindEnum!, columns: [FormColumn]

Block of a record form with columns of fields and web resources.

Field	Type	Description
`id`	UUID!	Unique id of the form layout item.
`onMobile`	Boolean	When true, this item is shown in the mobile app.
`kind`	FormItemKindEnum!	Kind of layout item — separator, subsection, container, hardcoded container or step container.
`columns`	[FormColumn]	Columns laid out side by side within this container.

FormContainerItemInterface interface kind: FormContainerItemKind!

Item placed in a column of a record form: a field or an embedded web resource.

Field	Type	Description
`kind`	FormContainerItemKind!	Kind of column item — a placed field or an embedded web resource.

FormContainerItemKind enum Field, WebResource

Kind of item placed in a form layout container.

Value	Description
`Field`	A record field.
`WebResource`	An embedded web resource.

FormField object 25 fields: kind, id, onMobile, …

Field placed on a record form, with its label, validation and conditional rules.

Field	Type	Description
`kind`	FormContainerItemKind!	Kind of column item — a placed field or an embedded web resource.
`id`	String!	Id of the field placed on the form.
`onMobile`	Boolean	When true, the field is shown in the mobile app.
`readonly`	Boolean	When true, the field is displayed but cannot be edited.
`label`	String!	Label shown for the field on the form.
`useLang`	Boolean	When true, the label uses the workspace's translated language strings.
`description`	String	Optional help text shown with the field.
`validators`	FieldValidator	Validation rules applied to the field's value (required, min/max, formula, …).
`subLabelUseLang`	Boolean	When true, the sub-label uses the workspace's translated language strings.
`subLabel`	String	Secondary label shown beneath the field's main label.
`showFixedValue`	Boolean	When true, a foreign-currency field also shows its fixed base-currency value.
`dropdownAutoselect`	DropDownAutoselectEnum	For dropdowns, how a value is pre-selected — none, the first option, or only when a single option exists.
`productSections`	[ProductSection!]	For a product-list field, the product sections used to group products.
`productSectionTotals`	Boolean	For a product-list field, when true each product section shows the sum of its lines' Amount.
`inAddin`	Boolean	When true, the field is shown in the email add-in.
`lookupVisualization`	LookupVisualizationType	For a lookup field, how linked records are shown — a multi-selection list or cards.
`opptyValueAutoCalculateDefault`	Boolean	When true, the opportunity value is calculated from its products by default.
`labelTranslated`	String	Read-only label resolved into the current user's language.
`labelTranslations`	JSONString	Per-language overrides for the field label.
`descriptionTranslated`	String	Read-only help text resolved into the current user's language.
`descriptionTranslations`	JSONString	Per-language overrides for the field help text.
`readonlyRules`	FieldFilter	Condition under which the field becomes read-only.
`requiredRules`	FieldFilter	Condition under which the field becomes required.
`visibilityRules`	FieldFilter	Condition under which the field is shown.
`allowedEntities`	[String!]	For a linked-items field, the entity types whose records may be linked.

FormItemInterface interface id: UUID!, onMobile: Boolean, kind: FormItemKindEnum!

Top-level item of a record form layout, such as a heading or a block of fields.

Field	Type	Description
`id`	UUID!	Unique id of the form layout item.
`onMobile`	Boolean	When true, this item is shown in the mobile app.
`kind`	FormItemKindEnum!	Kind of layout item — separator, subsection, container, hardcoded container or step container.

FormItemKindEnum enum Separator, Subsection, Container, HardcodedContainer, StepFieldsContainer

Kind of item in a form layout.

Value	Description
`Separator`	Section heading that groups the items below it.
`Subsection`	Smaller heading inside a section.
`Container`	Block of columns holding fields and web resources.
`HardcodedContainer`	Fixed block with predefined content, such as the account, contact or product name.
`StepFieldsContainer`	Multi-step section with its own field containers for each step.

FormSeparator object 6 fields: id, onMobile, kind, …

Section heading on a record form that groups the items below it.

Field	Type	Description
`id`	UUID!	Unique id of the form layout item.
`onMobile`	Boolean	When true, this item is shown in the mobile app.
`kind`	FormItemKindEnum!	Kind of layout item — separator, subsection, container, hardcoded container or step container.
`useLang`	Boolean	When true, the heading uses the workspace's translated language strings.
`label`	String!	Heading text for the group separator.
`description`	String	Optional descriptive text shown beneath the group heading.

FormSubsection object 6 fields: id, onMobile, kind, …

Smaller heading inside a section of a record form.

Field	Type	Description
`id`	UUID!	Unique id of the form layout item.
`onMobile`	Boolean	When true, this item is shown in the mobile app.
`kind`	FormItemKindEnum!	Kind of layout item — separator, subsection, container, hardcoded container or step container.
`useLang`	Boolean	When true, the subsection heading uses the workspace's translated language strings.
`label`	String!	Heading text for the subsection.
`description`	String	Optional descriptive text shown beneath the subsection heading.

FormulaValidator object expression: String!, message: String!

Formula a field value must satisfy, with the error message shown when it does not.

Field	Type	Description
`expression`	String!	Boolean formula (Coevera calculation syntax) that must evaluate to true for the value to be valid.
`message`	String!	Error message shown when the formula evaluates to false.

FormViewOrderByNestedInput input 13 fields: id, isDeleted, modified, …

Sorting by a field of the related FormView record. Set exactly one field in each item.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`accountTypeId`	OrderByEnum	Id of the account type the form view applies to. Set when the form view targets accounts.
`contactTypeId`	OrderByEnum	Id of the contact type the form view applies to. Set when the form view targets contacts.
`leadTypeId`	OrderByEnum	Id of the lead type the form view applies to. Set when the form view targets leads.
`name`	OrderByEnum	Name of the entity and its default text representation.
`opptyTypeId`	OrderByEnum	Id of the opportunity type.
`ownerId`	OrderByEnum	Id of the owning user.
`shareMode`	OrderByEnum	Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit).
`useLang`	OrderByEnum	When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	OrderByEnum	Revision when entity was lastly changed.

FormViewRepository object 5 fields: getById, getByIds, getAll, …

Read operations for FormView records.

Field	Type	Description
`getById`	FormViewEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[FormViewEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[FormViewEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	FormViewEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getChangedFieldsSinceRevision`	[UUID!]! (2 args)	Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

FormViewSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for FormViewSharingClientRelation records.

Field	Type	Description
`getById`	FormViewSharingClientRelationEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[FormViewSharingClientRelationEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[FormViewSharingClientRelationEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	FormViewSharingClientRelationEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getChangedFieldsSinceRevision`	[UUID!]! (2 args)	Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

FormViewSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for FormViewSharingSalesUnitRelation records.

Field	Type	Description
`getById`	FormViewSharingSalesUnitRelationEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[FormViewSharingSalesUnitRelationEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[FormViewSharingSalesUnitRelationEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	FormViewSharingSalesUnitRelationEntityConnection (7 args)	Returns the records that match the filter as a cursor-paginated connection.
`getChangedFieldsSinceRevision`	[UUID!]! (2 args)	Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.