"""Record to link through a lookup field, optionally as the primary one.""" input LookupItemInput { """Id of the record to link through the lookup field.""" id: UUID! """ When true, the linked record is marked as the primary one; the lookup field must allow a primary relation. """ isPrimary: Boolean = false } """ Universally unique identifier, written as a 36-character string such as "0b7a2c4e-8f1d-4c3b-9a6e-5d2f1e0c7b8a". """ scalar UUID """ Settings of a sales target: its period, the records it covers and the indicators its value is calculated from. """ type TargetsSettings { """When true, lead indicators are included in the target calculation.""" leadsEnabled: Boolean! """ When true, working-time indicators (working hours, vacation, holidays, sick days) are included in the target calculation. """ workingTimeEnabled: Boolean! """ When true, the target value is fixed and not recomputed from the indicators. """ targetValueLocked: Boolean! """Time period the target applies to.""" period: TargetsPeriod! """ Field-condition filter selecting which records contribute to the target. The main box entity must be LeadOppty for Revenue and LeadQualified targets, and Lead (or LeadOppty) for LeadCreated targets; other entities are rejected. """ filter: FieldFilter """Either pipelineId or leadProcessId depending on type of Target.""" pipelineLeadProcessId: UUID """ Granularity at which target progress is charted — Yearly, Quarterly, Monthly, Weekly or Daily. """ chartGranularity: TargetsChartGranularityEnum! """Indicator values computed from historical data, used as defaults.""" calculatedIndicators: TargetsIndicators! """ User-overridden indicator values; each set value takes precedence over the corresponding calculated indicator. """ customIndicators: TargetsIndicators! } """Interval between data points on a target progress chart.""" enum TargetsChartGranularityEnum { """One data point per year.""" Yearly """One data point per quarter.""" Quarterly """One data point per month.""" Monthly """One data point per week.""" Weekly """One data point per day.""" Daily } """ Sales performance indicators of a target, such as lead qualification rate, average deal size, win rate and length of the sales cycle. """ type TargetsIndicators { """Target value to be reached over the period.""" target: Float """Share of closed leads that were qualified, as a ratio.""" leadQualificationRate: Float """Average number of days it takes for a lead to be qualified.""" leadSalesTimeToQualify: Int """Average number of days it takes for a lead to be lost.""" leadSalesTimeToLose: Int """Number of leads closed (qualified or lost) over the period.""" leadClosedCount: Int """Average monetary value of a won opportunity.""" opportunityAverageSize: Float """Average rate at which opportunity value is won over time.""" opportunityAverageVelocity: Float """Share of closed opportunities that were won, as a ratio.""" opportunityWinRate: Float """Average number of days it takes for an opportunity to be won.""" opportunitySalesTimeToWin: Int """Average number of days it takes for an opportunity to be lost.""" opportunitySalesTimeToLose: Int """Number of opportunities closed (won or lost) over the period.""" opportunityClosedCount: Int """Average time, in minutes, spent engaging a lead.""" leadAverageEngagementTime: Int """Average time, in minutes, spent engaging an opportunity.""" opportunityAverageEngagementTime: Int """Number of working hours available per week.""" workingHoursPerWeek: Int """ Number of weekly working hours not spent selling (admin, meetings, etc.). """ nonSellingHoursPerWeek: Int """Number of vacation days per year.""" vacationDaysPerYear: Int """Number of public holidays per year.""" holidaysPerYear: Int """Expected number of sick days per year.""" sickDaysPerYear: Int """ Average number of engagements with a lead before it is qualified or lost. """ leadAverageEngagementsBeforeQualifyLost: Float """Average number of engagements with a lead before it is qualified.""" leadAverageEngagementsBeforeQualify: Float """Average number of engagements with a lead before it is lost.""" leadAverageEngagementsBeforeLost: Float """ Average number of engagements with an opportunity before it is won or lost. """ opptyAverageEngagementsBeforeWonLost: Float """Average number of engagements with an opportunity before it is won.""" opptyAverageEngagementsBeforeWon: Float """Average number of engagements with an opportunity before it is lost.""" opptyAverageEngagementsBeforeLost: Float """Number of working days target user worked in company.""" targetUserWorkingDaysTotal: Int """Number of years user has worked in company""" targetUserYearsInWork: Int } """ Filter definition: conditions on a record type and on related records, grouped in filter boxes and combined with And, Or or a custom formula. """ type FieldFilter { """How the filter boxes combine — And or Or.""" operator: FilterGroupOperator! """Optional boolean formula combining the filter boxes by their number.""" formula: String """Primary group of filter conditions.""" filterMainBox: MainFilterBox! """Additional condition groups, combined per operator/formula.""" filterSiblingBoxes: [FilterBox!]! """When false, the filter is ignored and all records match.""" isEnabled: Boolean! } """How the conditions of a filter are combined.""" enum FilterGroupOperator { """A record must match all conditions.""" And """A record must match at least one condition.""" Or """ Conditions are combined by the custom boolean formula that references them by number. """ Custom } """ Group of filter conditions evaluated on records related to the main record type, reached through a lookup field or a predefined relation. """ type FilterBox implements FilterBoxInterface { """Identifier of this filter box within the filter tab.""" id: String! """ Name of the record type whose fields the conditions in this box are evaluated against. """ entity: String! """ 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. """ lookupFieldId: UUID """ Predefined relationship linking this sibling box to the main record type. Null when the box is connected through a lookup field instead. """ relation: HardCodedRelation """ Conditions evaluated on this box, each comparing one field against a set of values. """ filterFields: [FieldFilterRule!]! } """Group of filter conditions evaluated on one record type.""" interface FilterBoxInterface { """Identifier of this filter box within the filter tab.""" id: String! """ Name of the record type whose fields the conditions in this box are evaluated against. """ entity: String! """ 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. """ lookupFieldId: UUID } """Filter condition that compares one field with a set of values.""" type FieldFilterRule implements FilterFieldRuleInterface { """ Identifier of this condition within the filter box. Used to reference the condition from the box formula. """ id: UUID """Identifier of the field this condition is evaluated against.""" field: String! """ Comparison applied between the field and the supplied values (for example Is, IsNot, Contains, Between, IsEmpty). """ operator: FieldOperator """ 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). """ values: [[String]] } """ Single filter condition: the field, the comparison operator and the values it is compared with. """ interface FilterFieldRuleInterface { """ Identifier of this condition within the filter box. Used to reference the condition from the box formula. """ id: UUID """Identifier of the field this condition is evaluated against.""" field: String! """ Comparison applied between the field and the supplied values (for example Is, IsNot, Contains, Between, IsEmpty). """ operator: FieldOperator """ 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). """ values: [[String]] } """ Comparison applied between a field and the supplied values in a filter condition or formatting rule. """ enum FieldOperator { """ For checkbox fields only: matches records where the checkbox is checked (or unchecked when the value is false). """ Nop """Field equals the value; text comparison ignores case.""" Is """ Field does not equal the value, including records where the field is empty. """ IsNot """Field has no value; no comparison value is needed.""" IsEmpty """Field has a value; no comparison value is needed.""" IsNotEmpty """Field is less than the value.""" Less """Field is less than or equal to the value.""" LessOrEqual """Field is greater than the value.""" More """Field is greater than or equal to the value.""" MoreOrEqual """ Field lies between the two values, bounds included; an omitted bound leaves that side open. """ Between """Field lies outside the two values or is empty.""" BetweenNot """Field contains the value as a substring, ignoring case.""" Contains """Field does not contain the value as a substring, or is empty.""" ContainsNot """Multi-value field contains all of the listed values.""" Has """ Multi-value field does not contain all of the listed values, or is empty. """ HasNot """ Date field falls within a dynamic period given by a PeriodKind value (for example MonthCurrent), evaluated relative to today. """ RelativePeriod """Date field falls outside the given dynamic period.""" RelativePeriodNot """Field matches at least one of the listed values.""" In """Field matches none of the listed values, or is empty.""" InNot """Text field starts with the value, ignoring case.""" StartsWith """Text field ends with the value, ignoring case.""" EndsWith """For owner fields: the owner is an active user.""" IsActive """For owner fields: the owner is a deactivated user.""" IsNotActive } """Predefined relation that links a filter box to the filtered records.""" type HardCodedRelation { """ Predefined relationship that links this filter box to the main record type (for example Primary, Aggregation, NextScheduledActivity). """ kind: SiblingRelationType! } """ Predefined relationship that selects which related records of another type a report box or filter box uses for each main record. """ enum SiblingRelationType { """No predefined relationship is set.""" NoRelation """Reserved for a user-defined relationship; not supported.""" Custom """ Values of all related records are combined into one value per main record. """ Aggregation """The related activity that was finished most recently.""" LastFinishedActivity """The next upcoming related activity.""" NextScheduledActivity """ The primary related record, such as the primary account or contact; for quotes of an opportunity, the active quote. """ Primary """Reserved for the next open opportunity; not supported.""" NextOpenOpportunity """Reserved for the most recently won opportunity; not supported.""" LastWonOpportunity """Reserved for the most recently lost opportunity; not supported.""" LastLostOpportunity """The most recently created related online form response.""" LastOnlineFormResponse """The most recently created related note.""" LastNote """The most recent related message.""" LastMessage """The most recent comment on the activity.""" LastActivityComment """Every related record; the main record appears once per related record.""" All """The account, contact or user who sent the email.""" Sender } """ Group of filter conditions evaluated on the main record type of a filter. """ type MainFilterBox implements FilterBoxInterface { """Identifier of this filter box within the filter tab.""" id: String! """ Name of the record type whose fields the conditions in this box are evaluated against. """ entity: String! """ 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. """ lookupFieldId: UUID """ Conditions evaluated on the main record type, each comparing one field against a set of values. """ filterFields: [FieldFilterRule!]! } """ Period of a sales target: a year, quarter or month of the calendar or financial year. """ type TargetsPeriod { """ Whether the period follows the CalendarYear (Jan 1) or the company FinancialYear start. """ type: TargetsPeriodTypeEnum! """Calendar or financial year the target applies to.""" year: Int! """Granularity of the period within the year — Year, Quarter or Month.""" fragmentType: TargetsPeriodFragmentTypeEnum! """ Quarter (1-4, counted from the start of the year) or calendar month (1-12, January = 1) the period covers; null when fragmentType is Year. """ fragmentIndex: Int } """Year basis a target period follows.""" enum TargetsPeriodTypeEnum { """Periods follow the calendar year starting on 1 January.""" CalendarYear """Periods follow the space's financial year.""" FinancialYear } """Length of the fragments a target period is split into.""" enum TargetsPeriodFragmentTypeEnum { """The whole year is one fragment.""" Year """The year is split into quarters.""" Quarter """The year is split into months.""" Month } """ Conditions that decide when a step checklist item is shown; the item is visible only for records that match them. """ type StepChecklistVisibilityFilter { """How the filter boxes combine — And or Or.""" operator: FilterGroupOperator! """Optional boolean formula combining the filter boxes by their number.""" formula: String """Primary group of filter conditions.""" filterMainBox: MainFilterBox! """Additional condition groups, combined per operator/formula.""" filterSiblingBoxes: [FilterBox!]! } """ Side-panel widget of a record's detail screen configured in an interface preview, and whether it is shown. """ type InterfaceDetailWidget { """ Which side-panel widget of the record's detail screen this entry configures. """ kind: InterfaceDetailWidgetKind! """Whether the widget is shown on the detail screen.""" visible: Boolean! } """ Side-panel widget of a record's detail screen that an interface layout entry configures. """ enum InterfaceDetailWidgetKind { """Current status of the record.""" Status """Health indicator of the account.""" EntityHealth """Lead scoring result of the record.""" EntityScoring """Social network profiles of the account or contact.""" Social """Automation processes related to the record.""" Processes """Email sequences the record is enrolled in.""" EmailSequences """Data from the HubSpot integration for the record.""" Hubspot """Owner of the record.""" Owner """Users and sales units the record is shared with.""" Sharing """Fitness indicators that flag issues with the lead or opportunity.""" Fitness """Tags assigned to the record.""" Tags """Checklist of the record's current pipeline step.""" StepChecklist """Revenue schedule of the opportunity.""" RevenueSchedule """Approval status of the record.""" Approval """Possible duplicates of the record.""" DuplicateChecker """Static lists the record is included in.""" StaticProfiles """AI-generated summary of the record.""" AiSummary """Company or contact data from the ZoomInfo integration.""" Zoominfo } """ Tab of a record's detail screen configured in an interface preview, and whether it is shown. """ type InterfaceDetailTab { """Which tab of the record's detail screen this entry configures.""" kind: InterfaceDetailTabKind! """ Identifier of the lookup field whose records the tab lists. Set only for the Lookup and LookupRelated kinds, null for every other kind. """ lookupFieldId: UUID """Whether the tab is shown on the detail screen.""" visible: Boolean! } """ Tab of a record's detail screen that an interface layout entry configures. """ enum InterfaceDetailTabKind { """Form with the record's own fields.""" Detail """Projects related to the record.""" Projects """Leads related to the record.""" Leads """Opportunities related to the record.""" Opportunities """ Products related to the record, such as opportunity or quote line items. """ Products """Accounts related to the record; on an account, its related accounts.""" Accounts """Contacts related to the record.""" Contacts """ Graph of relationships between the record and other accounts and contacts. """ RelationGraph """Organization chart of the contacts in the account.""" OrgChart """ Contacts involved in the buying decision of the lead or opportunity, with their roles. """ BuyingCenter """Tasks and appointments linked to the record.""" Activities """Feed of activities, emails and updates related to the record.""" Feeds """Documents attached to the record.""" Documents """Notes written on the record.""" Notes """ Records selected in one of this record's lookup fields; lookupFieldId identifies the field. """ Lookup """ Records of another entity whose lookup field points to this record; lookupFieldId identifies that field. """ LookupRelated """Quotes related to the record.""" Quotes """Customer-specific product prices of the account.""" ProductPricing """Parent and child account hierarchy of the account.""" AccountHierarchy } """ Chart or list shown in a record's preview pane, built from records of a related entity. """ type InterfacePreviewChart { """Identifier of the chart inside the preview configuration.""" id: UUID! """Chart name shown as its heading in the preview pane.""" name: String """Longer explanation of what the chart shows.""" description: String """ Related entity the chart reads its records from, e.g. Activity or Contact. """ entityType: EntityNameEnum! """ Chart configuration: either a report chart definition or a sorted-list definition. """ settings: InterfacePreviewSettings """Filter narrowing the records the chart shows.""" filter: ProfileFilterTab } """ Name of an entity (record type) of the space, used wherever an operation, filter or setting has to identify which entity it works with. """ enum EntityNameEnum { """ AI agent offered in the Automation Hub, such as an AI assistant integration, whose use is recorded as AI events. """ AiAgent """ AI credit balance of a subscription for a period, with the free credits remaining and spent and the overage credits used. """ AiBalance """ Use of an AI agent by a user in a space, with its outcome, response time and the AI credits it consumed. """ AiEvent """ Single AI model call made while handling an AI event, with the model used, its response time and cost. """ AiEventJournal """ Entry of the space audit log recording an administrative action, such as a data export, a user invitation or a sales unit change, and who performed it. """ AuditLog """ Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. """ Account """ Recorded KPI event of an account, such as its creation, archiving or the first and last email sent, used in KPI reports. """ AccountKPI """ Role a contact can hold at an account, configurable per space and assigned on the link between the contact and the account. """ AccountRole """Sharing of an account with a user, as a watcher or an editor.""" AccountSharingClientRelation """Sharing of an account with a sales unit, as a watcher or an editor.""" AccountSharingSalesUnitRelation """ Social network profiles of an account, such as its LinkedIn, Twitter or Facebook pages. """ AccountSocialRelation """ Special price of a product for one account, used instead of the regular price when the product is sold to that account. """ AccountProductPricing """ Configurable category of accounts that defines the form layout and settings used for accounts of that type. """ AccountType """ Task or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern. """ Activity """Comment written by a user on a task or an appointment.""" ActivityComment """ Recorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports. """ ActivityKPI """ Link of a task or an appointment to a record it concerns, such as an account, contact, lead, opportunity, project or quote. """ ActivityRelation """ Task type or appointment type, with the settings both kinds of activity types share. """ ActivityType """Lead type that a user role is allowed to use.""" AllowedLeadType """ Pipeline that a user role is allowed to use, optionally with access to the documents of its steps. """ AllowedPipeline """ API credentials that an integration uses to access the space, with the parts of the API they may read or write. """ ApiAccess """ Application that works with the space, such as the web or mobile app, an Automation Hub integration or an API access; changes and events are attributed to it. """ Application """ Meeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns. """ Appointment """ Invitation of a user of the space to an appointment, with their response. """ AppointmentClientInviteesRelation """ Invitation of an external person to an appointment, identified by email and matched to a contact when one exists, with their response. """ AppointmentContactInviteesRelation """ Invitation email for an appointment that is waiting to be sent to an invitee's email address. """ AppointmentInviteeNotifyQueue """ Reminder a user has set for an appointment, notifying them a given time before it starts. """ AppointmentReminder """ Online booking link through which people book appointments with a user in the time slots the user has available. """ AppointmentSchedule """ Configurable category of appointments, such as a meeting or a call, that defines their form layout and icon. """ AppointmentType """Account type that a user role is allowed to use.""" AllowedAccountType """Appointment type that a user role is allowed to use.""" AllowedAppointmentType """Contact type that a user role is allowed to use.""" AllowedContactType """ Company phone number that a user role is allowed to use for calls and text messages. """ AllowedCompanyPhone """Task type that a user role is allowed to use.""" AllowedTaskType """ Approval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers. """ Approval """ User asked to decide an approval request, with their response and comment. """ ApprovalApprover """ Approval rule that raises approval requests for records of an entity when its trigger conditions are met, and defines who approves them. """ ApprovalProcess """ Entry in the activity log of an approval, recording one step of the approval and its result. """ ApprovalProcessActivityLogLine """ Conversation of a user with the AI assistant, either general or about a specific record. """ ChatConversation """ User of the space; owns records, belongs to sales units and has a user role that determines what they can do. """ Client """ Choice of a user to exclude an opportunity from their forecast and quota calculations, or to include it again. """ ClientExcludedOppty """Record or screen profile that a user has marked as a favorite.""" ClientFavorite """Personal setting of a user, stored as a named value.""" ClientSetting """ Mark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it. """ ClientStoryRead """ File stored in the space, such as a document, image or recording, that can be attached to records. """ CloudObject """ Folder that organizes files, either in the company documents or within a record. """ CloudObjectFolder """ Attachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record. """ CloudObjectRelation """ File attached to a pipeline step, such as a document the sales team uses in that step. """ CloudObjectStepRelation """ Document template, such as a Word or Excel file with placeholders, used to generate documents filled with record data. """ CloudObjectTemplate """ Shared company mailbox connected to the space that users can send emails from, such as a sales or support address. """ CompanyEmail """ Person the sales team works with, usually linked to one or more accounts, leads and opportunities. """ Contact """ Link between a contact and an account they work for, with their position and their place in the account org chart. """ ContactAccountRelation """ Role assigned to a contact at an account, on the link between the contact and the account. """ ContactAccountAccountRoleRelation """ Link between two related contacts, such as colleagues or family members; its labels give the kind of relationship. """ ContactRelation """ Kind of relationship that can be assigned to a link between two contacts, such as Spouse or Colleague, with its display color. """ ContactRelationType """ Recorded KPI event of a contact, such as its creation, archiving or the first and last email sent, used in KPI reports. """ ContactKPI """Sharing of a contact with a user, as a watcher or an editor.""" ContactSharingClientRelation """Sharing of a contact with a sales unit, as a watcher or an editor.""" ContactSharingSalesUnitRelation """ Social network profiles of a contact, such as their LinkedIn, Twitter or Facebook profiles. """ ContactSocialRelation """ Configurable category of contacts that defines the form layout and settings used for contacts of that type. """ ContactType """ Country offered in address fields; a new country value on a record must match one of these countries. """ CountryCrm """ Currency used for monetary values in the space, converted from the base currency by exchange rates. """ Currency """ Exchange rate of a currency against the base currency within an exchange rate list. """ CurrencyExchangeRate """ Set of exchange rates, one per currency, that applies from a given date until the next list takes effect. """ CurrencyExchangeRatesList """ Custom relation that links records of two entities through a pair of relation fields, one on each side. """ CustomEntityRelation """ Link between two records made through a custom relation, such as an account linked to a custom entity record. """ CustomEntityRelationData """ Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. """ CustomEntity """ Option selected in a multi-select checkbox field of a custom entity record; there is one link per selected option. """ CustomEntityDataExRelation """ Recorded KPI event of a custom entity record, such as its creation or last modification, used in KPI reports. """ CustomEntityKPI """ Sharing of a custom entity record with a user, as a watcher or an editor. """ CustomEntitySharingClientRelation """ Sharing of a custom entity record with a sales unit, as a watcher or an editor. """ CustomEntitySharingSalesUnitRelation """ Configurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity. """ CustomEntityType """ Option of a dropdown or multi-select field, one of the values users can choose from. """ Data """ E-book offered to users in the in-app learning content, with view statistics. """ Ebook """ Email message sent or received by users of the space, linked to the contacts, accounts and other records it concerns. """ Email """ Personal label a user applies to email conversations to organize their mailbox; labels can be nested. """ EmailLabel """Email label applied to a conversation in a mailbox.""" EmailLabelRelation """Link between an email and a mailbox the email belongs to.""" EmailMailboxRelation """ Automated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop. """ EmailSequence """ Log of one run of an email sequence, with when it started and finished and who triggered it. """ EmailSequenceActivityLog """ Entry in the log of an email sequence run, recording one step and its outcome. """ EmailSequenceActivityLogLine """ Record enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it. """ EmailSequenceEnrolled """ Progress of an enrolled record through one step of an email sequence, with the email, text message or task the step produced. """ EmailSequenceEnrolledStatus """ Copy of an email sequence's steps and rules taken when records are enrolled, so later edits to the sequence do not affect runs already in progress. """ EmailSequenceSettings """ Reusable email whose body can contain placeholders filled with record values; templates are organized in folders and can be shared. """ EmailTemplate """Folder that organizes email templates; folders can be nested.""" EmailTemplateFolder """Sharing of an email template with a user, as a watcher or an editor.""" EmailTemplateSharingClientRelation """ Sharing of an email template with a sales unit, as a watcher or an editor. """ EmailTemplateSharingSalesUnitRelation """ Sharing of the body of an email with a user, letting them read its content. """ EmailContentSharingClientRelation """ Sharing of the body of an email with a sales unit, letting its members read its content. """ EmailContentSharingSalesUnitRelation """ Time a user last read an email conversation in a mailbox, telling which conversations have unread emails. """ EmailThreadMailboxClientReadState """ Kind of record in the space, such as Account, Lead or a custom entity, with its display names and behavior. """ Entity """ Health configuration of an account type, defining when accounts of that type are healthy or in critical health. """ EntityHealth """ Lead scoring configuration: rules that give leads a score, so that the most promising ones stand out. """ EntityScoring """ Version of the health configuration of an account type, recorded each time the configuration changes. """ EntityHealthSettingsHistory """ Fitness configuration of a lead or opportunity type: the indicators that flag records of that type needing attention. """ EntityFitness """ Indicator of a fitness configuration: a rule that flags lead or opportunity records needing attention and suggests how to fix them. """ EntityFitnessIndicator """ Record type of an entity, such as an account, lead or task type, that classifies records and defines their form. """ EntityType """ Space-wide settings of an entity, such as the default columns of its lists. """ EntitySettings """ Field of an entity, built-in or custom, with its name, type and configuration. """ Field """ Rules for copying field values from a source record to a new target record, for example when a lead is qualified into an opportunity. """ FieldMapping """ Numbering pattern of an auto-number field, used to generate its values for records that match the filter of the sequence. """ FieldSequence """ Access a user role has to a custom field: full access, read-only or hidden. """ FieldPermission """ Sales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users. """ Forecast """Share of a forecast with an individual user.""" ForecastSharingClientRelation """Share of a forecast with a sales unit.""" ForecastSharingSalesUnitRelation """ Placeholder person on an org chart for someone who is not a contact in the space yet, such as an unknown decision maker. """ GhostContact """ Placement of a ghost contact on the org chart of a lead or an opportunity. """ GhostLeadOpptyContactRelation """ Placement of a ghost contact on the org chart of an account, with its position and comment. """ GhostContactAccountRelation """ Sales role assigned to a placeholder (ghost) contact on the org chart of a lead or opportunity. """ GhostLeadOpptyContactSalesRoleRelation """Role assigned to a ghost contact on the org chart of an account.""" GhostContactAccountAccountRoleRelation """ Saved mapping of import file columns to fields, reused when importing records of the same entity. """ ImportMappingMask """ Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. """ Lead """ Lead or opportunity, with the fields both kinds of sales records share. """ LeadOppty """ Link between a lead or opportunity and an account, marking the primary account. """ LeadOpptyAccountRelation """Group of contacts on the org chart of a lead or opportunity.""" LeadOpptyContactGroupRelation """ Link between a lead or opportunity and a contact, with the contact's sales roles and org-chart position. """ LeadOpptyContactRelation """Sales role assigned to a contact on a lead or opportunity.""" LeadOpptyContactSalesRoleRelation """ KPI event of a lead or opportunity (e.g. created, qualified, won, lost or moved to another step), used in activity reporting. """ LeadOpptyKPI """Link between a lead or opportunity and a project it is part of.""" LeadOpptyProjectRelation """ Share of a lead or opportunity with an individual user, with the access level granted. """ LeadOpptySharingClientRelation """ Share of a lead or opportunity with a sales unit, with the access level granted. """ LeadOpptySharingSalesUnitRelation """ Completion of a step checklist item on a lead, opportunity or quote, with the activity, email, note or document that fulfils it. """ LeadOpptyStepCheckListRelation """ Lead type or opportunity type, with the settings both kinds of sales record types share. """ LeadOpptyType """ Lead process: the ordered steps that leads of its lead types move through. """ LeadProcess """ Lead type that classifies leads and defines their forms and the lead process they follow. """ LeadType """ User role in the space that defines which features, records and pipelines its users can access. """ MasterRight """ Recording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment. """ Media """ Internal message written by a user and linked to records, which other users can comment on. """ Memo """Comment a user wrote on a memo.""" MemoComment """Email or memo, with the fields both kinds of messages share.""" Message """ Link between a message (email or memo) and a record such as an account, contact, lead or opportunity. """ MessageRelation """Share of a message (email or memo) with an individual user.""" MessageSharingClientRelation """Share of a message (email or memo) with a sales unit.""" MessageSharingSalesUnitRelation """ Note a user wrote on a record such as an account, contact, lead, opportunity, project or quote. """ Note """ Submission (response) of an online form, with the answers and the records it created or updated. """ OnlineForm """One step logged while processing an online form submission.""" OnlineFormActivityLogLine """ Option selected in a multi-select checkbox field of an online form submission. """ OnlineFormDataExRelation """ Email that sent an online form link to a recipient, with the record it was sent on. """ OnlineFormTypeEmailRelation """ Link between an online form submission and a record it created or updated. """ OnlineFormRelation """ Online form definition: the fields and settings of a web form whose submissions create or update records. """ OnlineFormType """ Visual style (colors, fonts, layout) that can be applied to online forms. """ OnlineFormStyle """ Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. """ Opportunity """ Opportunity type that classifies opportunities and defines their forms (edit, qualify, won and lost). """ OpportunityType """ Product line item on an opportunity or quote, with its quantity, price and discount. """ OpptyProductRelation """ Option selected in a multi-select checkbox field of a product line item. """ OpptyProductRelationDataExRelation """ Line-item type that defines the form of product line items on opportunities and quotes; paired with a product type. """ OpptyProductRelationType """ Recurrence rule that creates new copies of an opportunity on a schedule, e.g. for repeat deals once it is won or lost. """ OpptyRecurrence """Revenue schedule that splits the value of an opportunity into periods.""" OpptyRevenueSchedule """ One period of an opportunity revenue schedule, with its date and amount. """ OpptyRevenueSchedulePeriod """ Revenue schedule that splits the amount of a product line item into periods. """ OpptyProductRelationRevenueSchedule """ One period of a product line item revenue schedule, with its date and amount. """ OpptyProductRelationRevenueSchedulePeriod """ Order of a subscription (e.g. a purchase, renewal or license change) with its items, amounts, tax and payment status. """ Order """ Line item of an order: a product with its quantity, price and subtotal, and the monthly recurring revenue it adds. """ OrderItem """ Line item of an order that waits for online payment in checkout, with its product, quantity and price. """ OrderTempDataItem """Status change recorded in the history of an order.""" OrderHistory """Payment confirmation or credit note issued for an order.""" OrderRelatedDocument """ Order started in checkout that waits for online payment; it becomes a regular order once the payment succeeds. """ OrderTempData """ Payment received for an order, with the payment method, the amount paid and the transaction reference. """ Payment """ Payment term of orders, such as immediate payment or payment within a number of days, in a given language. """ PaymentTerm """ Instructions given at checkout that are carried out once the order is paid, such as the invoice recipients, new subscription admins and the users to invite after a space reset. """ PaymentAdditionalData """ Kind of parent-child relationship between accounts (e.g. parent company and subsidiary), with a label for each side. """ ParentAccountRelationType """ Phone number connected to Coevera for calls, text messages or WhatsApp, either personal to a user or shared by the company. """ Phone """Quote type that a user role is allowed to use.""" AllowedQuoteType """ Price offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process. """ Quote """Link between a quote and an account, marking the primary account.""" QuoteAccountRelation """Link between a quote and a contact, marking the primary contact.""" QuoteContactRelation """Option selected in a multi-select checkbox field of a quote.""" QuoteDataExRelation """ KPI event of a quote (e.g. created, accepted, archived or moved to another step), used in activity reporting. """ QuoteKPI """ Quote process: the ordered steps that quotes of its quote types move through. """ QuoteProcess """ Share of a quote with an individual user, with the access level granted. """ QuoteSharingClientRelation """Share of a quote with a sales unit, with the access level granted.""" QuoteSharingSalesUnitRelation """ Quote type that classifies quotes and defines their forms and the quote process they follow. """ QuoteType """ Option selected in a multi-select checkbox field of a lead or opportunity. """ LeadOpptyDataExRelation """ Option selected in a multi-select checkbox field of an account; there is one link per selected option. """ AccountDataExRelation """ Option selected in a multi-select checkbox field of a contact; there is one link per selected option. """ ContactDataExRelation """ Option selected in a multi-select checkbox field of a task or an appointment; there is one link per selected option. """ ActivityDataExRelation """Option selected in a multi-select checkbox field of a product.""" ProductDataExRelation """Option selected in a multi-select checkbox field of a project.""" ProjectDataExRelation """ Sales pipeline: the ordered steps that opportunities of its opportunity types move through. """ Pipeline """ Automatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook). """ Process """ One run of an Automatizer process, with its status, timing and the steps it took. """ ProcessActivityLog """One step logged in a run of an Automatizer process.""" ProcessActivityLogLine """ Action of an Automatizer process that is waiting to run for a record at a scheduled time. """ ProcessScheduledAction """ Ready-made Automatizer process offered in the template gallery as a starting point for new processes. """ ProcessTemplate """ Canvas that groups related automation tools (Automatizer processes, email sequences, online forms) and tracks their status and activity. """ Solution """ Ready-made solution offered in the template gallery as a starting point for new solutions. """ SolutionTemplate """ Round-robin progress of an Automatizer change-owner action, recording which users have already been assigned a record so the next record goes to the next user. """ ProcessChangeOwnerLog """ Product or service in the catalog that can be added as a line item to opportunities and quotes. """ Product """Product type that classifies products and defines their form.""" ProductType """Category in the hierarchy of the product catalog.""" ProductCategory """Pipeline in which a product can be added as a line item.""" ProductPipelineRelation """ Price list with product prices per currency, applied to opportunities and quotes while it is active. """ ProductPriceList """Price of a product in one currency within a price list.""" ProductPriceListPrice """ Saved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others. """ Profile """Record added explicitly to a static saved view (profile).""" ProfileRelation """ Unsaved changes a user made to the view of an app screen, kept until they are saved or discarded. """ ProfileDraft """Share of a saved view (profile) with an individual user.""" ProfileSharingClientRelation """Share of a saved view (profile) with a sales unit.""" ProfileSharingSalesUnitRelation """ Project delivered for an account or run internally, with its objectives, activities and progress. """ Project """KPI event of a project (its completion), used in activity reporting.""" ProjectKPI """Link between a project and a contact, marking the primary contact.""" ProjectContactRelation """Objective (goal) of a project.""" ProjectObjective """Project type that classifies projects and defines their form and icon.""" ProjectType """ Share of a project with an individual user, with the access level granted. """ ProjectSharingClientRelation """Share of a project with a sales unit, with the access level granted.""" ProjectSharingSalesUnitRelation """ Saved report or dashboard with its settings, sharing and delivery schedule. """ Report """Folder that organizes reports; folders can be nested.""" ReportFolder """ Share of a report with an individual user, with the access level granted. """ ReportSharingClientRelation """Share of a report with a sales unit, with the access level granted.""" ReportSharingSalesUnitRelation """Schedule that emails a report to its recipients at regular intervals.""" ReportSchedule """ Revenue of an opportunity product for one period of its revenue schedule, used in revenue reporting. """ RevenueRecognition """ Role a contact plays in a deal (e.g. decision maker), assigned to contacts on leads and opportunities. """ SalesRole """Sales unit (team) in the organization hierarchy that users belong to.""" SalesUnit """Membership of a user in a sales unit, as a member or manager.""" SalesUnitClientRelation """ Step of an opportunity pipeline, lead process or quote process that records move through. """ Step """ Checklist item of a pipeline step, such as logging an activity, filling a field or attaching a document. """ StepChecklist """Sales role that a step checklist item is shown to.""" StepChecklistSalesRoleRelation """ Label that users attach to records such as accounts, contacts or opportunities to categorize them. """ Tag """Assignment of a tag to a record.""" TagRelation """ Sales target set for a user or a group of users for a period, measured by a chosen metric. """ Target """Link between a group target and a user target that rolls up into it.""" TargetRelation """ Task (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records. """ Task """ Recurrence rule that defines when the next occurrences of a recurring task are created. """ TaskRecurrence """Reminder a user set to be notified about a task at a given time.""" TaskReminder """ Share of a task with an individual user, with the access level granted. """ TaskSharingClientRelation """Share of a task with a sales unit, with the access level granted.""" TaskSharingSalesUnitRelation """Task type that classifies tasks and defines their form and icon.""" TaskType """ Message sent or received in a text message conversation or in an AI assistant chat. """ TextMessage """ Text message conversation between a Coevera phone number and an external phone number. """ TextMessageConversation """ Link between a text message conversation and a record such as an account, contact, lead or opportunity. """ TextMessageConversationRelations """ Translation of a field name, dropdown option or form text into the supported languages. """ Translation """ Data type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped. """ Type """Time a lead or opportunity has spent in a pipeline step.""" Timeframe """Phone number that opted out of receiving text messages.""" UnsubscribedPhone """ Use case showing how a feature can be used, offered to users in the in-app learning content. """ UseCase """ Web page embedded in the app for records of an entity, with its URL filled from the record's field values. """ Webresource """ Registered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner. """ Webhook """ Event a webhook subscribes to; the webhook is called whenever the event occurs. """ WebhookEvent """ Country that can be selected in billing addresses, with its states, sales region and the Coevera supplier that bills customers there. """ Country """Membership of a user profile in a space.""" TeamSpaceClient """ Membership of a user in a space, as listed for subscription administrators, who can disable it. """ CpTeamSpaceClient """ Call, text message or transcription made through built-in calling, with its phone numbers, status and cost. """ CpCallLog """ User account that signs in to Coevera and can be a member of several spaces and subscriptions. """ UserProfile """ Customer portal role that grants a user rights such as order, subscription, partner and user management. """ UserRole """ Space of a subscription: a separate Coevera CRM instance with its own users, data and settings. """ TeamSpace """ Hosting region where spaces run, with its address, email domain and whether new trial spaces can be created in it. """ TeamSpaceRegion """ Named property of a space, such as its time zone, first day of the week or attachment size limit. """ TeamSpaceProperty """ Integration settings of a user in a space, such as the connected mailbox and the contact, calendar and task sync with Google, Microsoft 365 or Exchange. """ TeamSpaceClientSetting """ API user that signs in with a user name and password, as a standard or administrator API user, optionally limited to one space and to allowed source IP addresses. """ SapiUser """ Calling credit of a subscription, spent on calls, recordings and AI services such as transcription. """ CpCalling """ Customer subscription to Coevera: the contract that covers its spaces, licenses, billing and orders. """ Subscription """ Coevera staff member who can be assigned to subscriptions as their sales representative. """ SubscriptionRepresentative """ Coevera staff member who can be assigned to subscriptions as their sales development representative. """ SubscriptionSDR """ Partner company (e.g. affiliate, agent or consultant) that refers customer subscriptions and earns commission on their orders. """ Partner """ Company that sells subscriptions and issues orders and invoices, with its legal imprint. """ Supplier """ State or province of a country that can be selected in billing addresses. """ State """ App (vendor) in the Automation Hub that provides integrations, with its website and support links. """ AutomationHubApp """Category that groups items in the Automation Hub.""" AutomationHubCategory """ Integration or add-on offered in the Automation Hub that can be enabled in a space. """ AutomationHubItem """Automation Hub item included in a subscription.""" SubscriptionHubItem """ Automation Hub item installed in a space, with its status and configuration. """ TeamPipelineHubItem """ Automation Hub item installed in a space, of any integration kind, with its status and configuration. """ TeamPipelineHubItemBase """ Help resource (video, article or support link) shown in the app for a feature area, with view statistics. """ HowTo """ Interactive product demo offered to users in the in-app learning content. """ Storylane """ Release note announcing a product change to users, who can react to it. """ ReleaseNote """ User account identified by its sign-in email, with the spaces it is a member of. """ CpClient """ Saved view of a customer portal screen that belongs to a Coevera staff member, with its view settings. """ CpProfile """ Product of the Coevera catalog that subscriptions can purchase, such as licenses or add-ons, with its prices in EUR, USD and GBP and its renewal terms. """ CpProduct """ Product a subscription has purchased, such as licenses or an add-on, with its quantity, price, status and the period it is active. """ PurchasedProduct """ Notification email sent to the recipients of a subscription under a notification setting, such as a renewal reminder or an overdue payment notice for an order. """ SubscriptionNotification """ Entry of the customer portal audit trail: an action a user performed, the module it was performed in and the space it concerned. """ CpActivity """ Detail of a customer portal audit trail entry: the record that was changed, the operation performed and the data before and after the change. """ ActivityDetail """ Automatic email notification to customers, sent before a subscription renewal or when an order payment is overdue. """ NotificationSetting """ Variant of the form of an account, contact, lead or opportunity type that hides or colors selected fields; owned by a user and can be shared. """ FormView """Sharing of a form view with a user, as a watcher or an editor.""" FormViewSharingClientRelation """Sharing of a form view with a sales unit, as a watcher or an editor.""" FormViewSharingSalesUnitRelation """ Layout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts. """ InterfacePreview """ Space-wide setting stored as a named value, such as the working days, custom entity names or the revenue schedule configuration. """ SpaceSetting } """ Configuration of a preview pane chart: a report chart definition or a sorted list definition. """ union InterfacePreviewSettings = ReportChart | ListChart """ Filter made of a main box on the record type and boxes on related records, combined with And, Or or a custom formula. """ type ProfileFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Filter built from filter boxes: a main box on the record type and boxes on related records. """ interface ProfileFilterBoxTabInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! } """ How the conditions of a filter are combined: all of them (And), any of them (Or) or a custom formula. """ interface ProfileFilterTabCustomFilterInterface { """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Preview pane chart that lists a record's related records sorted by a field. """ type ListChart { """Identifier of the field the list is sorted by.""" sortBy: ID! """Sort direction applied to sortBy: Asc or Desc.""" sortOrder: SortOrder! } """Direction in which a list is sorted.""" enum SortOrder { """Ascending order.""" Asc """Descending order.""" Desc } """ Chart of a report, such as a column, line, pie, scorecard or Sankey chart, with its fields, grouping, segmentation and comparison. """ type ReportChart { """Whether a chart is shown for this report tab.""" isEnabled: Boolean! """ Visual type of the chart, such as Scorecard, Pie, Line, Column, Bar, Bubble, ScatterPlot or Sankey. """ type: ReportChartType! """ Identifier of the field whose values are plotted; left empty when the chart counts records. """ fieldId: UUID """Identifier of the report box that the plotted field belongs to.""" boxId: UUID """ How the plotted field's values are aggregated, such as Count, Sum, Average, Min or Max. """ operator: AggregationOperator! """ Identifier of the field used to group values along the chart's main axis. """ groupFieldId: UUID """Identifier of the report box that the grouping field belongs to.""" groupBoxId: UUID """ How the grouping field's values are grouped, for example by month or by interval. """ groupOption: GroupOption """ Identifier of the field used to split each group into separate series or segments. """ segmentFieldId: UUID """Identifier of the report box that the segment field belongs to.""" segmentBoxId: UUID """For bubble chart and scatter plot only""" segmentFieldEnabled: Boolean """ How the segment field's values are grouped, for example by month or by interval. """ segmentOption: GroupOption """Whether an average line is drawn on the chart.""" showAverage: Boolean """ Whether records with no value for the grouping or plotted field are shown as a not-available category. """ showNotAvailableValues: Boolean """ Comparison series shown alongside the main series, such as a previous period or previous year. """ comparison: ChartComparison """ Orders the slices of a single-series pie chart by value, ascending or descending; when not set, the slices keep the grouping order. """ sortValues: SortOrder """Whether negative values are displayed on the chart.""" showNegativeValues: Boolean! """Height of the chart in pixels.""" height: Int """Whether values are labelled as percentages of the total.""" showPercentageValues: Boolean! """Whether numeric value labels are shown on the chart.""" showNumbers: Boolean! """ Identifiers of the history comparison dates the chart plots, for history-based reports. """ historyComparisonDateIds: [UUID] """ Whether the chart groups values by history comparison date rather than by a regular field. """ groupByHistory: Boolean """ Flow definition used when the chart type is Sankey, describing the start and end grouping of records. """ sankey: ReportSankeyChart """ Whether a data label is shown for every data point rather than only selected ones. """ showAllDataLabels: Boolean! """ Color of the main series, given as an RGB color code encoded as an integer. """ seriesColor: Int } """Visual type of a report chart.""" enum ReportChartType { """Single aggregated number.""" Scorecard """Pie chart of each group's share of the total.""" Pie """Single line across the grouping field.""" Line """One line per segment across the grouping field.""" MultiLine """Vertical bars, one per group.""" Column """Vertical bars with segments stacked on top of each other.""" StackedColumn """Vertical bars for each segment placed side by side.""" MultiColumn """Horizontal bars, one per group.""" Bar """Horizontal bars with segments stacked end to end.""" StackedBar """ Points plotted by two values, with a third value setting the bubble size. """ Bubble """Points plotted by two values.""" ScatterPlot """Flow diagram showing how records move between groups.""" Sankey } """ Aggregation function applied to a field's values across the records of a group. """ enum AggregationOperator { """Number of records.""" Count """Average of the field values.""" Average """Total of the field values.""" Sum """Lowest field value.""" Min """Highest field value.""" Max """ Cumulative number of records, adding each group to the groups before it. """ RunningCount """ Cumulative total of the field values, adding each group to the groups before it. """ RunningSum } """ How the values of a field are grouped into buckets in a report, chart or list. """ enum GroupOption { """Dates are grouped by day.""" Daily """Dates are grouped by week.""" Weekly """Dates are grouped by month.""" Monthly """Dates are grouped by quarter.""" Quarterly """Dates are grouped by year.""" Yearly """Text is grouped by its first letter.""" FirstLetter """ Multi-value fields are grouped by the exact combination of selected values. """ Combinations """ Multi-value fields are grouped by each individual value, so a record appears under every value it has. """ Values """ Numbers are grouped into equal-width intervals whose width is taken from the first entry of groupIntervals. """ AutoIntervals """ Numbers are grouped into the custom intervals listed in groupIntervals. """ ManualIntervals } """ Settings of a Sankey chart that shows how records move between groups from a start date to an end date. """ type ReportSankeyChart { """ Identifier of the history comparison date that defines the starting point of the flow. """ startDate: UUID """ Identifier of the report box providing the field that records are grouped by at the start of the flow. """ startGroupBoxId: UUID """ Identifier of the field that records are grouped by at the start of the flow. """ startGroupFieldId: UUID! """ How the starting field's values are grouped, for example by month or by interval. """ startGroupOption: GroupOption """ Identifier of the history comparison date that defines the end point of the flow. """ endDate: UUID """ Identifier of the report box providing the field that records are grouped by at the end of the flow. """ endGroupBoxId: UUID """ Identifier of the field that records are grouped by at the end of the flow. """ endGroupFieldId: UUID! """ How the ending field's values are grouped, for example by month or by interval. """ endGroupOption: GroupOption } """ Comparison series of a report chart, defined by a period, by years or by a history comparison date. """ type ChartComparison { """Whether the chart shows a comparison series.""" isEnabled: Boolean! """Identifier of the date field used to define the comparison period.""" dateFieldId: UUID """Period the comparison series covers.""" period: PeriodOption """ Years the chart is compared with when it is grouped by a date or date-time field; required in that case, and period and dateFieldId are then not used. """ yearComparison: ChartYearComparison """ When true, the comparison is shown relative to the current series (such as a difference or percentage) rather than as an independent series. """ relativeComparison: Boolean! """ Identifier of the history comparison date the chart compares against, for history-based reports. """ historyComparisonDateId: UUID """ Color of the comparison series, given as an RGB color code encoded as an integer. """ seriesColor: Int } """ Years a report chart is compared with: the previous year or a list of years. """ type ChartYearComparison { """ Which years the chart compares against: the previous year (YearPrevious) or an explicit list of years (Custom). """ period: YearComparisonPeriodEnum! """Explicit list of years to compare, used when the period is Custom.""" customYear: [Int!] } """Years a chart's values are compared against.""" enum YearComparisonPeriodEnum { """The previous year.""" YearPrevious """The explicit list of years set on the chart.""" Custom } """ Time period used by reports, dashboards and targets: a predefined range such as the current month, or a custom date range. """ type PeriodOption { """Set only if period set to Custom""" periodCustomFrom: Date """Set only if period set to Custom""" periodCustomTo: Date """ Time range the data is reported over (for example MonthCurrent, QuarterCurrent, Custom). When Custom, periodCustomFrom and periodCustomTo define the bounds. """ period: PeriodKind! } """ The `Date` scalar type represents a Date value as specified by [iso8601](https://en.wikipedia.org/wiki/ISO_8601). """ scalar Date """ Relative or custom date range a report, dashboard or filter is evaluated over; relative ranges are computed from the current user's today, the space's first day of week and its financial year start. """ enum PeriodKind { """Explicit range given by periodCustomFrom and periodCustomTo.""" Custom """The previous calendar year.""" YearPrevious """The current calendar year.""" YearCurrent """The next calendar year.""" YearNext """ The current calendar year and the two years before it (from 1 January two years ago to 31 December this year). """ Year3Last """The previous week, starting on the space's first day of week.""" WeekPrevious """The current week, starting on the space's first day of week.""" WeekCurrent """The next week, starting on the space's first day of week.""" WeekNext """ The previous week and the current week together (two full weeks ending on the last day of the current week). """ Week2Last """ The current week and the three weeks before it (four full weeks ending on the last day of the current week). """ Week4Last """ The previous financial year, based on the space's financial year start. """ FinancialYearPrevious """The current financial year, based on the space's financial year start.""" FinancialYearCurrent """The next financial year, based on the space's financial year start.""" FinancialYearNext """The first quarter of the current financial year.""" FinancialYearQuarter1 """The second quarter of the current financial year.""" FinancialYearQuarter2 """The third quarter of the current financial year.""" FinancialYearQuarter3 """The fourth quarter of the current financial year.""" FinancialYearQuarter4 """January to March of the current calendar year.""" Quarter1 """April to June of the current calendar year.""" Quarter2 """July to September of the current calendar year.""" Quarter3 """October to December of the current calendar year.""" Quarter4 """The calendar quarter before the current one.""" QuarterPrevious """The current calendar quarter.""" QuarterCurrent """The calendar quarter after the current one.""" QuarterNext """The current calendar quarter of the previous year.""" QuarterCurrentInPreviousYear """ The current calendar quarter and the three quarters before it (the last four quarters including the current one). """ Quarter4Previous """The previous calendar month.""" MonthPrevious """The current calendar month.""" MonthCurrent """The next calendar month.""" MonthNext """The current calendar month of the previous year.""" MonthCurrentInPreviousYear """The current calendar month and the two months before it.""" Month3Last """Today only.""" Today """Tomorrow only.""" Tomorrow """Yesterday only.""" Yesterday """Everything up to and including today, with no start date.""" UpToToday """The last 30 days, ending with and including today.""" Days30Previous """The next 30 days, starting with and including today.""" Days30Next """The next 7 days, starting with and including today.""" Days7Next """The next 14 days, starting with and including today.""" Days14Next """The last 7 days, ending with and including today.""" Days7Previous """No date restriction; all records match.""" All } """ Customization settings of an interface preview, such as whether users may change its layout. """ type InterfacePreviewCustomSettings { """When true, users may customize the layout of this interface preview.""" isLayoutCustomizationEnabled: Boolean! } """ Settings of a fitness indicator: the sales steps it applies to and its rules per warning level. """ type FitnessIndicatorSettings { """ Sales steps this indicator applies to; when empty, it applies to all steps. """ stepIds: [ID!] """ User-defined filter rules for a custom indicator, one per warning level. Null for system indicators. """ customRules: [FitnessCustomRule!] """ Threshold rules for a system indicator, one per warning level (Notice, Warning, Error). Null for custom indicators. """ systemRules: [FitnessSystemRule!] } """Threshold of a built-in fitness indicator for one warning level.""" type FitnessSystemRule { """ When false, this threshold is configured but not evaluated for records. """ isEnabled: Boolean! """ Warning level reached when this threshold is met: Notice, Warning, or Error (Ok means no issue). """ state: WarningLevelEnum! """ Numeric threshold the indicator compares against, interpreted per indicator type (for example a count or a percentage). """ value: Int """ Time window in days over which the indicator is measured, when the indicator type uses one. """ days: Int """ Activity or related entity types this threshold applies to, when the indicator type is scoped to specific types. """ entityTypes: [ID!] """ Period over which a change is measured for trend-based indicators: current week, last two weeks, or current month. """ period: FitnessPeriodEnum } """Severity of a fitness indicator on a lead or opportunity.""" enum WarningLevelEnum { """No issue.""" Ok """Minor issue worth noticing.""" Notice """Issue that needs attention.""" Warning """Serious issue.""" Error } """Period over which a trend-based fitness indicator measures a decrease.""" enum FitnessPeriodEnum { """The current calendar week.""" CurrentWeek """The last two weeks.""" LastTwoWeeks """The current calendar month.""" CurrentMonth } """ Rule of a custom fitness indicator: filter conditions that raise a warning level when a record matches them. """ type FitnessCustomRule { """How the filter boxes combine — And or Or.""" operator: FilterGroupOperator! """Optional boolean formula combining the filter boxes by their number.""" formula: String """Primary group of filter conditions.""" filterMainBox: MainFilterBox! """Additional condition groups, combined per operator/formula.""" filterSiblingBoxes: [FilterBox!]! """ When false, this custom rule is configured but not evaluated for records. """ isEnabled: Boolean! """ Warning level raised when a record matches this rule: Notice, Warning, or Error. """ state: WarningLevelEnum! } """ Field-to-field mapping of a field mapping: default values and per-field operations for the target record. """ type FieldMappingTemplate { """ JSON object holding the default field values for the target record, keyed by field id. """ input: JSONString! """ Per-field operations that derive each target field value from the source record or a value mapping. """ operations: [FieldMappingOperation]! } """JSON value, sent and returned as a string.""" scalar JSONString """How one field of the target record is filled by a field mapping.""" type FieldMappingOperation { """Id of the target field this operation populates.""" fieldId: ID! """ How the target field value is produced — Custom (from a mapping) or SourceRecordValue (copied from the source record). """ operation: FieldMappingOperationEnum """ Id of the source-record field whose value is used when the operation reads from the source record. """ triggeredRecordFieldId: UUID """Source-to-target value translations applied to the field value.""" mapping: EntityOperationMapping } """How a field mapping fills a target field.""" enum FieldMappingOperationEnum { """Value comes from the mapping configuration.""" Custom """ Value is copied from a field of the source record (triggeredRecordFieldId). """ SourceRecordValue } """ Translation of values when a field value is copied to another field, such as from one dropdown option to another. """ type EntityOperationMapping { """Source-to-target value translations applied when copying the field.""" options: [EntityOperationMappingOption] } """One translation of a source value to a target value.""" type EntityOperationMappingOption { """Value on the source field that this option maps from.""" sourceValue: String! """Value the source value is translated to on the target field.""" targetValue: String } """ Field mapping that applies to specific record types of the source and target records. """ type EntityTypeFieldMapping { """Source entity-type ids this mapping applies to.""" sourceTypeIds: [ID!] """Target entity-type ids this mapping applies to.""" targetTypeIds: [ID!] """ Field-to-field mapping used when both the source and target types match. """ mapping: FieldMappingTemplate } """ Settings of a record type, such as the task and appointment types its records may use. """ type EntityTypeSettings { """ Task type ids that may be linked to records of this entity type. Empty or null allows all task types. """ allowedTaskTypeIds: [ID!] """ Appointment type ids that may be linked to records of this entity type. Empty or null allows all appointment types. """ allowedAppointmentTypeIds: [ID!] } """ Configuration of a scoring: score categories, the records it scores and the rules that add or subtract points. """ type EntityScoringSettings { """ Scoring categories that group records by accumulated score range (for example Hot, Warm, Cold). """ categories: [EntityScoringCategory!]! """ Filter that limits which records are eligible for scoring; records outside it are not scored. """ filter: FieldFilter! """Scoring rules whose matching adjusts a record score.""" rules: [EntityScoringRule!] } """ Rule of a scoring that adds points to the score of a record, or subtracts them, when the record matches it. """ interface EntityScoringRule { """Unique identifier of the scoring rule.""" id: UUID! """ When false, the rule is configured but does not contribute to the score. """ isEnabled: Boolean! """Display name of the scoring rule.""" name: String! """ When true, the name is treated as a translation key and localized in the UI; otherwise the literal name text is shown. """ useLang: Boolean! """ How long the points awarded by this rule remain in effect, measured in expirationUnit. Applies only when expirationEnabled is true. """ expiration: Int! """Time unit for the expiration value: hour, day, week, or month.""" expirationUnit: EntityScoringRuleExpirationUnitEnum! """ When true, the points awarded by this rule expire after the configured expiration period; when false, they remain indefinitely. """ expirationEnabled: Boolean! """ Points added to (or, when negative, subtracted from) the record score each time the rule matches. """ score: Int! """ When true, the score is multiplied by a per-record factor instead of being added as a fixed amount. """ scoreMultiplier: Boolean! """ Filter conditions a record must satisfy for the rule to award its score. """ conditions: EntityScoringRuleFilter! } """Time unit after which points awarded by a scoring rule expire.""" enum EntityScoringRuleExpirationUnitEnum { """Points expire after a number of hours.""" Hour """Points expire after a number of days.""" Day """Points expire after a number of weeks.""" Week """Points expire after a number of months.""" Month } """ Scoring rule that changes the score of a record when an email event happens for it, such as an email being opened, clicked or replied to. """ type EntityScoringEmailRule implements EntityScoringRule { """Unique identifier of the scoring rule.""" id: UUID! """ When false, the rule is configured but does not contribute to the score. """ isEnabled: Boolean! """Display name of the scoring rule.""" name: String! """ When true, the name is treated as a translation key and localized in the UI; otherwise the literal name text is shown. """ useLang: Boolean! """ How long the points awarded by this rule remain in effect, measured in expirationUnit. Applies only when expirationEnabled is true. """ expiration: Int! """Time unit for the expiration value: hour, day, week, or month.""" expirationUnit: EntityScoringRuleExpirationUnitEnum! """ When true, the points awarded by this rule expire after the configured expiration period; when false, they remain indefinitely. """ expirationEnabled: Boolean! """ Points added to (or, when negative, subtracted from) the record score each time the rule matches. """ score: Int! """ When true, the score is multiplied by a per-record factor instead of being added as a fixed amount. """ scoreMultiplier: Boolean! """ Filter conditions a record must satisfy for the rule to award its score. """ conditions: EntityScoringRuleFilter! """ Email event that triggers the rule: sent, opened, clicked, replied, bounced, or unsubscribed. """ emailEventType: EntityScoringRuleEmailEventTypeEnum! } """Email event that makes a scoring rule add or subtract points.""" enum EntityScoringRuleEmailEventTypeEnum { """An email was sent to the record.""" Sent """The recipient opened an email.""" Opened """The recipient clicked a link in an email.""" Clicked """The recipient replied to an email.""" Replied """An email to the recipient bounced.""" Bounced """The recipient unsubscribed.""" Unsubscribed } """Conditions a record must meet for a scoring rule to award its score.""" type EntityScoringRuleFilter { """How the filter boxes combine — And or Or.""" operator: FilterGroupOperator! """Optional boolean formula combining the filter boxes by their number.""" formula: String """Primary group of filter conditions.""" filterMainBox: MainFilterBox! """Additional condition groups, combined per operator/formula.""" filterSiblingBoxes: [FilterBox!]! } """ Scoring rule that awards points for activities of a record with a given status. """ type EntityScoringActivityRule implements EntityScoringRule { """Unique identifier of the scoring rule.""" id: UUID! """ When false, the rule is configured but does not contribute to the score. """ isEnabled: Boolean! """Display name of the scoring rule.""" name: String! """ When true, the name is treated as a translation key and localized in the UI; otherwise the literal name text is shown. """ useLang: Boolean! """ How long the points awarded by this rule remain in effect, measured in expirationUnit. Applies only when expirationEnabled is true. """ expiration: Int! """Time unit for the expiration value: hour, day, week, or month.""" expirationUnit: EntityScoringRuleExpirationUnitEnum! """ When true, the points awarded by this rule expire after the configured expiration period; when false, they remain indefinitely. """ expirationEnabled: Boolean! """ Points added to (or, when negative, subtracted from) the record score each time the rule matches. """ score: Int! """ When true, the score is multiplied by a per-record factor instead of being added as a fixed amount. """ scoreMultiplier: Boolean! """ Filter conditions a record must satisfy for the rule to award its score. """ conditions: EntityScoringRuleFilter! """ Activity status that triggers the rule, such as a scheduled or completed activity. """ activityStatus: ActivityStatusEnum! } """Status of a task or appointment.""" enum ActivityStatusEnum { """Task not started yet, or appointment that starts in the future.""" NotStarted """Task being worked on, or appointment taking place now.""" InProgress """Task waiting on someone or something else.""" Waiting """Task done, or appointment that has already ended.""" Completed """Task postponed.""" Deferred """Appointment that was canceled.""" Canceled } """ Scoring rule that awards points when the field values of a record match its conditions. """ type EntityScoringFieldRule implements EntityScoringRule { """Unique identifier of the scoring rule.""" id: UUID! """ When false, the rule is configured but does not contribute to the score. """ isEnabled: Boolean! """Display name of the scoring rule.""" name: String! """ When true, the name is treated as a translation key and localized in the UI; otherwise the literal name text is shown. """ useLang: Boolean! """ How long the points awarded by this rule remain in effect, measured in expirationUnit. Applies only when expirationEnabled is true. """ expiration: Int! """Time unit for the expiration value: hour, day, week, or month.""" expirationUnit: EntityScoringRuleExpirationUnitEnum! """ When true, the points awarded by this rule expire after the configured expiration period; when false, they remain indefinitely. """ expirationEnabled: Boolean! """ Points added to (or, when negative, subtracted from) the record score each time the rule matches. """ score: Int! """ When true, the score is multiplied by a per-record factor instead of being added as a fixed amount. """ scoreMultiplier: Boolean! """ Filter conditions a record must satisfy for the rule to award its score. """ conditions: EntityScoringRuleFilter! """ Numeric field whose value is used as the multiplier when scoreMultiplier is true. """ scoreMultiplierFieldId: UUID } """ Score category of a scoring, such as Hot, Warm or Cold, with its threshold and color. """ type EntityScoringCategory { """Unique identifier of the scoring category.""" id: UUID! """Display name of the scoring category (for example Hot, Warm, Cold).""" label: String! """ When true, the label is treated as a translation key and localized in the UI; otherwise the literal label text is shown. """ useLang: Boolean! """ Upper score threshold of this category. A record falls into the category whose threshold its accumulated score does not exceed. """ value: Int! """Color used to render this category in the UI, encoded as an integer.""" color: Int! } """ Configuration of a health score: categories, how the score is calculated and the indicator rules. """ type EntityHealthSettings { """ Health categories that group records by score range (for example Good, Watch, Critical). """ categories: [HealthCategory!]! """ How indicator scores are combined. Manual uses the score configured on each indicator; Priority derives scores from the order of the indicators. """ calculationType: EntityHealthCalculationTypeEnum! """ Indicator rules that contribute positive or negative points to the health score. """ healthIndicators: EntityHealthFieldConfiguration! """ Indicator rules that force the record into the critical category when they match. """ criticalHealthIndicators: EntityHealthFieldConfiguration! } """ How the scores of health indicators are combined into a record's health score. """ enum EntityHealthCalculationTypeEnum { """Each indicator uses the score configured on it.""" Manual """ Scores are derived from the order of the indicators; earlier indicators weigh more. """ Priority } """ Set of health indicator rules: rules on the record itself and rules on its related records. """ type EntityHealthFieldConfiguration { """Indicator rules evaluated directly on the scored entity.""" filterMainBox: EntityHealthMainFilterBox! """ Additional rule boxes evaluated on related records, each tied to a relation from the scored entity. """ filterSiblingBoxes: [EntityHealthFilterBox!]! } """ Group of health indicator rules evaluated on a record related to the scored record. """ type EntityHealthFilterBox implements FilterBoxInterface { """Unique identifier of the filter box.""" id: String! """Related entity type the indicator rules in this box are evaluated on.""" entity: String! """ Lookup field that connects the scored entity to the related record this box evaluates. """ lookupFieldId: UUID """ Predefined relationship to the related record this box evaluates, such as the next scheduled or last finished activity. """ relation: HardCodedRelation """Health indicator rules evaluated on the related record.""" filterFields: [EntityHealthFieldFilterRule!]! } """ Rule of a health indicator: a condition on a field and the score a record gets when it matches. """ type EntityHealthFieldFilterRule implements FilterFieldRuleInterface { """Unique identifier of the health indicator rule.""" id: UUID! """ Identifier of the field this rule evaluates when computing the health score. """ field: String! """ Comparison operator applied between the field value and the rule values, such as equals, contains, or between. """ operator: FieldOperator """ Values the field is compared against. The outer list holds OR groups; each inner list holds the operands for a single comparison. """ values: [[String]] """Human-readable label describing what this health indicator measures.""" description: String! """-1 for critical, otherwise choose between 0 and 100""" score: Int! } """Group of health indicator rules evaluated on the scored record itself.""" type EntityHealthMainFilterBox implements FilterBoxInterface { """Unique identifier of the filter box.""" id: String! """Entity type the indicator rules in this box are evaluated on.""" entity: String! """ When the box evaluates a related record, the lookup field that connects this entity to that record. """ lookupFieldId: UUID """Health indicator rules evaluated directly on the scored entity.""" filterFields: [EntityHealthFieldFilterRule!]! } """ Health category, such as Good or Critical: a score range with its label and color. """ type HealthCategory { """Unique identifier of the health category.""" id: UUID! """ Display name of the health category (for example Good, Watch, Critical). """ label: String! """ When true, the label is treated as a translation key and localized in the UI; otherwise the literal label text is shown. """ useLang: Boolean! """ Upper health-score threshold of this category. A record falls into the category whose threshold its score does not exceed. The critical category uses -1. """ value: Int! """Color used to render this category in the UI, encoded as an integer.""" color: Int! } """ Definition of an email sequence: the records it enrolls, the steps it runs and its sending settings. """ type EmailSequenceSchema { """Defines which record type and email field enroll into the sequence.""" trigger: EmailSequenceTrigger! """ Ordered steps of the sequence, each sending an email or creating a record subject to its condition and day offset. """ nodes: [EmailSequenceNode!]! """ Scheduling window, time zone, global actions, and lifecycle options for the sequence. """ settings: EmailSequenceSettings! } """ Sending window, time zone, active period and sequence-wide reactions of an email sequence. """ type EmailSequenceSettings { """ Sequence-wide reactions to recipient replies, unsubscribes, bounces, and custom conditions. """ globalActions: EmailSequenceGlobalActionsSettings! """ IANA time-zone name (for example Europe/Bratislava) in which the sending window and active dates are interpreted. """ timezone: String! """ Weekdays on which emails may be sent, given as numbers 1 (Monday) through 7 (Sunday). """ dayOfWeek: [Int!]! """ Start of the daily sending window, expressed as minutes after midnight (0-1440). """ fromTimeOfDay: Int! """ End of the daily sending window, expressed as minutes after midnight (0-1440); must be greater than fromTimeOfDay. """ toTimeOfDay: Int! """ When true, each email starts its own conversation thread; when false, all emails of one enrollment share a single thread. """ everyEmailStartsConversation: Boolean! """ When true, the sequence starts the process given by triggerProcessId for records it creates. """ triggerProcess: Boolean """Identifier of the process to start when triggerProcess is enabled.""" triggerProcessId: UUID """ Date from which the sequence is allowed to send; earlier scheduling waits until this date. """ activeFrom: Date """Date after which the sequence stops sending.""" activeTo: Date """ When true, records still enrolled after activeTo passes are automatically removed from the sequence. """ autoUnenrollWhenExpired: Boolean } """ Sequence-wide reactions of an email sequence to replies, unsubscribes and custom conditions, such as ending the enrollment or sending an email. """ type EmailSequenceGlobalActionsSettings { """ When true, the sequence reacts when a recipient replies to one of its emails. """ onReply: Boolean! """When true, a recipient who replies is removed from the sequence.""" onReplyUnenroll: Boolean! """When true, an email is sent in response to a reply.""" onReplySendEmail: Boolean! """Email sent in response to a reply.""" onReplyEmail: EmailSequenceNodeEmail """When true, a record is created in response to a reply.""" onReplyCreateEntity: Boolean! """Template for the record created in response to a reply.""" onReplyEntity: ProcessEntityTemplate """ When true, the sequence reacts when a recipient unsubscribes, removing them from the sequence. """ onUnsubscribe: Boolean! """When true, a record is created when a recipient unsubscribes.""" onUnsubscribeCreateEntity: Boolean! """Template for the record created when a recipient unsubscribes.""" onUnsubscribeEntity: ProcessEntityTemplate """ When true, the sequence evaluates the custom condition filter and acts when it matches. """ onCondition: Boolean! """ Field-based filter that defines the custom condition checked against the enrolled record. """ onConditionFilter: EmailSequenceFilter! """ When true, a record matching the custom condition is removed from the sequence. """ onConditionUnenroll: Boolean! """When true, an email is sent when the custom condition matches.""" onConditionSendEmail: Boolean! """Email sent when the custom condition matches.""" onConditionEmail: EmailSequenceNodeEmail """When true, a record is created when the custom condition matches.""" onConditionCreateEntity: Boolean! """Template for the record created when the custom condition matches.""" onConditionEntity: ProcessEntityTemplate """When true, the sequence reacts when one of its emails bounces.""" onBounce: Boolean! """ When true, a recipient whose email bounces is removed from the sequence. """ onBounceUnenroll: Boolean! """ When true, a recipient whose email bounces is also marked as unsubscribed. """ onBounceUnsubscribe: Boolean! } """ Values that a process, email sequence or online form sets on a record it creates or updates. """ type ProcessEntityTemplate { """ Per-field operations describing how each field value of the created or updated record is determined. """ operations: [ProcessEntityOperation!]! """ Field values to apply to the record, as a JSON object keyed by field API name. The accompanying operations describe how each value is interpreted. """ input: JSONString! } """ How one field of a record created or updated by automation gets its value. """ type ProcessEntityOperation { """Field on the target record that this operation sets.""" fieldId: UUID! """ How the field value is determined: a custom value, a value copied from the triggered record, the trigger actor, the process owner, or cleared. """ operation: ProcessEntityOperationEnum """Extra settings for operation.""" extras: ProcessEntityOperationExtras """ Field on the triggered record whose value is copied into the target field. Used when the value is taken from the triggered record. """ triggeredRecordFieldId: UUID """ Lookup field that resolves the related record the copied value is read from, when the source value comes through a relation. """ triggeredLookupRelationFieldId: UUID """ Translation of source values to target values when copying a field value, mapping each source option to the value to set. """ mapping: EntityOperationMapping } """ How a process action sets one field on the record it creates or updates: a custom value, a value taken from the triggered record, a specific user, or cleared. """ enum ProcessEntityOperationEnum { """Sets the value given in the action's input.""" Custom """ Copies the value from the triggered record: the same field, or the field set in triggeredRecordFieldId; for an owner field, the triggered record's owner. """ TriggeredRecordValue """ Like TriggeredRecordValue, but takes only the primary user from a user lookup field on the triggered record (TriggeredRecordValue takes all of its users). """ TriggeredRecordPrimaryValue """Clears the owner, leaving the record unassigned.""" Unassigned """Sets the owner to the user whose action triggered the process.""" TriggerActor """Sets the owner to the owner of the process.""" ProcessOwner """ Combines the values from the action's input with the values copied from the triggered record. """ CustomAndTriggered """Sets the input value, replacing any existing values of the field.""" CustomReplaceExisting """ Adds the input values to the values the field already has (multi-value, lookup, sharing and relation fields). """ CustomAddToExisting """Removes the input values from the values the field already has.""" CustomRemoveExisting """ For a currency field, sets both the amount and the currency from the input and recalculates the value in the base currency. """ CustomUpdateValueAndCode """ For a currency field, changes only the currency from the input, keeps the existing amount and recalculates the value in the base currency. """ CustomUpdateOnlyCode """ Replaces the existing values with the values copied from the triggered record. """ TriggeredRecordValueReplaceExisting """ Adds the values copied from the triggered record to the existing values. """ TriggeredRecordValueAddToExisting """ Removes the values found on the triggered record from the existing values. """ TriggeredRecordValueRemoveExisting """ Replaces the existing users with the primary user of a user lookup field on the triggered record. """ TriggeredRecordPrimaryValueReplaceExisting """ Adds the primary user of a user lookup field on the triggered record to the existing users. """ TriggeredRecordPrimaryValueAddToExisting """ Removes the primary user of a user lookup field on the triggered record from the existing users. """ TriggeredRecordPrimaryValueRemoveExisting """ Takes the value from the triggered record's primary account and replaces the existing values. """ TriggeredRecordPrimaryAccountReplaceExisting """ Takes the value from the triggered record's primary account and adds it to the existing values. """ TriggeredRecordPrimaryAccountAddToExisting """ Takes the value from the triggered record's primary account and removes it from the existing values. """ TriggeredRecordPrimaryAccountRemoveExisting """ Takes the value from the triggered record's primary contact and replaces the existing values. """ TriggeredRecordPrimaryContactReplaceExisting """ Takes the value from the triggered record's primary contact and adds it to the existing values. """ TriggeredRecordPrimaryContactAddToExisting """ Takes the value from the triggered record's primary contact and removes it from the existing values. """ TriggeredRecordPrimaryContactRemoveExisting """ Takes the value from the triggered account's parent account and replaces the existing values. """ TriggeredRecordParentAccountReplaceExisting """ Takes the value from the triggered account's parent account and adds it to the existing values. """ TriggeredRecordParentAccountAddToExisting """ Takes the value from the triggered account's parent account and removes it from the existing values. """ TriggeredRecordParentAccountRemoveExisting """ Takes the value from the account of the triggered record (such as a project's account) and adds it to the existing values. """ TriggeredRecordAccountAddToExisting """ Takes the value from the account of the triggered record (such as a project's account) and replaces the existing values. """ TriggeredRecordAccountReplaceExisting """ Takes the value from the account of the triggered record (such as a project's account) and removes it from the existing values. """ TriggeredRecordAccountRemoveExisting """Copies the value from the triggered record's primary account.""" TriggeredRecordPrimaryAccountValue """Copies the value from the triggered record's primary contact.""" TriggeredRecordPrimaryContactValue """Copies the value from the triggered account's parent account.""" TriggeredRecordParentAccountValue """ Copies the value from the account of the triggered record (such as a project's account). """ TriggeredRecordAccountValue """ Combines the input values with the values copied from the triggered record and replaces the existing values with them. """ TriggeredRecordValueCustomReplaceExisting """ Combines the input values with the values copied from the triggered record and adds them to the existing values. """ TriggeredRecordValueCustomAddToExisting """ Removes both the input values and the values copied from the triggered record from the existing values. """ TriggeredRecordValueCustomRemoveExisting """ For a currency field, copies both the amount and the currency from the triggered record. """ TriggeredRecordValueUpdateValueAndCode """ For a currency field, copies only the currency from the triggered record and keeps the existing amount. """ TriggeredRecordValueUpdateOnlyCode """ Copies the value of the field set in triggeredRecordFieldId: a field of the submitted online form, or, for an owner field, the user held in that field of the triggered record. """ TriggeredRecordField """ Sets the owner to the owner of the record the submitted online form belongs to. """ TriggeredPrimaryRecordOwner """ Links the triggered record itself in a relation field, replacing the existing links (for example, sets the triggered account as the parent account). """ TriggeredRecord """ Adds the triggered record itself to the existing links of a relation field. """ TriggeredRecordAddToExisting """ Removes the triggered record itself from the existing links of a relation field. """ TriggeredRecordRemoveExisting """ Sets the owner of the triggered record as the only watcher or editor, replacing the existing ones. """ TriggeredRecordOwner """ Same as TriggeredRecordOwner: the triggered record's owner replaces the existing watchers or editors. """ TriggeredRecordOwnerReplaceExisting """ Adds the owner of the triggered record to the existing watchers or editors. """ TriggeredRecordOwnerAddToExisting } """ Extra options of a field operation, such as keeping the previous owner as an editor. """ type ProcessEntityOperationExtras { """ When the owner changes, keep the previous owner as an editor of the record. """ keepOwnerAsEditor: Boolean """ Whether to send invitations to attendees when the operation sets appointment attendees. """ sendInvitations: Boolean } """ Email sent by an email sequence: recipients, content, sender and the records it is linked to. """ type EmailSequenceNodeEmail implements EmailDataInterface { """ Primary recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ recipients: [SendEmailRecipient!]! """ Carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ cc: [SendEmailRecipient!]! """ Blind carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ bcc: [SendEmailRecipient!]! """ Subject line of the email. May contain personalization tags resolved from the triggered record. """ subject: String! """ HTML body of the email. May contain personalization tags resolved from the triggered record. """ body: String! """ Email template to use for the message. When set, the template supplies the subject and body. """ emailTemplateId: UUID """Stored files attached to the email.""" attachments: [UUID!]! """Signature appended to the email body.""" signature: String """ True when the chosen template is an HTML template rather than a plain-text one. """ isHtmlTemplate: Boolean """ When true, the sent email is linked to the record that triggered the sequence. """ linkTriggerEntity: Boolean """ When true, the sent email is linked to the recipient records it is addressed to. """ linkRecipients: Boolean """ Who the email is sent as. ActorEmail uses the user running the sequence, CompanyEmail uses a shared company mailbox, and RecordOwnerEmail uses the owner of the triggered record. """ sender: EmailSequenceNodeEmailSender! """ Company email account used as the sender when the sender is set to CompanyEmail. """ senderCompanyEmailId: UUID """ Sharing visibility applied to the sent email. Standard follows default sharing, Private restricts it to the owner, AllView grants everyone read access, and AllEdit grants everyone edit access. """ shareMode: ShareModeEnum } """ Recipients and content of an email sent automatically by an automation, an email sequence or a scheduled report. """ interface EmailDataInterface { """ Primary recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ recipients: [SendEmailRecipient!]! """ Carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ cc: [SendEmailRecipient!]! """ Blind carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ bcc: [SendEmailRecipient!]! """ Subject line of the email. May contain personalization tags resolved from the triggered record. """ subject: String! """ HTML body of the email. May contain personalization tags resolved from the triggered record. """ body: String! """ Email template to use for the message. When set, the template supplies the subject and body. """ emailTemplateId: UUID """Stored files attached to the email.""" attachments: [UUID!]! """Signature appended to the email body.""" signature: String } """Mailbox an email sequence step sends from.""" enum EmailSequenceNodeEmailSender { """The user who enrolled the record.""" ActorEmail """A shared company email account.""" CompanyEmail """The owner of the enrolled record.""" RecordOwnerEmail } """Who besides the owner can see and edit a record.""" enum ShareModeEnum { """ Visible according to user roles and sales units, plus the users and units listed in sharingClients and sharingUnits. """ Standard """Visible only to the owner.""" Private """All users can view the record.""" AllView """All users can view and edit the record.""" AllEdit } """ Recipient of an email: the address and the records it represents, which the sent email is linked to and whose data fill its placeholders. """ type SendEmailRecipient { """ Which linked record (e.g. Contact or Account) this recipient primarily represents, used when linking the sent email to a record. """ primary: EntityLacotaType """ Opportunity this recipient is associated with, when sending in the context of an opportunity. """ opportunityId: UUID """Contact this recipient corresponds to, when known.""" contactId: UUID """Account this recipient corresponds to, when known.""" accountId: UUID """ Lead this recipient is associated with, when sending in the context of a lead. """ leadId: UUID """ Project this recipient is associated with, when sending in the context of a project. """ projectId: UUID """ Quote this recipient is associated with, when sending in the context of a quote. """ quoteId: UUID """ Custom entity records this recipient is associated with, each given as a `CustomEntityID`. """ customEntityIds: [CustomEntityID] """Email address the message is sent to.""" address: String! } """ Record entity that an email recipient or a related-record filter refers to, such as an account, contact, lead or quote. """ enum EntityLacotaType { """An account record.""" Account """A contact record.""" Contact """A task record.""" Task """An appointment record.""" Appointment """A lead record.""" Lead """An opportunity record.""" Opportunity """A project record.""" Project """A quote record.""" Quote """A record of a custom entity.""" CustomEntity } """ Reference to a custom entity record: the API name of its custom entity and its id. """ type CustomEntityID { """API name of the custom entity type the referenced record belongs to.""" entityApiName: String! """Identifier of the referenced custom entity record.""" id: UUID! } """Field conditions an email sequence checks against an enrolled record.""" type EmailSequenceFilter { """Primary group of field conditions evaluated against the record.""" filterMainBox: MainFilterBox! """ Additional condition groups combined with the main group to form the complete filter. """ filterSiblingBoxes: [FilterBox!]! """ Logical operator (AND or OR) that joins the condition groups when no explicit formula is given. """ operator: FilterGroupOperator! """ Optional boolean expression referencing the condition groups by number to combine them in a custom way. """ formula: String } """ Step of an email sequence: sends an email or creates a record a set number of days after the previous step, when its condition holds. """ interface EmailSequenceNode { """Unique identifier of this step within the sequence.""" id: UUID! """Condition that decides whether this step runs or the enrollment ends.""" condition: EmailSequenceNodeCondition! """ Number of days to wait before this step runs, counted from the previous step (or from enrollment for the first step). """ dayOffset: Int! } """Email sequence step that sends an email.""" type EmailSequenceSendEmailNode implements EmailSequenceNode { """Unique identifier of this step within the sequence.""" id: UUID! """Condition that decides whether this step runs or the enrollment ends.""" condition: EmailSequenceNodeCondition! """ Number of days to wait before this step runs, counted from the previous step (or from enrollment for the first step). """ dayOffset: Int! """ Email message this step sends, including recipients, content, and sender. """ email: EmailSequenceNodeEmail! } """ Condition a step of an email sequence checks before it runs, such as no reply to the previous email; when it fails, the enrollment ends. """ type EmailSequenceNodeCondition { """ Condition that must hold for the step to run. Always runs unconditionally; NotOpen, NoClick, and NoReply check whether the previous email was opened, clicked, or replied to; TaskCompleted, TaskNotCompleted, and TaskNotUpdated check the previous task; Custom evaluates the filter. """ action: EmailSequenceNodeConditionActionEnum! """ Field-based filter evaluated against the record when the action is Custom. """ filter: EmailSequenceFilter! } """ Condition a sequence step checks against the previous step before it runs; when it fails, the recipient leaves the sequence. """ enum EmailSequenceNodeConditionActionEnum { """The step always runs; required for the first step.""" Always """Runs only if the previous email was not opened.""" NotOpen """Runs only if no link in the previous email was clicked.""" NoClick """Runs only if the previous email was not replied to.""" NoReply """ Runs only if the task created by the previous step has not been modified. """ TaskNotUpdated """Runs only if the task created by the previous step is not completed.""" TaskNotCompleted """Runs only if the task created by the previous step is completed.""" TaskCompleted """ Runs only if the previous step's email or task matches the custom filter. """ Custom } """ Email sequence step that creates a record, such as a task, for the enrolled record. """ type EmailSequenceCreateRecordNode implements EmailSequenceNode { """Unique identifier of this step within the sequence.""" id: UUID! """Condition that decides whether this step runs or the enrollment ends.""" condition: EmailSequenceNodeCondition! """ Number of days to wait before this step runs, counted from the previous step (or from enrollment for the first step). """ dayOffset: Int! """ Template describing the record to create when this step runs, including the field values to set. """ entity: ProcessEntityTemplate """Type of record created by this step. Currently only Task is supported.""" entityType: EntityNameEnum! } """ Record type an email sequence enrolls and the email field whose address its emails are sent to. """ type EmailSequenceTrigger { """ Type of record that enrolls into the sequence when the trigger fires, such as Contact, Account, Lead, Opportunity, or Project. """ entityType: EntityNameEnum! """ Identifier of the email field on the trigger record whose address the sequence sends to. """ fieldId: ID! """API name of the trigger record type when it is a custom entity.""" entityApiName: String """ Identifier of a relation field used to resolve the email recipient from a related record rather than the trigger record itself. """ relationLookupFieldId: ID } """ Email that delivers a scheduled report: recipients, sending account, content and the attached report file. """ type ScheduledReportEmail implements EmailDataInterface { """ Primary recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ recipients: [SendEmailRecipient!]! """ Carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ cc: [SendEmailRecipient!]! """ Blind carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ bcc: [SendEmailRecipient!]! """ Subject line of the email. May contain personalization tags resolved from the triggered record. """ subject: String! """ HTML body of the email. May contain personalization tags resolved from the triggered record. """ body: String! """ Email template to use for the message. When set, the template supplies the subject and body. """ emailTemplateId: UUID """Stored files attached to the email.""" attachments: [UUID!]! """Signature appended to the email body.""" signature: String """ When true, the sent report email is linked to its recipient records (accounts/contacts) so it appears in their activity feed. """ linkRecipients: Boolean """ Email account used to send the report, described as a `SendEmailService` (personal, company, or client personal account). """ service: SendEmailService! """ Legacy sending-provider selector (O365, Google, or SendGrid) kept for report settings created before per-account sending was introduced. Prefer `service`. """ personalAccount: EmailServiceTypeEnum """ Settings for the report file attached to the email (format and compression). When omitted, the email must instead include the report download link in its subject or body. """ reportAttachment: ScheduledReportEmailAttachment } """Email service a company email account sends through.""" enum EmailServiceTypeEnum { """Microsoft 365 (Outlook) account.""" O365Email """Google (Gmail / Google Workspace) account.""" GoogleEmail """SendGrid account.""" SendGrid } """ Report file attached to a scheduled report email: its format, and whether it is zipped and password-protected. """ type ScheduledReportEmailAttachment { """ Render the attached report as a CSV file with these options. Exactly one of the format fields may be set. """ formatCsv: CsvOptions """ Render the attached report as an XLSX file with these options. Exactly one of the format fields may be set. """ formatXlsx: XlsxOptions """ When true, attach the report as HTML. Exactly one of the format fields may be set. """ formatHtml: Boolean """ Render the attached report as a PDF with these options. Exactly one of the format fields may be set. """ formatPdf: PdfOptions """ When true, the report attachment is delivered as a compressed ZIP archive. """ compress: Boolean """ Password protecting the compressed attachment. Can only be set when `compress` is enabled. """ password: String """ True when the stored `password` value is already encrypted rather than plain text. """ isPasswordEncrypted: Boolean } """Options of a scheduled report attached to its email as a PDF file.""" type PdfOptions { """Width of the PDF page, in inches.""" pageWidth: Float! """Height of the PDF page, in inches.""" pageHeight: Float! """ When true, the PDF is laid out in landscape orientation; otherwise portrait. """ landscape: Boolean! """ Scaling factor applied when rendering the report into the PDF, where 1.0 is full size. """ scale: Float! """When true, page numbers are printed on the generated PDF.""" pageNumbers: Boolean! """ Which parts of the report to include in the PDF: All content, only Charts, or only the Table. """ content: ReportContent! } """Parts of a report included in a PDF export.""" enum ReportContent { """Both charts and the table.""" All """Only the charts.""" Charts """Only the table.""" Table } """ Options of a scheduled report attached to its email as an Excel (XLSX) file. """ type XlsxOptions implements ForeignCurrencyOption { """ When true, monetary values are also rendered in each record's foreign currency alongside the base-currency amounts. """ includeForeignCurrency: Boolean """ Level of detail of the generated XLSX export: a "simplified" layout or the "full" report. """ type: ReportXlsxType } """ Options of a scheduled report attachment that can add the amounts in foreign currencies. """ interface ForeignCurrencyOption { """ When true, monetary values are also rendered in each record's foreign currency alongside the base-currency amounts. """ includeForeignCurrency: Boolean } """Level of detail of an XLSX report export.""" enum ReportXlsxType { """Data rows only, without total and summary rows.""" simplified """The full report layout, including totals and summary rows.""" full } """Options of a scheduled report attached to its email as a CSV file.""" type CsvOptions implements ForeignCurrencyOption { """ When true, monetary values are also rendered in each record's foreign currency alongside the base-currency amounts. """ includeForeignCurrency: Boolean """ Character separating fields in the generated CSV: comma, semicolon, tab or colon. """ delimiter: CsvDelimiter """ Character used to quote field values that contain the delimiter: double quotation mark or apostrophe. """ quotechar: CsvQuotechar """Character encoding of the generated CSV file (e.g. "UTF-8").""" encoding: String } """Character that separates values in a generated CSV file.""" enum CsvDelimiter { """Comma (,).""" comma """Semicolon (;).""" semicolon """Tab character.""" tab """Colon (:).""" colon } """Character used to quote values in a generated CSV file.""" enum CsvQuotechar { """Double quotation mark (").""" quotation """Apostrophe (').""" apostrophe } """ Email account an email is sent from: the sender's own account, a shared company account or, for a mass email, a client personal email account. """ type SendEmailService { """ Identifier of the sender's own connected email account to send from. Exactly one of the account fields may be set. """ personalAccountId: UUID """ Identifier of a shared company email account to send from. Exactly one of the account fields may be set. """ companyAccountId: UUID """ Identifier of a client personal email account to send from. Valid only for mass email. Exactly one of the account fields may be set. """ clientPersonalEmailAccountId: UUID } """ Settings of a scheduled report: when it runs, the email it sends and an optional follow-up task. """ type ReportScheduleSchema { """Recurrence defining when the report is generated and emailed.""" schedule: ReportSchedule! """ Email delivered on each run: recipients, sending account, content and report attachment options. """ email: ScheduledReportEmail! """Optional follow-up task created each time the report email is sent.""" followUp: EmailFollowUpTask """ IANA timezone name used to interpret the schedule times (e.g. "Europe/Bratislava"). """ timezone: String """ When true, the scheduled email is not sent on runs where the report contains no data. """ skipEmpty: Boolean! """When true, scheduled runs that fall on a weekend are skipped.""" workingDaysOnly: Boolean } """Follow-up task created each time a scheduled report email is sent.""" type EmailFollowUpTask { """ Activity type assigned to the follow-up task created when the report email is sent. """ taskTypeId: ID! """ Number of business days after the report email is sent that the follow-up task is due (0 = the sending day). Either this or `dueDate` must be set, but not both. """ dueDateOffset: Int """ Explicit due date for the follow-up task. Either this or `dueDateOffset` must be set, but not both. """ dueDate: Date } """ When a scheduled report runs: once at a given date and time, or repeatedly at a time of day on chosen days. """ type ReportSchedule implements ScheduleInterface { """ Date and time the schedule runs once. Set for a one-time schedule; left empty for recurring schedules that use the time-of-day and day fields instead. """ date: DateTime """ Time of day a recurring schedule runs, in minutes after midnight (0 to 1439). """ timeOfDay: Int """Weekdays a weekly schedule runs on, from 1 (Monday) to 7 (Sunday).""" dayOfWeek: [Int!] """Days of the month a monthly schedule runs on, from 1 to 31.""" dayOfMonth: [Int!] } """ When a schedule runs: once at a set date and time, or every day, week or month at a time of day. """ interface ScheduleInterface { """ Date and time the schedule runs once. Set for a one-time schedule; left empty for recurring schedules that use the time-of-day and day fields instead. """ date: DateTime """ Time of day a recurring schedule runs, in minutes after midnight (0 to 1439). """ timeOfDay: Int """Weekdays a weekly schedule runs on, from 1 (Monday) to 7 (Sunday).""" dayOfWeek: [Int!] """Days of the month a monthly schedule runs on, from 1 to 31.""" dayOfMonth: [Int!] } """ The `DateTime` scalar type represents a DateTime value as specified by [iso8601](https://en.wikipedia.org/wiki/ISO_8601). """ scalar DateTime """ Settings of a table or advanced report: its structure of report tables and pivot tables. """ type ReportSchema { """ Flat list of the report's structure items (tables and pivots) linked by parent identifiers to form the report tree; exactly one item is the root. """ structure: [ReportStructureItem!]! """ This flag defines if report should be handled with advanced report GUI or not """ isAdvancedReport: Boolean } """ Item of a report structure: a report table or pivot table placed in the report tree. """ interface ReportStructureItem { """Unique identifier of this item within the report structure.""" id: ID! """ ID of a parent report structure, if ID is NULL this identifies root item, no more than one root item is allowed """ parentId: ID """Order of the item on the within same parent""" sortOrder: Int! } """ Report table: rows of a main record type with columns from related records, plus its filter and view settings. """ type ReportTable implements ReportStructureItem { """Unique identifier of this item within the report structure.""" id: ID! """ ID of a parent report structure, if ID is NULL this identifies root item, no more than one root item is allowed """ parentId: ID """Order of the item on the within same parent""" sortOrder: Int! """ Primary box of the table, defining the entity each row represents and its displayed columns. """ mainBox: ReportMainBox! """ Related boxes joined to the main box to pull in or aggregate data from related records. """ siblingBoxes: [SiblingBoxInterface!]! """Filter and view settings for the table report.""" tabs: TableReportTabsInterface! } """ Filter and view settings of a report table; the variant depends on the record type of the table's main box. """ interface TableReportTabsInterface { """ Filter conditions that determine which records the table report includes. """ filter: ProfileFilterBaseInterface! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! } """ Settings of a report table that lists custom entity records: filter, ownership scope, quick filter and the table view. """ type CustomEntityTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & CustomEntityProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: CustomEntityFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: CustomEntityRoleTab! } """ Saved profile or report that supports a quick filter on top of its saved filter. """ interface QuickFilterInterface { """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! } """ Settings shared by every saved profile, report and dashboard, starting with the filter that selects its records. """ interface ProfileTabsInterface { """Filter conditions that determine which records the profile includes.""" filter: ProfileFilterBaseInterface! } """Saved profile or report whose filter is built from filter boxes.""" interface ProfileFilterBoxTabsInterface { """Filter conditions that determine which records the profile includes.""" filter: ProfileFilterBoxTabInterface! } """ Saved profile or report that restricts the records shown by ownership scope, such as own, shared or managing-unit items. """ interface RoleProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: ProfileFilterBaseInterface! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: RoleTabInterface! } """ Ownership scope of a report or view: which records are included by their relation to the current user. """ interface RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! } """ Settings shared by the saved profiles and reports on custom entity records: the filter and the ownership scope of the custom entity records shown. """ interface CustomEntityProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: CustomEntityFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: CustomEntityRoleTab! } """Filter and view settings of a report table or pivot table.""" interface ReportTabInterface { """Filter conditions that determine which records the profile includes.""" filter: ProfileFilterBaseInterface! } """ Ownership scope of custom entity reports and views: which records are included by their relation to the current user. """ type CustomEntityRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! } """ Ad-hoc filter applied on top of the saved filter of a profile or report to narrow the records shown without changing the saved filter. """ type QuickFilterTab { """ Primary group of quick-filter conditions evaluated on the main record type. """ filterMainBox: MainFilterBox! """ Additional groups of quick-filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ Identifiers of the filtered fields in the order they are shown in the quick filter. """ filterFieldOrder: [UUID!]! } """ View settings of a report table: sorting, grouping, totals, chart and computed value fields. """ type ViewTableReportTab implements ViewReportTab { """ Which leading rows and columns stay frozen while scrolling: none, the first row, the first column, or the first row and column. """ frozenPanes: FrozenPaneType! """Chart configuration for this report tab.""" chart: ReportChart! """ Additional value fields computed for the report, such as calculated formula fields, rollup summary fields and converted-currency fields. """ reportValueFields: [ReportValueField!]! """ History configuration when the report tracks field values over time, either as a comparison against specific dates or as a trend over a period. """ history: ReportHistory """ Identifier of the currency that monetary values in the report are displayed in. """ currencyId: UUID! """ Fields the table rows are sorted by, in priority order, each with its sort direction. """ sortFields: [SortField!]! """Fields the table rows are grouped by, in nesting order.""" groupFields: [GroupField!]! """Configuration of the totals rows shown for groups and the whole table.""" total: TableReportTotal! """ Whether line breaks within text values are preserved when the table is rendered. """ keepLineBreaks: Boolean! } """ View settings shared by report tables and pivot tables: frozen panes, chart, computed value fields, history and currency. """ interface ViewReportTab { """ Which leading rows and columns stay frozen while scrolling: none, the first row, the first column, or the first row and column. """ frozenPanes: FrozenPaneType! """Chart configuration for this report tab.""" chart: ReportChart! """ Additional value fields computed for the report, such as calculated formula fields, rollup summary fields and converted-currency fields. """ reportValueFields: [ReportValueField!]! """ History configuration when the report tracks field values over time, either as a comparison against specific dates or as a trend over a period. """ history: ReportHistory """ Identifier of the currency that monetary values in the report are displayed in. """ currencyId: UUID! } """ Which leading rows and columns of a report table stay visible while scrolling. """ enum FrozenPaneType { """Nothing is frozen.""" NoRowCol """The first row is frozen.""" FirstRow """The first column is frozen.""" FirstCol """The first row and the first column are frozen.""" FirstRowCol } """ Value field computed for a report: a calculated formula, a rollup summary or a currency conversion. """ union ReportValueField = CalculatedField | SummaryField | ConvertedCurrencyField """ History settings of a report that shows past values of tracked fields: comparison dates or a historical trend. """ union ReportHistory = ReportComparisonDatesHistory | ReportHistoricalTrendHistory """ Totals of a report table: which totals (sum, average, minimum, maximum, status) are shown and where. """ type TableReportTotal { """ Whether the totals row is shown for each group in a table report. Has no effect unless at least one of the individual total values below is enabled. """ isEnabled: Boolean! """ Whether a grand total covering all rows is shown in addition to the per-group totals. """ showGrandTotal: Boolean! """ Whether the totals appear above the rows they summarise (Top) or below them (Bottom). """ position: ReportTotalPosition! """Whether the sum of each numeric column is shown in the totals.""" showSum: Boolean! """Whether the average of each numeric column is shown in the totals.""" showAverage: Boolean! """ Whether the minimum value of each numeric column is shown in the totals. """ showMin: Boolean! """ Whether the maximum value of each numeric column is shown in the totals. """ showMax: Boolean! """ Whether a status breakdown (such as won, lost and open counts for opportunities or leads) is shown in the totals. """ showStatus: Boolean! } """Where totals are placed relative to the values they summarize.""" enum ReportTotalPosition { """Totals appear above the rows.""" Top """Totals appear below the rows.""" Bottom } """Field a table report groups its rows by.""" type GroupField implements ReportField { """Identifier of the report box that the field belongs to.""" boxId: ID! """Identifier of the field being referenced.""" fieldId: ID! """ How records are grouped on this field, for example by day, week, month, quarter or year for dates, by first letter for text, or by manual or automatic intervals for numbers. """ groupOption: GroupOption """ Custom numeric intervals used to group records when the group option is set to manual intervals. """ groupIntervals: [GroupInterval!] } """Reference to a field of a report box, used for sorting and grouping.""" interface ReportField { """Identifier of the report box that the field belongs to.""" boxId: ID! """Identifier of the field being referenced.""" fieldId: ID! } """Numeric interval used to group the rows of a report.""" type GroupInterval { """Lower bound of the numeric interval, inclusive.""" start: Float """Upper bound of the numeric interval, exclusive.""" end: Float } """Field a table report sorts its rows by, with the sort direction.""" type SortField implements ReportField { """Identifier of the report box that the field belongs to.""" boxId: ID! """Identifier of the field being referenced.""" fieldId: ID! """ Sort direction for this field, either ascending (Asc) or descending (Desc). """ direction: SortOrder! } """ History settings that plot the values of tracked fields as a trend over a period. """ type ReportHistoricalTrendHistory implements ReportHistoryCommon { """ Identifiers of the fields whose historical values are tracked and made available to the report. """ trackedFieldIds: [UUID]! """ History value fields produced by the report, each tied to a tracked field and, for comparison reports, a comparison date. """ fields: [ReportHistoryField!]! """Time span over which the historical trend is plotted.""" period: PeriodOption! """ Interval at which trend data points are sampled across the period, such as Day, Week, Month, Quarter or Year. """ periodGranularity: PeriodGranularity! } """ History settings shared by both history modes: the tracked fields and the history value fields the report produces. """ interface ReportHistoryCommon { """ Identifiers of the fields whose historical values are tracked and made available to the report. """ trackedFieldIds: [UUID]! """ History value fields produced by the report, each tied to a tracked field and, for comparison reports, a comparison date. """ fields: [ReportHistoryField!]! } """Length of the time bucket each data point of a trend chart represents.""" enum PeriodGranularity { """Each data point covers one day.""" Day """Each data point covers one week.""" Week """Each data point covers one month.""" Month """Each data point covers one quarter.""" Quarter """Each data point covers one year.""" Year } """ History value field of a report: a tracked field's past value at a comparison date, or a record count. """ type ReportHistoryField { """Unique identifier of this history field within the report.""" id: UUID! """ Identifier of the tracked field whose historical value is reported; left empty when the history field counts records. """ fieldId: UUID """ Identifier of the comparison date this history value is taken at, for comparison-date history reports. """ comparisonDateId: UUID } """ History settings that compare the values of tracked fields at selected dates. """ type ReportComparisonDatesHistory implements ReportHistoryCommon { """ Identifiers of the fields whose historical values are tracked and made available to the report. """ trackedFieldIds: [UUID]! """ History value fields produced by the report, each tied to a tracked field and, for comparison reports, a comparison date. """ fields: [ReportHistoryField!]! """ Dates the tracked field values are compared against in this comparison-type history report. """ comparisonDates: [ReportHistoryComparisonDate!]! } """ Date at which tracked field values are compared: a fixed date, a special value or a date relative to today. """ type ReportHistoryComparisonDate { """Unique identifier of this comparison date.""" id: UUID! """ Fixed calendar date to compare against; set when neither a dynamic date nor a special value is used. """ date: Date """ Ordered date operations evaluated against today to produce a relative comparison date, such as the start of the previous quarter. """ dynamicDate: [ReportHistoryDynamicDate!] """ Whether the dynamic date was built from custom operations rather than chosen from a predefined relative-date option. """ isDynamicDateCustom: Boolean! """ Special comparison value instead of a date: FirstValue compares against the first recorded value and PreviousValue against the preceding one. """ specialValue: ReportHistorySpecialValue } """ Special reference used instead of a date when comparing historical field values. """ enum ReportHistorySpecialValue { """Compares against the first recorded value of the field.""" FirstValue """Compares against the value the field had before its latest change.""" PreviousValue } """ Date operation, such as subtracting one month or moving to the start of the quarter, used to compute a relative comparison date. """ type ReportHistoryDynamicDate { """ Operation applied to the reference date: add or subtract an amount, set a specific value, or snap to the start or end of the unit. """ operation: ReportHistoryDynamicDateOperation! """ Amount the operation uses; required for Add, Subtract and Set, and omitted for StartOf and EndOf. """ value: Int """ Calendar unit the operation works on, such as Day, Week, Month, Quarter or Year. """ unit: ReportHistoryDynamicDateUnit! } """ Operation applied to a reference date to compute a dynamic date for historical report values. """ enum ReportHistoryDynamicDateOperation { """Adds value units to the date.""" Add """Subtracts value units from the date.""" Subtract """ Sets the unit part of the date to value, for example month 3 or week 10. """ Set """ Moves the date to the first day of its unit, such as the start of the week or month. """ StartOf """ Moves the date to the last day of its unit, such as the end of the week or month. """ EndOf } """Calendar unit a dynamic date operation works on.""" enum ReportHistoryDynamicDateUnit { """Days; with Set, the day of the month (1 to 31).""" Day """Weeks; with Set, the ISO week number (1 to 53).""" Week """Months; with Set, the month number (1 to 12).""" Month """Quarters; with Set, the quarter number (1 to 4).""" Quarter """Years; with Set, the year (1970 to 2070).""" Year } """ Value field of a report that shows a foreign currency field converted into the report currency. """ type ConvertedCurrencyField { """Unique identifier of this converted-currency value field.""" id: UUID! """ Identifier of the foreign-currency field whose value is converted into the report's currency. """ fieldId: UUID! } """ Value field of a report that aggregates values of related records, like a rollup field. """ type SummaryField implements ReportValueFieldInterface { """Unique identifier of this report value field.""" id: UUID! """Display name of the value field as shown in the report.""" name: String! """ Rollup definition that aggregates values from related records into this field, conforming to the RollupProperty type. """ rollup: RollupProperty! } """Value field computed for a report, identified by its id and name.""" interface ReportValueFieldInterface { """Unique identifier of this report value field.""" id: UUID! """Display name of the value field as shown in the report.""" name: String! } """ Definition of a rollup field: which related records it aggregates and with which function. """ type RollupProperty { """ Relation the rollup follows to reach the related records: the name of an entity relation, or the id of the lookup field on the source entity for a custom relation. """ entityRelationId: ID """Entity kind whose related records are aggregated by this rollup.""" targetEntity: EntityNameEnum! """ API name of the target custom entity, set when targetEntity is a custom entity. """ entityApiName: String """ How related values are combined — Count, Average, Sum, First, Last, Min or Max. """ aggregationFunction: RollupFieldAggregationFunctionEnum! """ Id of the field whose values are aggregated; null for Count, and for First and Last when the whole related record is returned. """ fieldId: ID """Field-condition filter selecting which related records are aggregated.""" filter: FieldFilter """ Id of the field the related records are sorted by to pick the First or Last one. """ sortFieldId: ID } """ How a rollup field combines the values of the related records it summarizes. """ enum RollupFieldAggregationFunctionEnum { """Number of related records.""" Count """Average of the related values.""" Average """Total of the related values.""" Sum """ The first related record when ordered by sortFieldId; the result links to that record. """ First """ The last related record when ordered by sortFieldId; the result links to that record. """ Last """Lowest related value.""" Min """Highest related value.""" Max } """Value field of a report whose value is calculated by a formula.""" type CalculatedField implements ReportValueFieldInterface { """Unique identifier of this report value field.""" id: UUID! """Display name of the value field as shown in the report.""" name: String! """ Formula definition that computes this field's value from other fields, conforming to the AdvancedFormulaProperty type. """ advancedFormula: AdvancedFormulaProperty! } """ Definition of an advanced formula field: the formula, the type of its result and how the result is displayed. """ type AdvancedFormulaProperty { """ Expression evaluated to produce the field value, referencing other fields by id. """ formula: String! """ Result type of the formula — integer, float, currency, string, date, datetime or bool. """ type: AdvancedFormulaTypeEnum! """ How a numeric result is formatted — Number, Percentage, Days, Months, Years or Custom (uses displayOptionCustomValue as a suffix). """ displayOption: AdvancedFormulaDisplayOptionEnum """Custom suffix appended to the result when displayOption is Custom.""" displayOptionCustomValue: String """Number of decimal places a numeric result is rounded to for display.""" decimalPlaces: Int } """Data type of the result of an advanced (calculated) formula.""" enum AdvancedFormulaTypeEnum { """Whole number.""" integer """Decimal number.""" float """Monetary amount.""" currency """Text.""" string """Calendar date.""" date """Date with time.""" datetime """True or false.""" bool } """How a numeric formula result is displayed.""" enum AdvancedFormulaDisplayOptionEnum { """Plain number.""" Number """Shown as a percentage.""" Percentage """Shown as a number of days.""" Days """Shown as a number of months.""" Months """Shown as a number of years.""" Years """Shown with the custom suffix given in displayOptionCustomValue.""" Custom } """ Filter conditions that select which custom entity records a saved profile or report includes, combining conditions on the record with conditions on related records. """ type CustomEntityFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Table report of emails: which emails it includes and the columns, sorting, grouping and totals it shows. """ type EmailTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & EmailProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: EmailFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: EmailRoleTab! } """ Saved view of emails: the filter and ownership scope that decide which emails it shows. """ interface EmailProfileInterface { """Filter conditions that determine which emails the profile shows.""" filter: EmailFilterTab! """ Ownership scope of the emails shown, such as own, shared or managing-unit items. """ role: EmailRoleTab! } """ Ownership scope of an email list or report: whether own, shared and managing-unit emails are included. """ type EmailRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, emails owned by other members of the current user managing unit are also included. """ showManagingUnitItems: Boolean! } """ Filter conditions an email must meet to appear in an email list or report. """ type EmailFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists timeframes: filter, quick filter and the table view. """ type TimeframeTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & TimeframeProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: TimeframeFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! } """ Settings shared by the saved profiles and reports on timeframes, consisting of the filter that selects the timeframes shown. """ interface TimeframeProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: TimeframeFilterTab! } """ Filter conditions that select which timeframes (periods a lead or opportunity spent in a pipeline step) a saved profile or report includes, combining conditions on the timeframe with conditions on related records. """ type TimeframeFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists quotes: filter, quote processes, ownership scope, quick filter and the table view. """ type QuoteTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & QuoteProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: QuoteFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Identifiers of the quote processes the profile is restricted to. Null includes all quote processes. """ quoteProcess: [UUID!] """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: QuoteRoleTab! } """ Settings shared by the saved profiles and reports on quotes: the filter and the quote processes the quotes belong to. """ interface QuoteProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: QuoteFilterTab! """ Identifiers of the quote processes the profile is restricted to. Null includes all quote processes. """ quoteProcess: [UUID!] } """ Ownership scope of quote reports and views: which quotes are included by their relation to the current user. """ type QuoteRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! } """ Filter conditions that select which quotes a saved profile or report includes, combining conditions on the quote with conditions on related records. """ type QuoteFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists projects: filter, ownership scope, quick filter and the table view. """ type ProjectTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ProjectProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ProjectFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: ProjectRoleTab! } """ Settings shared by the saved profiles and reports on projects: the filter and the ownership scope of the projects shown. """ interface ProjectProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: ProjectFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: ProjectRoleTab! } """ Ownership scope of project reports and views: which projects are included by their relation to the current user. """ type ProjectRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! } """ Filter conditions that select which projects a saved profile or report includes, combining conditions on the project with conditions on related records. """ type ProjectFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists products: filter, quick filter and the table view. """ type ProductTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & ProductProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ProductFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! } """ Settings shared by the saved profiles and reports on products, consisting of the filter that selects the products shown. """ interface ProductProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: ProductFilterTab! } """ Filter conditions that select which products a saved profile or report includes, combining conditions on the product with conditions on related records. """ type ProductFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists feed messages: filter, ownership scope, quick filter and the table view. """ type FeedTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & FeedReportProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: FeedFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: FeedRoleTab! } """ Settings shared by the reports on feed messages: the filter and the ownership scope of the messages shown. """ interface FeedReportProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: FeedFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: FeedRoleTab! } """ Ownership scope of feed reports and views: which feed items are included by their relation to the current user. """ type FeedRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, feed items shared with the current user are also included.""" showMySharedItems: Boolean! } """ Filter conditions that select which feed messages a report includes, combining conditions on the message with conditions on related records. """ type FeedFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists notes: filter, quick filter and the table view. """ type NoteTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & NoteProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: NoteFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! } """ Settings shared by the saved profiles and reports on notes, consisting of the filter that selects the notes shown. """ interface NoteProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: NoteFilterTab! } """ Filter conditions that select which notes a saved profile or report includes, combining conditions on the note with conditions on related records. """ type NoteFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists leads and opportunities: filter, sales pipelines, lead processes, ownership scope, target, quick filter and the table view. """ type LeadOpportunityTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & PipelineProfileInterface & RoleProfileInterface & TargetProfileInterface & LeadOpportunityReportProfileInterface & ReportTabInterface { """Filter tab restricting which leads and opportunities the report shows.""" filter: LeadOpportunityFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] """ Ownership scope of the records shown (own, shared, managing-unit, or unassigned items). """ role: LeadOpportunityRoleTab! """ Target tab defining the goal, measured period and comparison for the report. """ target: OpportunityReportTargetTab! """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] } """Saved profile restricted to selected sales pipelines.""" interface PipelineProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: ProfileFilterBaseInterface! """ Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] } """ Saved profile, report or dashboard that shows a target: a goal measured over a period. """ interface TargetProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: ProfileFilterBaseInterface! """ Target settings of the profile: the field whose values are summed and the period they are measured over. """ target: TargetTabInterface! } """ Target settings of a saved profile: the field summed toward the goal and the period it is measured over. """ interface TargetTabInterface { """ Identifier of the field whose values are summed and compared against the target goal. """ targetValueFieldId: ID! """Period the target is measured over.""" targetPeriodCurrent: PeriodOption! } """ Settings shared by the reports on leads and opportunities: the filter, sales pipelines, lead processes and the ownership scope of the records shown. """ interface LeadOpportunityReportProfileInterface { """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] """Filter tab restricting which leads and opportunities the report shows.""" filter: LeadOpportunityFilterTab! """ Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] """ Ownership scope of the records shown (own, shared, managing-unit, or unassigned items). """ role: LeadOpportunityRoleTab! } """ Target shown in lead and opportunity reports and dashboards: the goal, the field summed toward it, the period it is measured over and the period it is compared with. """ type OpportunityReportTargetTab implements TargetTabInterface { """ Identifier of the field whose values are summed and compared against the target goal. """ targetValueFieldId: ID! """Period the target is measured over.""" targetPeriodCurrent: PeriodOption! """ Whose records contribute to the target: My counts only the current user, All counts every matching record. """ targetSource: TargetSourceKind! """Numeric target value the accumulated field total is measured against.""" goal: Float! """Defines if target should be displayed in report""" isVisible: Boolean! """Reference period the current target period is compared against.""" targetPeriodCompare: PeriodCompareOption! """ When true, the target row is pinned above the data instead of below it. """ showTargetOnTop: Boolean } """Whose records count toward an opportunity board target.""" enum TargetSourceKind { """Only the current user's records.""" My """All matching records.""" All } """ Reference period another period is compared with: none, the previous period, the previous year or a custom date range. """ type PeriodCompareOption { """Set only if period set to Custom""" periodCustomFrom: Date """Set only if period set to Custom""" periodCustomTo: Date """ Reference period the current period is compared against: DoNotCompare, PreviousPeriod, PreviousYear, or Custom. When Custom, periodCustomFrom and periodCustomTo define the bounds. """ period: PeriodCompareKind! } """Period a KPI or chart value is compared against.""" enum PeriodCompareKind { """No comparison is made.""" DoNotCompare """ The period immediately before the current one, of the same kind (for example the previous month for MonthCurrent). """ PreviousPeriod """The same period one year earlier.""" PreviousYear """Explicit range given by periodCustomFrom and periodCustomTo.""" Custom } """ Ownership scope of lead and opportunity reports and views: which records are included by their relation to the current user. """ type LeadOpportunityRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! """When true, includes records that have no owner assigned.""" showUnassignedItems: Boolean! } """ Filter conditions that select which leads and opportunities a saved profile or report includes, combining conditions on the record with conditions on related records. """ type LeadOpportunityFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists activities: filter, ownership scope, quick filter and the table view. """ type ActivityTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ActivityProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ActivityFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared, managing-unit or unassigned items. """ role: ActivityRoleTab! } """ Settings shared by the saved profiles and reports on activities: the filter and the ownership scope of the activities shown. """ interface ActivityProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: ActivityFilterTab! """ Ownership scope of the records shown, such as own, shared, managing-unit or unassigned items. """ role: ActivityRoleTab! } """ Ownership scope of activity reports and views: which activities are included by their relation to the current user. """ type ActivityRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! """When true, includes records that have no owner assigned.""" showUnassignedItems: Boolean! } """ Filter conditions that select which activities (tasks and appointments) a saved profile or report includes, combining conditions on the activity with conditions on related records. """ type ActivityFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists contacts: filter, ownership scope, quick filter and the table view. """ type ContactTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ContactProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ContactFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: ContactRoleTab! } """ Settings shared by the saved profiles and reports on contacts: the filter and the ownership scope of the contacts shown. """ interface ContactProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: ContactFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: ContactRoleTab! } """ Ownership scope of contact reports and views: which contacts are included by their relation to the current user. """ type ContactRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! } """ Filter conditions that select which contacts a saved profile or report includes, combining conditions on the contact with conditions on related records. """ type ContactFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Settings of a report table that lists accounts: filter, ownership scope, quick filter and the table view. """ type AccountTableReportProfile implements TableReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & AccountProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: AccountFilterTab! """ View configuration of the table report, including its columns, sorting, grouping, totals and chart. """ view: ViewTableReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: AccountRoleTab! } """ Settings shared by the saved profiles and reports on accounts: the filter and the ownership scope of the accounts shown. """ interface AccountProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: AccountFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: AccountRoleTab! } """ Ownership scope of account reports and views: which accounts are included by their relation to the current user. """ type AccountRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! } """ Filter conditions that select which accounts a saved profile or report includes, combining conditions on the account with conditions on related records. """ type AccountFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Filter of a saved profile, report or dashboard; every variant can be switched on or off. """ interface ProfileFilterBaseInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! } """ Filter conditions that select which leads and opportunities the sales KPIs of a saved profile are calculated from. """ type OpportunityKPIFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Filter of the email feed: limits the emails shown by attachment, sender and period. """ type FeedEmailPreviewFilterTab implements ProfileFilterBaseInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """When true, only emails that have an attachment are shown.""" hasAttachment: Boolean! """If null or empty - filter is ignored.""" filterBySender: [FeedFilterSender!] """Time period the emails are restricted to.""" filterByPeriod: PeriodOption! } """ Sender whose messages a feed filter keeps: a user, a sales unit or an application. """ type FeedFilterSender { """ Type of the sender: Client (a user), SalesUnit or Application; senders of other types are ignored. """ entity: EntityNameEnum! """ Identifier of the sender record (of the type given by `entity`) whose feed items are kept by this filter. """ id: ID! } """ Filter of the Navigator screen that restricts the records shown to an owner and to sales units. """ type NavigatorProfileFilterTab implements ProfileFilterBaseInterface { """ Whether the owner and unit filters are applied. When false, the filter is ignored. """ isEnabled: Boolean! """Owner id, that should be filtered, if NULL filter is not applied.""" filterByOwnerId: ID """ List of unit ids to include. If NULL filter is not applied. On empty list, selects no record. """ filterByUnitIds: [ID!] } """ Filter of a record's feed that narrows the messages shown by attachment, favorite flag, sender and period. """ type FeedPreviewFilterTab implements ProfileFilterBaseInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """When true, only feed items that have an attachment are shown.""" hasAttachment: Boolean! """ When true, only feed items the current user has marked as favorite are shown. """ showOnlyFavorite: Boolean! """If null or empty - filter is ignored.""" filterBySender: [FeedFilterSender!] """Time period the feed items are restricted to.""" filterByPeriod: PeriodOption! } """ Dashboard-wide filter of a configurable dashboard that restricts every item to records of selected owners and sales units. """ type DashboardFilter implements ProfileFilterBaseInterface { """ Whether the dashboard-level filter is applied. When false, the owner and unit filters are ignored. """ isEnabled: Boolean! """ Identifiers of record owners the dashboard is restricted to. An empty list selects no records. """ ownerIds: [ID!]! """ Identifiers of units the dashboard is restricted to. An empty list selects no records. """ unitIds: [ID!]! } """ Filter conditions that select which opportunities a saved profile, forecast or dashboard item includes, combining conditions on the opportunity with conditions on related records. """ type OpportunityFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Filter conditions that select which leads a saved profile or dashboard includes, combining conditions on the lead with conditions on related records. """ type LeadFilterTab implements ProfileFilterBaseInterface & ProfileFilterBoxTabInterface & ProfileFilterTabCustomFilterInterface { """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. """ isCustom: Boolean! """ How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. """ operator: FilterGroupOperator! """ Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. """ formula: String } """ Box joined to a report table's main box that brings in or aggregates data from related records. """ interface SiblingBoxInterface { """Unique identifier of the box within the report structure.""" id: ID! """ Id of the opportunity value field the report uses for amount calculations, such as won amounts compared with targets; applied only when the box entity is Opportunity or LeadOppty. """ calculationFieldId: ID """ Entity type whose records this box reports on, such as Account, Lead or Opportunity. """ entityType: EntityNameEnum! """ API name of the entity for this box; set for custom entities to identify which one is used. """ entityApiName: String """ List of possible entity subtypes of entityType, if entity type is abstract you can supply with entityTypes of all children of abstract entity """ entitySubtypes: [EntitySubtypeItem!] """ Identifier of the lookup field that links this sibling box to its parent box; set when the relation is defined through a specific lookup field. """ lookupFieldId: UUID """ How records in this sibling box relate to the parent box, either an aggregation over related records or a predefined hardcoded relation. """ relation: SiblingBoxRelationType } """ How a sibling box relates to its parent box: an aggregation over the related records or a predefined relation. """ union SiblingBoxRelationType = AggregationRelation | HardcodedRelation """ Box of a report that refers to related records only for filtering, without showing columns. """ type FilterSiblingBox implements ReportBoxInterface & SiblingBoxInterface { """Unique identifier of the box within the report structure.""" id: ID! """ Id of the opportunity value field the report uses for amount calculations, such as won amounts compared with targets; applied only when the box entity is Opportunity or LeadOppty. """ calculationFieldId: ID """ Entity type whose records this box reports on, such as Account, Lead or Opportunity. """ entityType: EntityNameEnum! """ API name of the entity for this box; set for custom entities to identify which one is used. """ entityApiName: String """ List of possible entity subtypes of entityType, if entity type is abstract you can supply with entityTypes of all children of abstract entity """ entitySubtypes: [EntitySubtypeItem!] """ Identifier of the lookup field that links this sibling box to its parent box; set when the relation is defined through a specific lookup field. """ lookupFieldId: UUID """ How records in this sibling box relate to the parent box, either an aggregation over related records or a predefined hardcoded relation. """ relation: SiblingBoxRelationType } """ Box of a report: a set of records of one type, identified within the report structure. """ interface ReportBoxInterface { """Unique identifier of the box within the report structure.""" id: ID! """ Id of the opportunity value field the report uses for amount calculations, such as won amounts compared with targets; applied only when the box entity is Opportunity or LeadOppty. """ calculationFieldId: ID """ Entity type whose records this box reports on, such as Account, Lead or Opportunity. """ entityType: EntityNameEnum! """ API name of the entity for this box; set for custom entities to identify which one is used. """ entityApiName: String """ List of possible entity subtypes of entityType, if entity type is abstract you can supply with entityTypes of all children of abstract entity """ entitySubtypes: [EntitySubtypeItem!] } """ Predefined relation that selects the related record of a report sibling box, such as the next scheduled activity or the last note. """ type HardcodedRelation { """ Predefined relationship that selects which related record this sibling box pulls in, such as the next scheduled activity, the last won opportunity or the last note. """ relationType: SiblingRelationType! """ When true, the report keeps only main rows that have a matching related record for this relation; when false, rows without a match are still shown. """ onlyRowsWithRelatedRecords: Boolean """ How values from multiple related records are combined into a single value (Sum, Average or Max). """ aggregationType: HardcodedAggregationType } """ How values of several related records are combined into one value for a predefined relationship. """ enum HardcodedAggregationType { """Adds up the related values.""" Sum """Averages the related values.""" Average """Takes the highest related value.""" Max } """ Relation of a sibling box that aggregates the related records into one value per row, such as their count or sum. """ type AggregationRelation { """ Id of the field used to aggregate on each identified groups, set to NULL if aggregation operation is count """ aggregationFieldId: ID """ Id of the field used to define groups to aggregate, if whole set is used for aggregation """ operationFieldId: ID """Operation which defines function used at aggregation""" aggregationOperator: AggregationOperator! } """ Subtype of records a report box includes, such as tasks or appointments, optionally limited to specific types. """ type EntitySubtypeItem { """ Subtype of the box entity to include, such as Task, Appointment, Email, Lead, Opportunity or Quote. """ kind: EntitySubtypeKind! """ Identifiers of the activity or form templates that further restrict which records of this subtype are included. """ formId: [ID!] } """ Concrete subtype of a combined entity (for example Task or Appointment for activities, Memo or Email for messages, Lead or Opportunity for sales records) that a report, box or rollup is limited to. """ enum EntitySubtypeKind { """Tasks among activities.""" Task """Appointments among activities.""" Appointment """Memos (notes) among messages.""" Memo """Emails among messages.""" Email """Leads among sales records.""" Lead """Opportunities among sales records.""" Opportunity """Forecast timeframes.""" Timeframe """Quotes.""" Quote } """ Box of a report table that shows columns from records related to the main box. """ type ReportSiblingBox implements ReportBoxInterface & VisibleBoxInterface & SiblingBoxInterface { """Unique identifier of the box within the report structure.""" id: ID! """ Id of the opportunity value field the report uses for amount calculations, such as won amounts compared with targets; applied only when the box entity is Opportunity or LeadOppty. """ calculationFieldId: ID """ Entity type whose records this box reports on, such as Account, Lead or Opportunity. """ entityType: EntityNameEnum! """ API name of the entity for this box; set for custom entities to identify which one is used. """ entityApiName: String """ List of possible entity subtypes of entityType, if entity type is abstract you can supply with entityTypes of all children of abstract entity """ entitySubtypes: [EntitySubtypeItem!] """ Name of the box, shown as the heading above the box's columns in printed and exported reports. """ name: String! """ An ordered list of field ID to display with width and color information from box source """ displayFields: [DisplayFieldItem!]! """ Identifier of the lookup field that links this sibling box to its parent box; set when the relation is defined through a specific lookup field. """ lookupFieldId: UUID """ How records in this sibling box relate to the parent box, either an aggregation over related records or a predefined hardcoded relation. """ relation: SiblingBoxRelationType } """ Report box whose fields are shown as columns: its name and displayed fields. """ interface VisibleBoxInterface { """ Name of the box, shown as the heading above the box's columns in printed and exported reports. """ name: String! """ An ordered list of field ID to display with width and color information from box source """ displayFields: [DisplayFieldItem!]! } """ Column of a report box: the field shown and its display, width, color, alignment, conditional formatting and print options. """ type DisplayFieldItem { """ Id of the field shown in this column: a field of the box entity, or a value field defined in the report (reportValueFields). """ fieldId: ID! """ Form in which the column's values are shown, such as the readable name or the raw value of a related record; Natural when not set. """ displayOptions: DisplayOption """Size of the column width, if value is Null uses default""" columnWidth: Int """RGB color code converted to integer, if value is Null uses no color """ columnColor: Int """ Horizontal alignment of the values in the column: Left, Center or Right. """ columnAlignment: ColumnAlignment """ Conditional formatting applied to this column's cells based on their value. """ columnFormatting: ColumnFormatting """ How cell content that doesn't fit the column width is handled when the report is printed: Wrap keeps the full content on multiple lines, Clip prints it cut off to a single line. Affects printing only, not the report detail. """ columnPrintOverflow: ColumnPrintOverflow! } """ Form in which a field value is returned, for example as a readable name or as the raw stored value. """ enum DisplayOption { """ Readable display value; for references, the name of the related record. """ Natural """Raw stored value, such as the ID of a related record.""" AsIs """URL of the related record's picture.""" AsPicture """Numeric value suitable for calculations.""" AsNumeric """ Object containing the value in several display forms, keyed by display option. """ Mixed """Record type of the related record.""" AsEntityType """ A specific field of the related record, such as a currency code, instead of its default display value; chosen by the server. """ Custom """Text of the related record's compact view.""" CompactView """ Structured raw data of complex fields (for example pipeline, days in step or social profiles); same as Natural for other fields. """ RollupRawData } """Horizontal alignment of a report column or dashboard section header.""" enum ColumnAlignment { """Content is aligned to the left.""" Left """Content is centered.""" Center """Content is aligned to the right.""" Right } """ How a report column handles content too long for the column width when printed. """ enum ColumnPrintOverflow { """Content wraps onto more lines so all of it is printed.""" Wrap """Content is cut off at the column edge.""" Clip } """ Conditional formatting of a report column: rules that color cells by their value. """ type ColumnFormatting { """Whether conditional formatting is applied to this column.""" isEnabled: Boolean! """ Conditional-formatting rules that decide which cells are highlighted and with what color. """ filterFields: [ColumnFormattingFieldFilterRule!]! } """ Conditional formatting rule: a condition on a field value and the color applied to the matching cells. """ type ColumnFormattingFieldFilterRule implements ColumnFormattingFilterFieldRuleInterface { """Unique identifier of this conditional-formatting rule.""" id: UUID """Identifier of the field whose value the rule is evaluated against.""" field: String """ Comparison applied between the field value and the rule values, such as equals, contains or is between. """ operator: FieldOperator """ Values the field is compared against; grouped into lists so a single rule can match any of several values. """ values: [[String]] """ Color applied to matching cells, given as an RGB color code encoded as an integer. """ color: Int """Identifier of the report box that the compared field belongs to.""" boxId: ID } """ Condition of a conditional formatting rule, evaluated against a field value. """ interface ColumnFormattingFilterFieldRuleInterface { """ Identifier of this condition within the filter box. Used to reference the condition from the box formula. """ id: UUID """Identifier of the field whose value the rule is evaluated against.""" field: String """ Comparison applied between the field and the supplied values (for example Is, IsNot, Contains, Between, IsEmpty). """ operator: FieldOperator """ 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). """ values: [[String]] } """ Main box of a report table: the record type each row represents and its displayed columns. """ type ReportMainBox implements ReportBoxInterface & VisibleBoxInterface { """Unique identifier of the box within the report structure.""" id: ID! """ Id of the opportunity value field the report uses for amount calculations, such as won amounts compared with targets; applied only when the box entity is Opportunity or LeadOppty. """ calculationFieldId: ID """ Entity type whose records this box reports on, such as Account, Lead or Opportunity. """ entityType: EntityNameEnum! """ API name of the entity for this box; set for custom entities to identify which one is used. """ entityApiName: String """ List of possible entity subtypes of entityType, if entity type is abstract you can supply with entityTypes of all children of abstract entity """ entitySubtypes: [EntitySubtypeItem!] """ Name of the box, shown as the heading above the box's columns in printed and exported reports. """ name: String! """ An ordered list of field ID to display with width and color information from box source """ displayFields: [DisplayFieldItem!]! } """ Pivot table of a report: summarizes records of one type by row and column dimensions, with its filter and view settings. """ type PivotTable implements ReportStructureItem { """Unique identifier of this item within the report structure.""" id: ID! """ ID of a parent report structure, if ID is NULL this identifies root item, no more than one root item is allowed """ parentId: ID """Order of the item on the within same parent""" sortOrder: Int! """ Entity type whose records the pivot reports on, such as Account, Lead or Opportunity. """ entityType: EntityNameEnum! """ API name of the entity for this pivot; set for custom entities to identify which one is used. """ entityApiName: String """ List of possible entity subtypes of entityType, if entity type is abstract you can supply with entityTypes of all children of abstract entity """ entitySubtypes: [EntitySubtypeItem!] """ Id of the opportunity value field the pivot uses for amount calculations; applied only when the main box or pivot entity is Opportunity or LeadOppty. """ calculationFieldId: ID """Filter and view settings for the pivot report.""" tabs: PivotReportTabsInterface! } """ Filter and view settings of a pivot table; the variant depends on the record type the pivot summarizes. """ interface PivotReportTabsInterface { """ Filter conditions that determine which records the pivot report includes. """ filter: ProfileFilterBaseInterface! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! } """ Settings of a pivot table that summarizes custom entity records: filter, ownership scope, quick filter and the pivot view. """ type CustomEntityPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & CustomEntityProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: CustomEntityFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: CustomEntityRoleTab! } """ View settings of a pivot table: row and column dimensions, aggregation columns, totals, chart and drilldown. """ type ViewPivotReportTab implements ViewReportTab { """ Which leading rows and columns stay frozen while scrolling: none, the first row, the first column, or the first row and column. """ frozenPanes: FrozenPaneType! """Chart configuration for this report tab.""" chart: ReportChart! """ Additional value fields computed for the report, such as calculated formula fields, rollup summary fields and converted-currency fields. """ reportValueFields: [ReportValueField!]! """ History configuration when the report tracks field values over time, either as a comparison against specific dates or as a trend over a period. """ history: ReportHistory """ Identifier of the currency that monetary values in the report are displayed in. """ currencyId: UUID! """Configuration of the totals shown for the pivot table.""" total: PivotReportTotal! """ List of the field IDs that are reported as pivot rows, beware if depth is very big report generates an Out of size error report """ rowFields: [PivotField!]! """ Width of the leading row-number column; if Null the default width is used. """ rowNumberColumnWidth: Int """ Width of the row-label value columns; if Null the default width is used. """ rowValueColumnWidth: Int """ List of the field IDs that are reported as pivot columns, beware if depth is very big report generates an Out of size error report """ columnFields: [PivotField!]! """ Value columns aggregated for each cell of the pivot, each with its aggregation operator and optional comparison. """ aggregationFields: [AggregationField!]! """ Whether users can drill down from a pivot cell into the underlying records. """ isDrilldownEnabled: Boolean! """List of fields to display as drilldown table""" drilldownFields: [DisplayFieldItem!]! } """ Aggregation column of a pivot table: the field and the operation (such as count or sum) that produce each cell value. """ type AggregationField { """Unique identifier of this aggregation column in the pivot.""" id: UUID! """Display name of the aggregation column.""" name: String """ ID of field used for aggregation, leave empty if aggregation is set to Count """ fieldId: UUID """ Aggregation function that produces the column's values, such as Count, Sum or Average. """ operator: AggregationOperator! """ Comparison applied to this aggregation column, such as comparing against a row, column or grand total. """ comparison: AggregationComparison! """Width of the column; if Null the default width is used.""" columnWidth: Int """ Conditional formatting applied to this column's cells based on their value. """ columnFormatting: ColumnFormatting """RGB color code converted to integer, if value is Null uses no color """ columnColor: Int } """ Comparison of a pivot aggregation value with the row, column or grand total, or with another aggregation. """ type AggregationComparison { """ Whether the aggregation value is compared against another value in the pivot. """ isEnabled: Boolean! """ What the value is compared against: the row total, the column total, the grand total, or another field's aggregation. """ type: AggregationComparisonType! """ Identifier of the field whose aggregation is compared against; set when the comparison type is Field. """ fieldId: UUID """ How the comparison field's values are aggregated, such as Count, Sum, Average, Min or Max. """ operator: AggregationOperator! } """ Reference total that a pivot aggregation is expressed against as a percentage. """ enum AggregationComparisonType { """Each value as a percentage of its row total.""" RowTotal """Each value as a percentage of its column total.""" ColumnTotal """Each value as a percentage of the grand total of the report.""" GrandTotal """ Each value as a percentage of another aggregated field, identified by fieldId. """ Field } """ Row or column dimension of a pivot table: the field the values are grouped by and how the groups are sorted. """ type PivotField { """Identifier of the field used as a pivot row or column dimension.""" fieldId: ID! """ How the field's values are grouped, for example by month or by interval. """ groupOption: GroupOption """ Id of the value field whose totals this dimension's groups are sorted by, in sortOrder; when null, the groups are sorted by their own values. """ sortFieldId: ID """ Sort direction applied to this dimension's values, either ascending (Asc) or descending (Desc). """ sortOrder: SortOrder """ Custom numeric intervals used to group records when the group option is set to manual intervals. """ groupIntervals: [GroupInterval!] } """Totals of a pivot table: whether they are shown and where.""" type PivotReportTotal { """Whether totals are shown for the pivot table.""" isEnabled: Boolean! """ Whether the totals appear above the values they summarise (Top) or below them (Bottom). """ position: ReportTotalPosition! } """ Pivot report of emails: which emails it includes and how it groups and aggregates them in rows and columns. """ type EmailPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & EmailProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: EmailFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: EmailRoleTab! } """ Settings of a pivot table that summarizes timeframes: filter, quick filter and the pivot view. """ type TimeframePivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & TimeframeProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: TimeframeFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! } """ Settings of a pivot table that summarizes quotes: filter, quote processes, ownership scope, quick filter and the pivot view. """ type QuotePivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & QuoteReportProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: QuoteFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Identifiers of the quote processes the profile is restricted to. Null includes all quote processes. """ quoteProcess: [UUID!] """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: QuoteRoleTab! } """ Settings shared by the reports on quotes: the filter, the quote processes and the ownership scope of the quotes shown. """ interface QuoteReportProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: QuoteFilterTab! """ Identifiers of the quote processes the profile is restricted to. Null includes all quote processes. """ quoteProcess: [UUID!] """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: QuoteRoleTab! } """ Settings of a pivot table that summarizes projects: filter, ownership scope, quick filter and the pivot view. """ type ProjectPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ProjectProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ProjectFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: ProjectRoleTab! } """ Settings of a pivot table that summarizes products: filter, ownership scope, quick filter and the pivot view. """ type ProductPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & ProductProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ProductFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: OpportunityRoleTab! } """ Ownership scope of opportunity reports and views: which opportunities are included by their relation to the current user. """ type OpportunityRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! } """ Settings of a pivot table that summarizes feed messages: filter, ownership scope, quick filter and the pivot view. """ type FeedPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & FeedReportProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: FeedFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: FeedRoleTab! } """ Settings of a pivot table that summarizes notes: filter, quick filter and the pivot view. """ type NotePivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & NoteProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: NoteFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! } """ Settings of a pivot table that summarizes leads and opportunities: filter, sales pipelines, lead processes, ownership scope, target, quick filter and the pivot view. """ type LeadOpportunityPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & PipelineProfileInterface & RoleProfileInterface & TargetProfileInterface & LeadOpportunityReportProfileInterface & ReportTabInterface { """Filter tab restricting which leads and opportunities the report shows.""" filter: LeadOpportunityFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] """ Ownership scope of the records shown (own, shared, managing-unit, or unassigned items). """ role: LeadOpportunityRoleTab! """ Target tab defining the goal, measured period and comparison for the report. """ target: OpportunityReportTargetTab! """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] } """ Settings of a pivot table that summarizes activities: filter, ownership scope, quick filter and the pivot view. """ type ActivityPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ActivityProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ActivityFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared, managing-unit or unassigned items. """ role: ActivityRoleTab! } """ Settings of a pivot table that summarizes contacts: filter, ownership scope, quick filter and the pivot view. """ type ContactPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ContactProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: ContactFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: ContactRoleTab! } """ Settings of a pivot table that summarizes accounts: filter, ownership scope, quick filter and the pivot view. """ type AccountPivotReportProfile implements PivotReportTabsInterface & QuickFilterInterface & ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & AccountProfileInterface & ReportTabInterface { """Filter conditions that determine which records the report includes.""" filter: AccountFilterTab! """ View configuration of the pivot report, including its row and column dimensions, aggregation columns, totals and chart. """ view: ViewPivotReportTab! """ Ad-hoc filter applied on top of the saved filter, narrowing the visible records without changing the profile. """ quickFilter: QuickFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: AccountRoleTab! } """ Settings of a dashboard report: its tabs, each showing a saved dashboard for one record type. """ type DashboardSchema { """ Ordered list of dashboard tabs making up the layout, one per record type. """ structure: [DashboardTabItem!]! } """ Tab of a dashboard report; each implementation holds the saved dashboard of one record type (accounts, activities, contacts, leads or opportunities). """ interface DashboardTabItem { """Identifier of the dashboard tab.""" id: ID! } """ Activity tab of a dashboard report, holding the saved activity dashboard it shows. """ type ActivityDashboardProfileTab implements DashboardTabItem { """Identifier of the dashboard tab.""" id: ID! """ Saved dashboard profile (filter, role and view) shown on this activity dashboard tab. """ activityDashboardProfile: ActivityDashboardProfile } """ Saved activity dashboard: the filter and ownership scope of the activities it covers and the graphs it shows. """ type ActivityDashboardProfile implements ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ActivityProfileInterface { """Filter conditions that determine which records the dashboard includes.""" filter: ActivityFilterTab! """ Ownership scope of the records shown, such as own, shared, managing-unit or unassigned items. """ role: ActivityRoleTab! """View settings of the dashboard, including which graphs are shown.""" view: ActivityDashboardProfileView! } """ View settings of the activity dashboard: the graphs it shows and the fields listed when a graph value is drilled into. """ type ActivityDashboardProfileView implements DashboardViewInterface { """ Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. """ drilldownFields: [ID!]! """ Graphs shown on the activity dashboard, each identified by its graph type. """ graphs: [DashboardGraphActivityNameType]! } """ View settings shared by the record-type dashboards of a dashboard report, such as the fields listed when a graph value is drilled into. """ interface DashboardViewInterface { """ Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. """ drilldownFields: [ID!]! } """Predefined graph shown on the activity dashboard.""" enum DashboardGraphActivityNameType { """Pie chart of the number of activities per activity type.""" ComparisonActivityTypes """The five users with the most activities, split by activity type.""" TopOwnersByActivities """The five sales units with the most activities, split by activity type.""" TopUnitsByActivities """Pie chart of the number of tasks per status.""" ComparisonTaskStatus """ Pie chart of uncompleted tasks split into without due date, on time and overdue. """ ComparisonTaskDue } """ Opportunity tab of a dashboard report, holding the saved opportunity dashboard it shows. """ type OpportunityDashboardProfileTab implements DashboardTabItem { """Identifier of the dashboard tab.""" id: ID! """ Saved dashboard profile (filter, role and view) shown on this opportunity dashboard tab. """ opportunityDashboardProfile: OpportunityDashboardProfile } """ Saved opportunity dashboard: the filter, sales pipelines, lead processes and ownership scope of the records it covers, its target and the graphs it shows. """ type OpportunityDashboardProfile implements ProfileTabsInterface & ProfileFilterBoxTabsInterface & PipelineProfileInterface & RoleProfileInterface & TargetProfileInterface & LeadOpportunityProfileInterface & LeadOpptyPipelineProfileInterface { """ Filter tab restricting which leads and opportunities the profile shows. """ filter: LeadOpportunityFilterTab! """ Identifiers of the sales pipelines the dashboard is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] """ Ownership scope of the records shown (own, shared, or managing-unit items). """ role: OpportunityRoleTab! """ Target tab defining the goal, measured period and comparison for the dashboard. """ target: OpportunityReportTargetTab! """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] """View settings of the dashboard, including which graphs are shown.""" view: OpportunityDashboardProfileView! } """ Settings shared by the saved profiles that cover leads and opportunities: the filter, the sales pipelines and the ownership scope of the records shown. """ interface LeadOpportunityProfileInterface { """ Filter tab restricting which leads and opportunities the profile shows. """ filter: LeadOpportunityFilterTab! """ Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] """ Ownership scope of the records shown (own, shared, or managing-unit items). """ role: OpportunityRoleTab! } """ Saved profile restricted to selected sales pipelines and lead processes. """ interface LeadOpptyPipelineProfileInterface { """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] """Filter conditions that determine which records the profile includes.""" filter: ProfileFilterBaseInterface! """ Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] } """ View settings of the opportunity dashboard: the graphs it shows and the fields listed when a graph value is drilled into. """ type OpportunityDashboardProfileView implements DashboardViewInterface { """ Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. """ drilldownFields: [ID!]! """ Graphs shown on the opportunity dashboard, each identified by its graph type. """ graphs: [DashboardGraphOpportunityNameType]! } """Predefined graph shown on the opportunity dashboard.""" enum DashboardGraphOpportunityNameType { """Gauge of won opportunity value against the dashboard goal.""" WonVsGoal """ Gauge of ranked opportunity value (value weighted by ranking) against the goal. """ RankedVsGoal """ Gauge of weighted opportunity value (value weighted by step probability) against the goal. """ WeightedVsGoal """Gauge of full opportunity value against the goal.""" UnweightedVsGoal """ Gauge of balanced opportunity value (value weighted by both probability and ranking) against the goal. """ BalancedVsGoal """Pie chart of opportunity count and value by status (open, won, lost).""" ComparisonOpportunityStatus """ Pie chart of opportunity value by account class of the related accounts. """ ComparisonAccountClassTotalValue """ Columns of open opportunity value for the nearest upcoming closing dates. """ SumOfUpcomingClosingDates """ Stacked columns of non-lost opportunity value per pipeline step, split by account class. """ AccountClassOpportunitiesTotalValue """ Stacked columns of non-lost opportunity count per pipeline step, split by account class. """ AccountClassNumberOfOpportunities """ Stacked columns per pipeline step showing the share of non-lost opportunities in each ranking (1 to 5 stars). """ RatioOfRankedOpportunities """ Stacked columns per pipeline step showing the number of non-lost opportunities in each ranking. """ CountOfRankedOpportunities """ Stacked columns per pipeline step showing the value of non-lost opportunities in each ranking. """ TotalValueOfRankedOpportunities """The five won opportunities with the highest value.""" TopWonOpportunities """The five lost opportunities with the highest value.""" TopLostOpportunities """The five most recently closed won opportunities.""" LastWonOpportunities """The five most recently closed lost opportunities.""" LastLostOpportunities """The five accounts with the highest won opportunity value.""" TopAccountsByWonOpportunities """The five accounts with the highest lost opportunity value.""" TopAccountsByLostOpportunities """The five accounts with the highest open opportunity value.""" TopAccountsByOpenOpportunities """ The five most frequent reasons for losing opportunities, with their count and value. """ TopLostReasons """ Funnel of open and won opportunity count and value per pipeline step, with the lost value per step. """ PipelineOverview """ Average time opportunities spend in each pipeline step compared with the step's planned duration, and the average age of won opportunities. """ PipelineVelocity """ Open opportunities per pipeline step, split into overdue (closing date passed) and on time. """ CountOfOverdueOpportunities """ Per pipeline step, how many opportunities passed through the step and how many were won or lost from it. """ PipelineConversionAndDropOffRates """Win rate of closed opportunities grouped by opportunity value.""" WinRateByOpportunityValue """Number of opportunities by fitness level.""" CountOfOpenOpportunitiesByFitness } """ Lead tab of a dashboard report, holding the saved lead dashboard it shows. """ type LeadDashboardProfileTab implements DashboardTabItem { """Identifier of the dashboard tab.""" id: ID! """ Saved dashboard profile (filter, role and view) shown on this lead dashboard tab. """ leadDashboardProfile: LeadDashboardProfile } """ Saved lead dashboard: the filter, lead processes and ownership scope of the leads it covers and the graphs it shows. """ type LeadDashboardProfile implements ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & LeadProfileInterface { """Filter conditions that determine which records the dashboard includes.""" filter: LeadFilterTab! """ Ownership scope of the records shown, such as own, shared, managing-unit or unassigned items. """ role: LeadRoleTab! """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] """View settings of the dashboard, including which graphs are shown.""" view: LeadDashboardProfileView! } """ Settings shared by the saved lead profiles: the filter and the lead processes the leads belong to. """ interface LeadProfileInterface { """Filter conditions that determine which records the profile includes.""" filter: LeadFilterTab! """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] } """ View settings of the lead dashboard: the graphs it shows and the fields listed when a graph value is drilled into. """ type LeadDashboardProfileView implements DashboardViewInterface { """ Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. """ drilldownFields: [ID!]! """Graphs shown on the lead dashboard, each identified by its graph type.""" graphs: [DashboardGraphLeadNameType]! } """Predefined graph shown on the lead dashboard.""" enum DashboardGraphLeadNameType { """Number of leads per ranking (1 to 5 stars).""" CountOfLeadsByRanking """Number of leads per account class of their related accounts.""" CountOfLeadsByAccountClass """Number of leads per fitness level.""" CountOfOpenLeadsByFitness """Number of labeled leads per label.""" CountOfOpenLeadsByLabel """ Number of leads by time in queue: under 3 days, 3 to 7 days, 1 to 2 weeks, 2 to 4 weeks and over 4 weeks. """ LeadsDaysInQueue } """ Ownership scope of lead reports and views: which leads are included by their relation to the current user. """ type LeadRoleTab implements RoleTabInterface { """When true, includes records owned by the current user.""" showMyItems: Boolean! """When true, includes records shared with the current user.""" showMySharedItems: Boolean! """ When true, includes records owned by users in the sales units the current user manages. """ showManagingUnitItems: Boolean! """When true, includes records that have no owner assigned.""" showUnassignedItems: Boolean! } """ Contact tab of a dashboard report, holding the saved contact dashboard it shows. """ type ContactDashboardProfileTab implements DashboardTabItem { """Identifier of the dashboard tab.""" id: ID! """ Saved dashboard profile (filter, role and view) shown on this contact dashboard tab. """ contactDashboardProfile: ContactDashboardProfile } """ Saved contact dashboard: the filter and ownership scope of the contacts it covers and the graphs it shows. """ type ContactDashboardProfile implements ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & ContactProfileInterface { """Filter conditions that determine which records the dashboard includes.""" filter: ContactFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: ContactRoleTab! """View settings of the dashboard, including which graphs are shown.""" view: ContactDashboardProfileView! } """ View settings of the contact dashboard: the graphs it shows and the fields listed when a graph value is drilled into. """ type ContactDashboardProfileView implements DashboardViewInterface { """ Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. """ drilldownFields: [ID!]! """ Graphs shown on the contact dashboard, each identified by its graph type. """ graphs: [DashboardGraphContactNameType]! } """Predefined graph shown on the contact dashboard.""" enum DashboardGraphContactNameType { """The five users owning the most contacts.""" TopOwnersByContacts """Pie chart of the number of contacts per sales unit.""" CountOfContactsBySalesUnit """The five contacts with the highest won opportunity value.""" TopContactsByWonOpportunities """The five contacts with the highest lost opportunity value.""" TopContactsByLostOpportunities """The five contacts with the most activities, split by activity type.""" TopContactsByActivities } """ Account tab of a dashboard report, holding the saved account dashboard it shows. """ type AccountDashboardProfileTab implements DashboardTabItem { """Identifier of the dashboard tab.""" id: ID! """ Saved dashboard profile (filter, role and view) shown on this account dashboard tab. """ accountDashboardProfile: AccountDashboardProfile } """ Saved account dashboard: the filter and ownership scope of the accounts it covers and the graphs it shows. """ type AccountDashboardProfile implements ProfileTabsInterface & ProfileFilterBoxTabsInterface & RoleProfileInterface & AccountProfileInterface { """Filter conditions that determine which records the dashboard includes.""" filter: AccountFilterTab! """ Ownership scope of the records shown, such as own, shared or managing-unit items. """ role: AccountRoleTab! """View settings of the dashboard, including which graphs are shown.""" view: AccountDashboardProfileView! } """ View settings of the account dashboard: the graphs it shows and the fields listed when a graph value is drilled into. """ type AccountDashboardProfileView implements DashboardViewInterface { """ Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. """ drilldownFields: [ID!]! """ Graphs shown on the account dashboard, each identified by its graph type. """ graphs: [DashboardGraphAccountNameType]! } """Predefined graph shown on the account dashboard.""" enum DashboardGraphAccountNameType { """The five users owning the most accounts.""" TopOwnersByAccounts """Pie chart of the number of accounts per sales unit.""" CountOfAccountsBySalesUnit """Pie chart of the number of accounts per account class.""" CountOfAccountsByAccountClass """The five industries with the highest won opportunity value.""" TopAccountIndustriesByWonValue """The five industries with the most accounts.""" TopAccountIndustries """The five accounts with the highest won opportunity value.""" TopAccountsByWonOpportunities """The five accounts with the highest lost opportunity value.""" TopAccountsByLostOpportunities """The five accounts with the most related contacts.""" TopAccountsByNumberOfContacts """The five accounts with the most activities, split by activity type.""" TopAccountsByActivities } """ Settings of a configurable dashboard: items such as report charts, KPIs, tiles, targets and record grids laid out on a grid, with a filter and ownership scope applied to every item. """ type BetterDashboardSchema { """Ordered list of items (tiles) laid out on the dashboard.""" items: [DashboardItem!]! """Dashboard-wide owner and unit filter applied to every item.""" filter: DashboardFilter! """Dashboard-wide ownership visibility scope applied to every item.""" role: DashboardRole! } """ Dashboard-wide ownership scope of a configurable dashboard: whether own, shared and managing-unit records are included in its items. """ type DashboardRole implements RoleTabInterface { """When true, records owned by the viewer are included.""" showMyItems: Boolean! """When true, records shared with the viewer are included.""" showMySharedItems: Boolean! """ When true, records owned by users in the viewer's managed units are included. """ showManagingUnitItems: Boolean! """ Whether the role-based visibility scope is applied. When false, records are not restricted by ownership role. """ isEnabled: Boolean! } """ Item placed on a configurable dashboard: its position and size, title, colors and the widget it shows. """ type DashboardItem { """Identifier of the dashboard item (tile).""" id: ID! """Position and size of the item on the dashboard grid.""" position: Rectangle! """ Content rendered in the item, as one of the DashboardChart variants (KPI, grid, agenda, target, opportunities trend, report chart, and others). """ chart: DashboardChart! """Title shown on the item.""" name: String """ When true, the name is treated as a localization key and resolved to the viewer language instead of shown verbatim. """ nameUseLang: Boolean! """Optional subtitle or description shown on the item.""" description: String """ When true, the description is treated as a localization key and resolved to the viewer language instead of shown verbatim. """ descriptionUseLang: Boolean! """Background color of the item, as a packed RGB integer.""" color: Int """Header (title bar) color of the item, as a packed RGB integer.""" headerColor: Int } """ Content of a configurable dashboard item: one of the supported widgets, such as a report chart, KPI, tile, target, record grid, agenda or quick links. """ union DashboardChart = DashboardReportChart | DashboardPipelineConversionsChart | ReportSchema | ForecastSchema | DashboardQuickLinks | DashboardAgenda | DashboardSection | DashboardTile | DashboardInsights | DashboardTargetTab | DashboardTarget | DashboardOpportunitiesTrend | DashboardGrid | DashboardKpi | DashboardKpiList """Dashboard item that shows several KPIs as a list.""" type DashboardKpiList { """Ordered list of KPIs displayed in this KPI list item.""" kpiList: [DashboardKpiListItem!]! } """Named entry of a KPI list dashboard item, holding one KPI definition.""" type DashboardKpiListItem { """Identifier of the KPI list entry.""" id: UUID! """Label shown for this KPI in the list.""" name: String! """Accent color of the KPI entry, as a packed RGB integer.""" color: Int """KPI definition rendered by this list entry.""" kpi: DashboardKpi! } """ Dashboard KPI item: a predefined or custom metric over a period, measured against a goal and optionally compared with an earlier period. """ type DashboardKpi { """Identifier of the KPI.""" kpiId: UUID! """Goal definition the KPI value is measured against.""" kpiTarget: DashboardTargetTab! """Filter conditions limiting which records contribute to the KPI value.""" kpiFilter: FieldFilter! """ Predefined metric the KPI tracks (e.g. OpportunityWon, LeadCreated, ActivityCompleted); use Custom to define the metric via kpiCustomIndicator. """ kpiIndicator: DashboardKpiIndicatorEnum! """Custom metric definition applied when kpiIndicator is Custom.""" kpiCustomIndicator: DashboardKpiCustomDefinition! """When true, the goal is drawn as a target line on the KPI chart.""" kpiShowTargetLine: Boolean! """Time range the KPI value is calculated over.""" kpiPeriodCurrent: PeriodOption! """ Optional earlier period the current value is compared against to show a trend. """ kpiPeriodCompare: PeriodCompareOption } """ Predefined metric a dashboard KPI tracks over the selected period; Custom defines the metric via kpiCustomIndicator. """ enum DashboardKpiIndicatorEnum { """ Metric defined by kpiCustomIndicator (source record type, aggregation function and field). """ Custom """Number of leads created.""" LeadCreated """Number of leads qualified into opportunities.""" LeadQualified """Number of leads lost.""" LeadLost """ Average number of days from creating a lead to qualifying or losing it. """ LeadAverageVelocity """Number of opportunities created directly, not qualified from a lead.""" OpportunityCreated """Number of opportunities won, by closing date.""" OpportunityWon """Number of opportunities lost, by closing date.""" OpportunityLost """Total value of opportunities won, in the user's currency.""" OpportunityWonAmount """Total value of opportunities lost, in the user's currency.""" OpportunityLostAmount """Percentage of closed opportunities that were won.""" OpportunityWinRate """ Average number of days from creating or qualifying an opportunity to winning or losing it. """ OpportunityAverageVelocity """ Number of closed opportunities multiplied by win rate and average won value, divided by the average days to close. """ OpportunitySalesVelocity """Average value of won opportunities.""" OpportunityAverageSize """Number of activities created.""" ActivityCreated """Number of activities completed.""" ActivityCompleted """Number of emails sent.""" ActivityEmailsSent } """ Custom metric of a dashboard KPI: the record type, field and aggregation that produce its value. """ type DashboardKpiCustomDefinition { """ Record type the custom KPI aggregates over (e.g. Opportunity, Lead, Activity). """ sourceEntity: EntityNameEnum! """ API name of the source record type when it is a custom entity; null for built-in entities. """ sourceEntityApiName: String """ Identifier of the field aggregated by the KPI; null when the aggregation function is a record count. """ aggregationField: UUID """ Identifier of the lookup relation field to traverse before aggregating, when aggregating a field on a related record. """ aggregationLookupFieldId: UUID """ Aggregation applied to the source records: Count, Sum, Average, Min, or Max. """ aggregationFunction: AggregationOperator! } """ Goal a dashboard item is measured against: a saved target or forecast, or a goal value entered on the item. """ type DashboardTargetTab { """ Identifier of a saved Target or Forecast supplying the goal; when null, the inline goal value is used instead. """ targetDefinition: UUID """ Goal value the item measures progress against when no targetDefinition is referenced; may be null when targetDefinition supplies the goal. """ goal: Float } """ Dashboard item that lists records of a chosen type in a grid with configurable columns, sorting and totals. """ type DashboardGrid { """Filter conditions limiting which records are listed in the grid.""" gridFilter: FieldFilter! """Record type listed in the grid (e.g. Opportunity, Lead, Account).""" gridSourceEntity: EntityNameEnum! """ API name of the source record type when it is a custom entity; null for built-in entities. """ gridSourceEntityApiName: String """ Ordered columns shown in the grid, each identifying a field and its display options. """ gridColumns: [GridColumnsOutput!]! """Identifier of the field the grid rows are sorted by.""" gridSortBy: ID! """Sort direction applied to gridSortBy: Asc or Desc.""" gridSortOrder: SortOrder! """When true, a totals row is shown summarizing the grid columns.""" gridShowTotal: Boolean! """When true, the grid is limited to the first gridTopRecords rows.""" gridShowTopRecordsOnly: Boolean! """Maximum number of rows shown when gridShowTopRecordsOnly is true.""" gridTopRecords: Int } """ Column of a grid: the field shown, its width (relative or in pixels) and whether it is frozen. """ type GridColumnsOutput { """Identifier of the field shown in this grid column.""" fieldId: String! """ Column width. Interpreted as an exact pixel count when pixels is true, otherwise as a relative weight. """ width: Float! """ True when the column is pinned to the left edge so it stays visible while the grid scrolls horizontally. """ frozen: Boolean! """ True when width is given in absolute pixels; false when it is a relative weight. """ pixels: Boolean! } """ Dashboard item that charts the trend of opportunity values (weighted, unweighted, balanced, won and ranked) over a period against a goal. """ type DashboardOpportunitiesTrend { """ Display settings controlling which value series, period, and granularity the trend chart shows. """ opportunitiesTrendView: DashboardOpportunitiesTrendView! """Goal definition drawn as the target line on the trend chart.""" opportunitiesTrendTarget: DashboardTargetTab! """ Filter conditions limiting which opportunities contribute to the trend. """ opportunitiesTrendFilter: FieldFilter! } """ Display settings of an opportunities trend dashboard item: the value series plotted, the period and its granularity. """ type DashboardOpportunitiesTrendView { """ When true, the chart plots the probability-weighted opportunity value series. """ showWeightedValue: Boolean! """ When true, the chart plots the raw (unweighted) opportunity value series. """ showUnweightedValue: Boolean! """When true, the chart plots the balanced opportunity value series.""" showBalancedValue: Boolean! """When true, the chart plots the won opportunity value series.""" showWonValue: Boolean! """When true, the chart plots the ranked opportunity value series.""" showRankedValue: Boolean! """When true, the goal is drawn as a target line over the value series.""" showTargetLine: Boolean! """Time range covered by the trend chart.""" period: PeriodOption! """ Time bucket each data point represents: Day, Week, Month, Quarter, or Year. """ periodGranularity: PeriodGranularity! } """ Dashboard item that shows the progress of an aggregated value toward a goal, drawn as a radial, gauge, target or progress bar. """ type DashboardTarget { """ Visual style used to render progress toward the goal: Radial, Gauge, Target, or ProgressBar. """ targetType: DashboardTargetTypeEnum! """Goal definition the actual value is compared against.""" target: DashboardTargetTab """ Record type whose records are aggregated to produce the actual value (e.g. Opportunity, Lead, Activity). """ targetSourceEntity: EntityNameEnum! """ API name of the source record type when it is a custom entity; null for built-in entities. """ targetSourceEntityApiName: String """ Identifier of the field aggregated to produce the actual value; null when the aggregation function is a record count. """ targetAggregationField: UUID """ Aggregation applied to the source records: Count, Sum, Average, Min, or Max. """ targetAggregationFunction: AggregationOperator! """ Filter conditions limiting which source records contribute to the actual value. """ targetFilter: FieldFilter! """ Identifier of the lookup relation field to traverse before aggregating, when aggregating a field on a related record. """ targetAggregationLookupFieldId: UUID """Color of the progress indicator, as a packed RGB integer.""" targetColor: Int } """ Visual style of a dashboard target widget showing progress toward a goal. """ enum DashboardTargetTypeEnum { """Circular progress ring.""" Radial """Semicircular gauge with a needle.""" Gauge """Concentric target (bullseye) visual.""" Target """Horizontal progress bar.""" ProgressBar } """ Dashboard item that shows a group of insight tiles, each with one aggregated value. """ type DashboardInsights { """Ordered list of insight tiles displayed in this insights item.""" insightTiles: [DashboardInsightTile!]! } """ Named tile of an insights dashboard item, showing one aggregated value. """ type DashboardInsightTile { """Identifier of the insight tile.""" id: UUID! """Label shown above the insight tile.""" name: String! """ When true, the name is treated as a localization key and resolved to the viewer language instead of shown verbatim. """ useLang: Boolean! """Accent color of the tile, as a packed RGB integer.""" color: Int """ Aggregation definition that produces the value shown on this insight tile. """ tile: DashboardTile! } """ Dashboard tile that shows one aggregated value (count, sum, average, minimum or maximum) of the records of a chosen type. """ type DashboardTile { """Identifier of the tile.""" tileId: UUID! """ Record type the tile aggregates over (e.g. Opportunity, Lead, Activity). """ tileSourceEntity: EntityNameEnum! """ API name of the source record type when it is a custom entity; null for built-in entities. """ tileSourceEntityApiName: String """ Identifier of the field aggregated by the tile; null when the aggregation function is a record count. """ tileAggregationField: UUID """ Aggregation applied to the source records: Count, Sum, Average, Min, or Max. """ tileAggregationFunction: AggregationOperator! """ Identifier of the lookup relation field to traverse before aggregating, when aggregating a field on a related record. """ tileAggregationLookupFieldId: UUID """Configuration for highlighting records changed within a recent period.""" tileChangedRecords: DashboardTileChangedRecords! """ Ordered color rules applied to the tile value; the first matching rule sets the tile color. """ tileConditionalFormatting: [DashboardTileConditionalFormatting!] """ Filter conditions limiting which source records are aggregated by the tile. """ tileFilter: FieldFilter! } """Rule that colors a dashboard tile when its value meets a condition.""" type DashboardTileConditionalFormatting { """ Comparison applied between the tile value and firstValue (and secondValue for range operators such as Between) to decide whether this color applies. """ operator: FieldOperator! """Threshold compared against the tile value using the operator.""" firstValue: Float """ Upper bound used together with firstValue for range operators such as Between. """ secondValue: Float """ Color applied to the tile when the condition matches, as a packed RGB integer. """ color: Int! } """ Settings of a dashboard tile for highlighting records that changed within a recent period. """ type DashboardTileChangedRecords { """ Identifiers of the fields whose changes are tracked; a record counts as changed when any of these fields changed within the period. """ fieldIds: [UUID!] """Number of days in the look-back window when period is Custom.""" customPeriodValue: Float """When true, the tile highlights records changed within the period.""" isEnabled: Boolean """ Look-back window for detecting changed records (last 7/14/30 days, last 3/6 months, last year, or Custom days set by customPeriodValue). """ period: HighlightPeriodEnum } """ Look-back window used to highlight records or values that changed recently. """ enum HighlightPeriodEnum { """Changes in the last 7 days.""" Last7Days """Changes in the last 14 days.""" Last14Days """Changes in the last 30 days.""" Last30Days """Changes in the last 3 months.""" Last3Months """Changes in the last 6 months.""" Last6Months """Changes in the last 12 months.""" LastYear """Changes in the last number of days set by customPeriodValue.""" Custom } """ Dashboard item used as a section header that separates groups of other items. """ type DashboardSection { """ Horizontal alignment of the section header text: Left, Center, or Right. """ sectionAlignment: ColumnAlignment! } """ Dashboard item that lists the upcoming tasks, appointments and opportunities of a chosen period. """ type DashboardAgenda { """ Time window the agenda covers: the next 7 days, the next 30 days, or a custom number of days set by agendaPeriodCustomDays. """ agendaPeriod: DashboardAgendaPeriodEnum """Number of upcoming days the agenda covers when agendaPeriod is Custom.""" agendaPeriodCustomDays: Int! """ Filter conditions limiting which tasks and appointments appear in the agenda. """ agendaFilterActivity: FieldFilter """Filter conditions limiting which opportunities appear in the agenda.""" agendaFilterOpportunity: FieldFilter """When true, tasks are listed in the agenda.""" agendaShowTasks: Boolean """When true, appointments are listed in the agenda.""" agendaShowAppointments: Boolean """ When true, opportunities with activity in the period are listed in the agenda. """ agendaShowOpportunities: Boolean """ When true, the opportunity fitness indicator is shown for listed opportunities. """ agendaShowOpportunityFitness: Boolean """When true, tasks past their due date are also included in the agenda.""" agendaShowOverdueTasks: Boolean } """Time window covered by a dashboard agenda widget.""" enum DashboardAgendaPeriodEnum { """Today and the next 6 days.""" Upcoming7Days """Today and the next 29 days.""" Upcoming30Days """ Today and the following days, for the number of days set by agendaPeriodCustomDays. """ Custom } """Dashboard item that shows a list of links to web pages.""" type DashboardQuickLinks { """Ordered list of quick links displayed in this dashboard tile.""" quickLinks: [DashboardQuickLink!]! } """Link shown in a quick links dashboard item.""" type DashboardQuickLink { """ Identifier of the quick link. Optional on create; assigned by the server when omitted. """ id: UUID """Target URL opened when the quick link is clicked.""" url: String! """Label shown for the quick link.""" name: String! """ When true, the name is treated as a localization key and resolved to the viewer language instead of shown verbatim. """ useLang: Boolean! } """Settings of a forecast report: the forecast tabs it is made of.""" type ForecastSchema { """Ordered list of forecast items that make up the forecast report tab.""" structure: [ForecastTabItem!]! } """Tab of a forecast report; implemented by the opportunity forecast tab.""" interface ForecastTabItem { """Id of the forecast item within the report tab.""" id: ID! } """ Opportunity forecast tab of a forecast report, holding the saved forecast it shows. """ type OpportunityForecastProfileTab implements ForecastTabItem { """Id of the forecast item within the report tab.""" id: ID! """ Saved opportunity forecast view (filter, sales pipeline, grouping, columns and quota) backing this forecast tab. """ opportunityForecastProfile: OpportunityForecastProfile } """ Saved opportunity forecast of a forecast report: the filter, sales pipelines, lead processes, the dimension it is broken down by and the forecast view. """ type OpportunityForecastProfile implements ProfileTabsInterface & ProfileFilterBoxTabsInterface & PipelineProfileInterface & OpportunityProfileInterface & LeadOpptyPipelineProfileInterface { """Filter tab restricting which opportunities the profile shows.""" filter: OpportunityFilterTab! """ Identifiers of the sales pipelines the forecast is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] """ Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. """ leadProcess: [UUID!] """ View settings of the forecast: value field, period, owners, columns, grouping and quota. """ view: OpportunityForecastView! """Forecast properties, including the dimension the forecast is built on.""" properties: OpportunityForecastProperties! } """ Settings shared by the saved opportunity profiles and forecasts: the filter and the sales pipelines the opportunities belong to. """ interface OpportunityProfileInterface { """Filter tab restricting which opportunities the profile shows.""" filter: OpportunityFilterTab! """ Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. """ salesPipeline: [ID!] } """ General properties of an opportunity forecast, such as the dimension it is broken down by (users, sales units, products, product categories or accounts). """ type OpportunityForecastProperties { """ Dimension the forecast is built on: Users, SalesUnits, Products, ProductCategories, or Accounts. """ type: ForecastType! } """Dimension a forecast is broken down by.""" enum ForecastType { """One row per opportunity owner.""" Users """One row per sales unit.""" SalesUnits """One row per product on the opportunities.""" Products """One row per product category.""" ProductCategories """One row per account.""" Accounts } """ View settings of an opportunity forecast: the value field, period, owners, columns, grouping, drilldown and quota. """ type OpportunityForecastView { """ Identifier of the value field the forecast amounts are calculated from. """ field: ID! """Period range and granularity the forecast is calculated over.""" period: ForecastPeriodOption! """ Owners (users) included in the forecast, with their performance series. """ owner: [ForecastOwner]! """ Value columns shown in the forecast table (for example WonValueCurrentPeriod, OpenValueWeighted, WonVsForecast). """ column: [ForecastColumnsType!]! """Identifier of the field rows are grouped by. Null applies no grouping.""" groupBy: ID """ When true, rows can be expanded into a drilldown table of contributing records. """ isDrilldownEnabled: Boolean! """List of fields id to display as drilldown table""" drilldownFields: [ID!]! """Quota configuration the forecast values are measured against.""" quota: OpportunityForecastQuota! """When true, displays the forecast graph above the table.""" showGraph: Boolean! """ Coarser period the forecast rows are rolled up into (Monthly, Quarterly, or Yearly). Null keeps the base period granularity. """ rollUpPeriod: ForecastPeriodKind """When true, rows with no forecast values are hidden.""" hideEmptyRows: Boolean! """Height of the forecast graph, in pixels.""" graphHeight: Int } """Value shown in a column of the opportunity forecast table.""" enum ForecastColumnsType { """Value of opportunities won in the period.""" WonValueCurrentPeriod """Value of opportunities won in the same period one year earlier.""" WonValueSamePeriodInPreviousYear """ Difference between the current won value and the previous-year won value, as a percentage. """ WonValueSamePeriodInPreviousYearPercentage """Full value of won and open opportunities.""" WonOpenValueUnweighted """Full value of open opportunities.""" OpenValueUnweighted """Value of open opportunities multiplied by step probability.""" OpenValueWeighted """Value of open opportunities multiplied by ranking.""" OpenValueRanked """ Value of open opportunities multiplied by both step probability and ranking. """ OpenValueBalanced """Full value of lost opportunities.""" LostValueUnweighted """Won value as a percentage of the forecast.""" WonVsForecast """Won and open value as a percentage of the forecast.""" WonOpenVsForecast """Won value as a percentage of the quota.""" WonValueVsQuota """Full won and open value as a percentage of the quota.""" WonOpenValueVsQuotaUnweighted } """Length of each period in a forecast.""" enum ForecastPeriodKind { """Each period is one month.""" Monthly """Each period is one quarter.""" Quarterly """Each period is one year.""" Yearly } """ Quota of an opportunity forecast: the total amount, the baseline performance is compared with and its allocation to the owners. """ type OpportunityForecastQuota { """Whether a quota is set for the forecast.""" isEnabled: Boolean! """Total quota amount for the forecast.""" value: Float! """ Baseline the forecast is compared against: PreviousPeriod, AveragePerformance, or WeightedAveragePerformance. """ comparisonType: ForecastPerformanceComparisonType! """Per-owner quota allocations making up the total quota.""" items: [OpportunityForecastQuotaItem!]! } """ Historical baseline used to judge forecast performance or to split quota by historical performance. """ enum ForecastPerformanceComparisonType { """Performance in the same period of the previous year.""" PreviousPeriod """Average of past performance across all earlier periods.""" AveragePerformance """ Average of past performance with more recent periods weighted more heavily. """ WeightedAveragePerformance } """ Quota allocated to one owner of an opportunity forecast, split across the forecast periods. """ type OpportunityForecastQuotaItem { """Identifier of the owner the quota is allocated to.""" id: ID! """Quota amounts split across the forecast periods.""" values: [OpportunityForecastQuotaItemValue!]! """ How the total quota is distributed across periods: Evenly, HistoricalPerformance, or Custom. """ splitType: OpportunityForecastQuotaSplitType! } """How a forecast quota is distributed across its periods.""" enum OpportunityForecastQuotaSplitType { """The quota is split equally across all periods.""" Evenly """ The quota is split in proportion to historical performance in each period. """ HistoricalPerformance """The quota for each period is entered manually.""" Custom } """Quota amount of one owner for a single forecast period.""" type OpportunityForecastQuotaItemValue { """Period this quota value applies to.""" date: Date! """Quota amount allocated to the period.""" value: Float! } """ User included in an opportunity forecast, with their performance over the forecast periods. """ type ForecastOwner { """Identifier of the user this forecast row belongs to.""" id: ID! """False when the user is deactivated but still shown for history.""" isActive: Boolean! """ Time series of the owner's forecast performance across the forecast periods. """ forecastPerformance: [ForecastPerformanceItem]! } """Performance value of a forecast owner for one forecast period.""" type ForecastPerformanceItem { """Timestamp the performance value was recorded at.""" dateTime: DateTime! """Forecast performance value for the period.""" value: Float! """Period the performance value applies to.""" period: Date! } """ Date range of an opportunity forecast and the granularity (monthly, quarterly or yearly) it is broken down by. """ type ForecastPeriodOption { """ Granularity the forecast is broken down by: Monthly, Quarterly, or Yearly. """ period: ForecastPeriodKind! """First day of the forecast range (inclusive).""" periodFrom: Date! """Last day of the forecast range (inclusive).""" periodTo: Date! """Set only if period set to Quarterly or Yearly.""" financialYear: Boolean } """ Dashboard item that charts how opportunities convert from step to step of a sales pipeline. """ type DashboardPipelineConversionsChart { """Display name of the pipeline conversions chart.""" name: String! """Optional free-text description shown alongside the chart.""" description: String """ Aggregation applied to the opportunities counted in each pipeline step (Count, Sum, Average, Min, Max). """ operator: AggregationOperator! """ Identifier of the sales pipeline whose step-to-step conversion rates are charted. """ salesPipeline: UUID! """ Opportunity filter conditions limiting which opportunities are included in the conversion calculation. """ filter: OpportunityFilterTab } """Dashboard item that shows the chart of an existing report.""" type DashboardReportChart { """ Identifier of the report whose chart is rendered in this dashboard item. """ reportId: UUID! } """ A rectangular area on a canvas/grid: origin (x, y) plus size, in integer grid units. """ type Rectangle { """ Horizontal position of the top-left corner from the left edge, in grid columns. """ x: Int! """ Vertical position of the top-left corner from the top edge, in grid rows. """ y: Int! """Width, in grid columns.""" width: Int! """Height, in grid rows.""" height: Int! } """Section that groups the product lines of an opportunity or quote.""" type ProductSection { """Unique id of the product section.""" id: ID! """Display name of the product section.""" name: String! } """ Approvers of an approval process and how the approval is decided, delegated and expired. """ type ApprovalProcessSettings { """Ordered list of approvers who must act on the approval.""" approvers: [ApprovalProcessApprover!]! """ When true, every approver must approve; when false, a single approval suffices. """ allApprove: Boolean! """When true, an approver may delegate their decision to another user.""" canDelegate: Boolean! """ Who may still edit the record while approval is pending — managers, or managers and approvers. """ recordLock: ApprovalProcessRecordLock! """ When true, the approval auto-resolves after expirationDays without a decision. """ expiration: Boolean! """ Days before an unanswered approval expires; at least 1 when expiration is true. """ expirationDays: Int! """Outcome applied when the approval expires — Approve or Reject.""" expirationResult: ApprovalProcessExpirationResult! """ When true, the approval is tied to the sales step of the record being approved. """ salesProcessDependency: Boolean! } """Who can still edit a record while its approval is pending or approved.""" enum ApprovalProcessRecordLock { """Only approval process managers can edit the record.""" ManagersCanEdit """ Approval process managers and the record's approvers can edit the record. """ ManagersAndApproversCanEdit } """ Decision applied automatically when an approval request expires without a response. """ enum ApprovalProcessExpirationResult { """The record is approved.""" Approve """The record is rejected.""" Reject } """ Approver of an approval process: a specific user, or a role resolved from the record, such as the managers of its sales unit. """ type ApprovalProcessApprover { """ Kind of approver: a specific user (User), the managers of the record's sales unit (SalesUnitManager) or the record owner (Owner). """ type: ApprovalProcessApproverType! """ Id of the approving user when type is User; empty for the other approver types. """ id: UUID } """Who is asked to approve a record in an approval process.""" enum ApprovalProcessApproverType { """A specific user, given by id.""" User """The managers of the record's sales unit.""" SalesUnitManager """The owner of the record.""" Owner } """ Definition of an approval process: what starts it, which records it applies to, who approves and what happens on approval or rejection. """ type ApprovalProcessSchema { """What starts the approval — a record event or a manual launch.""" trigger: ApprovalProcessTrigger! """Condition deciding which records the approval applies to.""" filter: ProcessFilterNode! """Approver list and approval behaviour.""" settings: ApprovalProcessSettings! """Actions run when the approval is approved.""" approveNodes: [ProcessNodeInterface!]! """Actions run when the approval is rejected.""" rejectNodes: [ProcessNodeInterface!]! } """ What starts an approval process: a change of a record or a manual start. """ union ApprovalProcessTrigger = ApprovalProcessManualTrigger | ApprovalProcessRecordTrigger """Node of a process: a condition or an action in the process tree.""" interface ProcessNodeInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! } """Automatizer action node that triggers AI Smart Field value updates.""" type ProcessUpdateAiFieldsNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ When true, the records affected by this node also start another process. """ triggerProcess: Boolean! """ Process that the affected records start when triggering another process is enabled. """ triggerProcessId: UUID """AI smart fields whose values are recalculated when this node runs.""" smartAiFieldIds: [UUID!]! """ Relationship from the triggered record to the records whose AI fields are updated. When null, the triggered record itself is updated. """ relation: ProcessRecordNodeRelationEnum """ Lookup field that defines the relation. Required when the relation is a lookup, and must be empty otherwise. """ relationLookupFieldId: String """ API name of the related custom entity whose AI fields are updated. Set only when the related record type is a custom entity. """ entityApiName: String } """Process action whose run can be delayed by a schedule.""" interface ProcessScheduleInterface { """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule } """ Which record a process action or trigger works with: a record of an entity, or records reached from the triggered record through a relation, primary link, parent account or lookup field. """ enum ProcessRecordNodeRelationEnum { """ A task: a new task, the triggered task, or the tasks related to the triggered record, depending on the action. """ Task """ An appointment: a new appointment, the triggered appointment, or the appointments related to the triggered record, depending on the action. """ Appointment """ An account: a new account, the triggered account, or the accounts related to the triggered record (child accounts for an account), depending on the action. """ Account """ A contact: a new contact, the triggered contact, or the contacts related to the triggered record, depending on the action. """ Contact """ A lead: a new lead, the triggered lead, or the leads related to the triggered record, depending on the action. """ Lead """ An opportunity: a new opportunity, the triggered opportunity, or the opportunities related to the triggered record, depending on the action. """ Opportunity """ A product line item of an opportunity: a new one, the triggered one, or the line items of the triggered record, depending on the action. """ OpptyProductRelation """ A project: a new project, the triggered project, or the project related to the triggered record, depending on the action. """ Project """ A quote: a new quote, the triggered quote, or all quotes related to the triggered record, depending on the action. """ Quote """The active quote of the triggered opportunity.""" ActiveQuote """The submitted online form response that triggered the process.""" OnlineForm """ A custom entity record: a new one, the triggered one, or the records related to the triggered record, depending on the action. """ CustomEntity """The triggered email.""" Email """ The parent account of the triggered account; a created parent account replaces any existing one. """ ParentAccount """ Creates a parent account for the triggered account only when it has none yet. """ ParentAccountNoReplace """The primary account of the triggered record.""" PrimaryAccount """The primary contact of the triggered record.""" PrimaryContact """Leads in which the triggered account or contact is set as primary.""" PrimaryInLead """ Opportunities in which the triggered account or contact is set as primary. """ PrimaryInOpportunity """Contacts in which the triggered account is set as the primary account.""" PrimaryInContact """Quotes in which the triggered account or contact is set as primary.""" PrimaryInQuote """ Records that the triggered record references through the lookup field set in relationLookupFieldId. """ Lookup """ Records that reference the triggered record through the lookup field set in relationLookupFieldId. """ LookupRelated """ Only the primary record that the triggered record references through the lookup field set in relationLookupFieldId. """ PrimaryLookup """ Only the primary record among those referencing the triggered record through the lookup field set in relationLookupFieldId. """ PrimaryLookupRelated } """ Delay of a process action: an offset from the trigger time or from a date field, or a fixed date. """ type ProcessNodeSchedule { """ Delay before the action runs, expressed in the chosen unit. Positive values schedule after the reference point, negative values before it. """ offset: Int! """ Unit of the offset: minutes, hours, days, working days, weeks or months. """ offsetUnit: ProcessNodeScheduleUnitEnum! """ Date field on the triggered record that the offset is measured from. When omitted, the offset is measured from the time the action is reached. """ offsetFieldId: UUID """ Fixed date and time at which the action runs, used instead of an offset. """ date: DateTime } """Time unit of a scheduling offset in a process.""" enum ProcessNodeScheduleUnitEnum { """Offset measured in minutes.""" Minute """Offset measured in hours.""" Hour """Offset measured in calendar days.""" Day """Days that count only the space's working days.""" WorkingDay """Offset measured in weeks.""" Week """Offset measured in months.""" Month } """Process action that creates a copy of the triggered record.""" type ProcessCopyRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Field values and operations applied to the record this node creates or updates. """ entity: ProcessEntityTemplate """ When true, the records affected by this node also start another process. """ triggerProcess: Boolean! """ Process that the affected records start when triggering another process is enabled. """ triggerProcessId: UUID } """ Process action that starts another process for the triggered record or its related records. """ type ProcessTriggerProcessNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Relation from the triggered record to the records the process is started for; null starts it for the triggered record itself. """ triggerRelation: ProcessRecordNodeRelationEnum """ API name of the related custom entity to start the process for. Set only when the relation targets a custom entity. """ triggerRelationEntityApiName: String """ When true, the related records are passed to the started process as the records that triggered it. """ triggerRelationSender: Boolean """ Lookup field that defines the relation. Required when the relation is a lookup, and must be empty otherwise. """ relationLookupFieldId: String """Process that this node starts.""" processId: UUID! """ Optional condition that narrows which related records the started process runs for. """ filter: FieldFilter } """ Process action that assigns a new owner to the record, rotating among users or the members of sales units. """ type ProcessChangeOwnershipNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Whether the new owner is picked from a list of specific users or from the members of selected sales units. """ assigneeType: ProcessChangeOwnershipAssigneeType! """ Users among whom ownership is rotated in round-robin order. Used when the assignee type is a list of users. """ clientIds: [ID!]! """ Sales units whose members ownership is rotated among in round-robin order. Used when the assignee type is sales unit. """ salesUnitIds: [ID!]! } """Where a change-ownership action picks the new owner from.""" enum ProcessChangeOwnershipAssigneeType { """From a list of specific users.""" Client """From the members of the selected sales units.""" SalesUnit } """ Automation step that removes the triggered record from an email sequence. """ type ProcessUnenrollEmailSequenceNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """Email sequence the triggered record is removed from.""" emailSequenceId: UUID! } """ Automation step that enrolls the triggered record into an email sequence. """ type ProcessEnrollEmailSequenceNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """Email sequence the triggered record is enrolled into.""" emailSequenceId: UUID! } """ Automation step that qualifies the lead that triggered the automation into an opportunity. """ type ProcessQualifyRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Field values and operations applied to the record this node creates or updates. """ entity: ProcessEntityTemplate } """ A node which takes an archived lead, opportunity, quote, account or contact out of the archive. """ type ProcessUnarchiveRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Closing date set on the record when it is unarchived. Required when unarchiving an opportunity or quote. """ newClosingDate: Date } """ A node which archives the record: a lead, opportunity, quote, account or contact. """ type ProcessArchiveRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Field values and operations applied to the record this node creates or updates. """ entity: ProcessEntityTemplate """ When true, mark all activities related to the archived record as completed. """ completeRelatedActivities: Boolean! } """Process action that sends an HTTP request to an external URL.""" type ProcessSendWebhookNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """Webhook request this node sends.""" webhook: ProcessWebhook! } """ HTTP request a process sends: method, URL, body, authentication and headers. """ type ProcessWebhook { """ HTTP method the webhook request is sent with: POST, GET, PUT, PATCH or DELETE. """ requestType: ProcessWebhookRequestType! """ Target URL the webhook request is sent to. Must be an https address and may contain personalization tags. """ url: String! """Format of the request body: plain text, JSON or XML.""" requestFormat: ProcessWebhookRequestFormat! """ Fields to include in the request body, given as field identifiers or personalization markers. Mutually exclusive with advanced content. """ simpleContent: [String!] """ Free-form request body template with personalization tags. Mutually exclusive with simple content. """ advancedContent: String """ How date and time values in the request body are formatted: a Unix timestamp or an ISO 8601 string. """ timeFormat: ProcessWebhookTimeFormat! """Optional HTTP basic authentication credentials sent with the request.""" basicAuth: ProcessWebhookBasicAuth """Custom HTTP headers sent with the webhook request.""" headers: [ProcessWebhookHeader!] } """HTTP method a webhook action uses for its request.""" enum ProcessWebhookRequestType { """Sends the request with the HTTP POST method.""" POST """Sends the request with the HTTP GET method.""" GET """Sends the request with the HTTP PUT method.""" PUT """Sends the request with the HTTP PATCH method.""" PATCH """Sends the request with the HTTP DELETE method.""" DELETE } """Format of the body of a webhook request.""" enum ProcessWebhookRequestFormat { """Plain text (text/plain).""" Text """JSON (application/json).""" JSON """XML (text/xml).""" XML } """How dates and times are written in a webhook request body.""" enum ProcessWebhookTimeFormat { """Unix timestamp in seconds.""" Timestamp """ISO 8601 string.""" ISO8601 } """Custom HTTP header sent with a process webhook request.""" type ProcessWebhookHeader { """Name of the HTTP header sent with the webhook request.""" key: String """ Value of the HTTP header. Returned masked when the header is marked as encrypted. """ value: String """ When true, the header value is stored encrypted and hidden in responses. """ encrypted: Boolean } """ HTTP basic authentication credentials sent with a process webhook request. """ type ProcessWebhookBasicAuth { """ Username sent with the webhook request using HTTP basic authentication. """ username: String """ Password sent with the webhook request using HTTP basic authentication. Returned masked. """ password: String } """ Process action that links the triggered record to existing related records. """ type ProcessLinkRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """When true, the records linked by this node also start another process.""" triggerProcess: Boolean! """ Process that the linked records start when triggering another process is enabled. """ triggerProcessId: UUID """ Relationship from the triggered record to the related records this node acts on, such as a standard relation, a primary account or contact, a parent account, or a lookup field relation. """ relation: ProcessRecordNodeRelationEnum! """ Lookup field that defines the relation. Required when the relation is a lookup, and must be empty otherwise. """ relationLookupFieldId: String """ API name of the related custom entity. Set only when the related record type is a custom entity. """ entityApiName: String """ How the records to link are found: by a filter condition, or by matching a field value against a field on the triggered record. """ recordIdentificationType: ProcessRecordIdentificationType! """ Condition that selects the records to link. Used when records are identified by filter. """ recordFilter: FieldFilter """ Field on the triggered record whose value is matched to find records to link. Used when records are identified by field. """ triggeredRecordFieldId: UUID """ Field on the candidate records that must match the triggered record value. Used when records are identified by field. """ recordFieldId: UUID """ When true, link every matching record; when false, link only the best single match. """ linkAll: Boolean! } """How a link-record action finds the records to link.""" enum ProcessRecordIdentificationType { """Records matching a filter condition.""" Filter """Records whose field value matches a field on the triggered record.""" Field } """A node which creates entity with relation to the triggered entity""" type ProcessCreateRelatedRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Relationship from the triggered record to the related records this node acts on, such as a standard relation, a primary account or contact, a parent account, or a lookup field relation. """ relation: ProcessRecordNodeRelationEnum! """ Lookup field that defines the relation. Required when the relation is a lookup, and must be empty otherwise. """ relationLookupFieldId: String """ API name of the related custom entity. Set only when the related record type is a custom entity. """ entityApiName: String """ Field values and operations applied to the record this node creates or updates. """ entity: ProcessEntityTemplate """ When true, the records affected by this node also start another process. """ triggerProcess: Boolean! """ Process that the affected records start when triggering another process is enabled. """ triggerProcessId: UUID } """A node which updates related entities of triggered entity""" type ProcessUpdateRelatedRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Relationship from the triggered record to the related records this node acts on, such as a standard relation, a primary account or contact, a parent account, or a lookup field relation. """ relation: ProcessRecordNodeRelationEnum! """ Lookup field that defines the relation. Required when the relation is a lookup, and must be empty otherwise. """ relationLookupFieldId: String """ API name of the related custom entity. Set only when the related record type is a custom entity. """ entityApiName: String """ Field values and operations applied to the record this node creates or updates. """ entity: ProcessEntityTemplate """ When true, the records affected by this node also start another process. """ triggerProcess: Boolean! """ Process that the affected records start when triggering another process is enabled. """ triggerProcessId: UUID """ Optional condition that narrows which related records are updated. When omitted, all related records are updated. """ filter: FieldFilter } """ Automation step that sends an email, either to each recipient individually or as one mass email. """ type ProcessSendEmailNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Whether the email is sent as a single mass mailing to all recipients rather than as individual messages. """ isMass: Boolean! """Email message this node sends.""" email: ProcessNodeEmail! } """ Email sent by an automation step: recipients, content, sender and the records it is linked to. """ type ProcessNodeEmail implements EmailDataInterface { """ Primary recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ recipients: [SendEmailRecipient!]! """ Carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ cc: [SendEmailRecipient!]! """ Blind carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ bcc: [SendEmailRecipient!]! """ Subject line of the email. May contain personalization tags resolved from the triggered record. """ subject: String! """ HTML body of the email. May contain personalization tags resolved from the triggered record. """ body: String! """ Email template to use for the message. When set, the template supplies the subject and body. """ emailTemplateId: UUID """Stored files attached to the email.""" attachments: [UUID!]! """Signature appended to the email body.""" signature: String """ Account the email is sent from: the trigger actor, a company email, the record owner, or the approver. """ sender: ProcessNodeEmailSender! """ Company email account to send from. Set when the sender is a company email. """ senderCompanyEmailId: UUID """Visibility of the sent email to other users in the space.""" shareMode: ShareModeEnum """When true, link the sent email to the triggered record.""" linkTriggerEntity: Boolean """ When true, link the sent email to the account and contact records matching the recipient addresses. """ linkRecipients: Boolean """Whether the email body is treated as HTML rather than plain text.""" isHtmlTemplate: Boolean } """Mailbox a process email action sends from.""" enum ProcessNodeEmailSender { """The user whose action triggered the process.""" ActorEmail """A shared company email account.""" CompanyEmail """The owner of the triggered record.""" RecordOwnerEmail """The approver; available only in approval processes.""" ApproverEmail } """Automation step that updates the record that triggered the automation.""" type ProcessUpdateRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Field values and operations applied to the record this node creates or updates. """ entity: ProcessEntityTemplate """ When true, the records affected by this node also start another process. """ triggerProcess: Boolean! """ Process that the affected records start when triggering another process is enabled. """ triggerProcessId: UUID } """ A node which creates a new record that is not linked to the triggering record. """ type ProcessCreateRecordNode implements ProcessNodeInterface & ProcessScheduleInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Optional schedule that delays this action to a later time. When null, the action runs immediately when reached. """ schedule: ProcessNodeSchedule """ Field values and operations applied to the record this node creates or updates. """ entity: ProcessEntityTemplate """ When true, the records affected by this node also start another process. """ triggerProcess: Boolean! """ Process that the affected records start when triggering another process is enabled. """ triggerProcessId: UUID """ Type of record this node creates, such as Lead, Opportunity, Account, Contact, Task or Appointment. """ entityType: EntityNameEnum! """ API name of the custom entity this node creates. Set only when the created record type is a custom entity. """ entityApiName: String } """ Process node holding filter conditions; only the records that match them continue through the process. """ type ProcessFilterNode implements ProcessNodeInterface & ProfileFilterBoxTabInterface { """Unique identifier of this node within the process node tree.""" id: ID! """ Identifier of the node that precedes this one in the process node tree. Null for nodes attached directly to the trigger. """ parentId: ID """Display name of the node shown in the process builder.""" name: String! """ Whether the filter is applied. When false, the filter conditions are ignored. """ isEnabled: Boolean! """Primary group of filter conditions evaluated on the main record type.""" filterMainBox: MainFilterBox! """ Additional groups of filter conditions evaluated on related record types. """ filterSiblingBoxes: [FilterBox!]! """ How the filter conditions are combined: all must match, any may match, or a custom expression. """ operator: FilterGroupOperator! """ Custom boolean expression combining the numbered filter conditions. Used when the operator is a custom expression. """ formula: String } """ Trigger that starts an approval process when a record is created or updated. """ type ApprovalProcessRecordTrigger implements ProcessActorInterface { """ Which users are allowed to start the process: the process owner, selected users and sales units, any user, or applications only. """ actor: ProcessRecordTriggerActorEnum! """ Sales units whose members are allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUnits: [UUID!]! """ Individual users allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUsers: [UUID!]! """ Type of record whose changes start this process, such as Lead, Opportunity, Account or Contact. """ entityType: EntityNameEnum! """ API name of the custom entity that starts this process. Set only when the trigger entity type is a custom entity. """ entityApiName: String """ Applications whose actions are allowed to start the approval process. When empty, no application restriction is applied. """ applications: [UUID!]! """ Record change that starts the approval process: record created, updated, or created or updated. """ event: ApprovalProcessRecordTriggerEventEnum! } """Users who are allowed to start a process or an approval process.""" interface ProcessActorInterface { """ Which users are allowed to start the process: the process owner, selected users and sales units, any user, or applications only. """ actor: ProcessRecordTriggerActorEnum! """ Sales units whose members are allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUnits: [UUID!]! """ Individual users allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUsers: [UUID!]! } """ Whose actions start a process: the process owner, selected users and sales units, any user, or only selected applications. """ enum ProcessRecordTriggerActorEnum { """Only actions of the process owner; always used by personal processes.""" ProcessOwner """Actions of the selected users and members of the selected sales units.""" SelectedUnitsAndUsers """Actions of any user.""" AnyUser """ Only changes made through the selected applications; not available for manual triggers. """ ApplicationsOnly } """Record event that starts an approval process automatically.""" enum ApprovalProcessRecordTriggerEventEnum { """A record is created.""" Create """A record is created or updated.""" CreateOrUpdate """A record is updated.""" Update } """ Trigger that lets users start an approval process manually on a record. """ type ApprovalProcessManualTrigger implements ProcessActorInterface { """ Which users are allowed to start the process: the process owner, selected users and sales units, any user, or applications only. """ actor: ProcessRecordTriggerActorEnum! """ Sales units whose members are allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUnits: [UUID!]! """ Individual users allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUsers: [UUID!]! """ Type of record whose changes start this process, such as Lead, Opportunity, Account or Contact. """ entityType: EntityNameEnum! """ API name of the custom entity that starts this process. Set only when the trigger entity type is a custom entity. """ entityApiName: String } """ Settings of the last contacted date field of accounts and contacts: the date field that replaces the calculated value, if any. """ type LastContactedDateProperty { """ Id of the Date / DateTime field whose value replaces the system-calculated Last Contacted Date. When null, the system calculation (the most recent completed call/email task, appointment, sent email or text message) is used. """ lastContactedDateDefinitionFieldId: UUID } """ Settings of a country field: whether values outside the country list are accepted. """ type CountryProperty { """If true, values outside the predefined country list can be entered.""" enableCustomValues: Boolean! } """ Settings of the gender field of contacts: whether it is offered on online forms and whether it has a non-binary option. """ type GenderProperty { """If true, the gender field is shown on online forms.""" showOnForms: Boolean! """ If true, a non-binary option is offered in addition to the standard gender options. """ showNonBinaryOption: Boolean! } """ Settings of the linked items field of activities, emails, memos and other records that can be linked to several records. """ type LinkedItemsProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of the stakeholders card of projects, which shows their linked contacts. """ type ProjectContactCardProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of the related accounts card of contacts, which shows the accounts a contact is linked to. """ type ContactAccountCardProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of the account card of projects, which shows their linked accounts. """ type ProjectAccountCardProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of the parent account card of accounts, which shows the parent account in the account hierarchy. """ type ParentAccountCardProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of the opportunity card of quotes, which shows their opportunity. """ type OpptyCardProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of the contact card of leads, opportunities and quotes, which shows their linked contacts. """ type ContactCardProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of the account card of leads, opportunities and quotes, which shows their linked accounts. """ type AccountCardProperty { """ If true, archived records are shown when selecting and displaying the linked records in this card. """ showArchivedRecords: Boolean! } """ Settings of a products and services field of online forms: which products are offered and how they are shown. """ type OnlineFormProductServicesProperty { """If true, the combined total amount of the selected products is shown.""" showTotalAmount: Boolean! """If true, product images are shown in the product list.""" showProductImages: Boolean! """ If true, the number of products that can be selected is limited (see maxSelectedProducts). """ productSelectionLimitEnabled: Boolean! """ Maximum number of products that can be selected when the selection limit is enabled. """ maxSelectedProducts: Int """Ids of the product fields shown for each selectable product.""" fields: [ID!]! """ Whether the selectable products are a fixed static list or a dynamically filtered set. """ productListType: ProductListTypeEnum! """Ids of the products offered when the product list type is static.""" staticProducts: [ID!] """ Filter selecting which products are offered when the product list type is dynamic. """ dynamicProductsFilter: FieldFilter } """How the products offered in an online form are chosen.""" enum ProductListTypeEnum { """A fixed list of products (staticProducts).""" Static """Products matching a filter (dynamicProductsFilter).""" Dynamic } """ Settings of a file upload field: how many files, how large and of which types can be uploaded. """ type FileUploadProperty { """Maximum number of files that can be uploaded to this field.""" maxFiles: Int! """Maximum size per file, in MB.""" maxFileSize: Int! """ Allowed file-type categories (e.g. image, document); used when file-type restriction is enabled. """ fileTypes: [FileTypeEnum!]! """ Additional allowed file extensions when the Custom file type is selected (e.g. ".dwg"). """ customFileExtensions: [String!]! """ If true, uploads are restricted to the configured file types and custom extensions; otherwise any file type is accepted. """ fileTypesEnabled: Boolean! } """Category of files accepted by a file-upload form field.""" enum FileTypeEnum { """Text documents (e.g. .pdf, .doc, .docx, .odt, .txt).""" Document """Spreadsheets (e.g. .xls, .xlsx, .ods, .csv).""" Spreadsheet """Presentations (e.g. .ppt, .pptx, .odp).""" Presentation """PDF files only.""" Pdf """Drawings and CAD files (e.g. .odg, .dwg, .dxf).""" Drawing """Images (e.g. .jpg, .png, .gif, .heic, .webp).""" Image """Audio files (e.g. .mp3, .m4a, .wav, .flac).""" Audio """Video files (e.g. .mp4, .mov, .mkv, .avi, .webm).""" Video """Extensions listed in customFileExtensions.""" Custom } """ Settings of a lookup field, such as which linked record is treated as the primary one. """ type LookupSettingsProperty { """ When several records are linked through the lookup, determines which one is treated as the primary related record (e.g. the first one added into the lookup). """ primaryRelationResolution: LookupPrimaryRelationResolutionEnum } """ Rule that picks the primary related record when a lookup links several records. """ enum LookupPrimaryRelationResolutionEnum { """The record added to the lookup first (default).""" FirstAddedIntoLookup """The record added to the lookup most recently.""" LastAddedIntoLookup """The most recently created linked record.""" LatestCreatedWithinLookup """The oldest linked record.""" OldestCreatedWithinLookup } """ Settings of the due date field of tasks: whether recurrence is enabled. """ type DueDateProperty { """If true, recurrence is enabled for this due-date field.""" isRecurrenceEnabled: Boolean! } """ Settings of the closing date field of opportunities: whether recurrence is enabled. """ type ClosingDateProperty { """If true, recurrence is enabled for this closing-date field.""" isRecurrenceEnabled: Boolean! } """ Display settings of a whole number field: thousands separator and unit. """ type IntegerProperty { """ If true, the value is displayed with a thousands separator (e.g. 1,000). """ useThousandSeparator: Boolean! """Unit label appended to the displayed value, such as "kg".""" unit: String } """ Display settings of a decimal number field: decimal places, thousands separator and unit. """ type FloatProperty { """ If true, the value is displayed with a thousands separator (e.g. 1,000). """ useThousandSeparator: Boolean! """Number of decimal places the value is rounded to for display.""" decimalPlaces: Int! """Unit label appended to the displayed value, such as "kg".""" unit: String } """Display settings of a multiselect field.""" type MultiSelectProperty { """ If true, selected values are rendered with the advanced (chip/tag) visualization instead of a plain comma-separated list. """ advancedVisualization: Boolean! } """Settings of a product price field: the number of decimal places shown.""" type ProductPriceProperty { """Number of decimal places the value is rounded to for display.""" decimalPlaces: Int! } """ Settings of a foreign currency field: the number of decimal places shown. """ type CurrencyForeignProperty { """Number of decimal places the value is rounded to for display.""" decimalPlaces: Int! } """Settings of a currency field: the number of decimal places shown.""" type CurrencyProperty { """Number of decimal places the value is rounded to for display.""" decimalPlaces: Int! } """Settings of a text area field: whether it holds rich text.""" type TextAreaProperty { """Whether field should be displayed in rich text editor""" isRichText: Boolean! } """ Form layout of a record type: its headings, field containers and step sections in display order. """ type Form { """Display name of the form layout.""" label: String! """ When true, the label is shown using the workspace's translated language strings. """ useLang: Boolean """ Top-level layout items (separators, subsections, containers, step containers) in display order. """ items: [FormItemInterface] } """ Top-level item of a record form layout, such as a heading or a block of fields. """ interface FormItemInterface { """Unique id of the form layout item.""" id: UUID! """When true, this item is shown in the mobile app.""" onMobile: Boolean """ Kind of layout item — separator, subsection, container, hardcoded container or step container. """ kind: FormItemKindEnum! } """Kind of item in a form layout.""" enum FormItemKindEnum { """Section heading that groups the items below it.""" Separator """Smaller heading inside a section.""" Subsection """Block of columns holding fields and web resources.""" Container """ Fixed block with predefined content, such as the account, contact or product name. """ HardcodedContainer """Multi-step section with its own field containers for each step.""" StepFieldsContainer } """ Section of a lead or opportunity form that shows different fields for each step of its lead process or pipeline. """ type StepFieldsContainer implements FormItemInterface { """Unique id of the form layout item.""" id: UUID! """When true, this item is shown in the mobile app.""" onMobile: Boolean """ Kind of layout item — separator, subsection, container, hardcoded container or step container. """ kind: FormItemKindEnum! """Display name of the multi-step section.""" label: String! """ When true, the section name uses the workspace's translated language strings. """ useLang: Boolean """ Ordered steps of the multi-step form, each with its own field containers. """ steps: [Step] } """ Fields a step section of a form shows for one step of the lead process or pipeline. """ type Step { """Unique id of the step.""" id: String! """Field containers shown on this step.""" containers: [FormContainer] } """Block of a record form with columns of fields and web resources.""" type FormContainer implements FormItemInterface { """Unique id of the form layout item.""" id: UUID! """When true, this item is shown in the mobile app.""" onMobile: Boolean """ Kind of layout item — separator, subsection, container, hardcoded container or step container. """ kind: FormItemKindEnum! """Columns laid out side by side within this container.""" columns: [FormColumn] } """ Column of a form container, holding fields and web resources in display order. """ type FormColumn { """Unique id of the column.""" id: UUID! """Relative width of the column within its container.""" size: Int! """Fields and web resources placed in this column, in display order.""" items: [FormContainerItemInterface] } """ Item placed in a column of a record form: a field or an embedded web resource. """ interface FormContainerItemInterface { """Kind of column item — a placed field or an embedded web resource.""" kind: FormContainerItemKind! } """Kind of item placed in a form layout container.""" enum FormContainerItemKind { """A record field.""" Field """An embedded web resource.""" WebResource } """Embedded web content placed in a column of a record form.""" type WebResource implements FormContainerItemInterface { """Kind of column item — a placed field or an embedded web resource.""" kind: FormContainerItemKind! """Unique id of the embedded web resource.""" id: String! """Relative width of the web resource within its column.""" size: Int! """Display label of the embedded web resource.""" label: String! """Optional descriptive text for the embedded web resource.""" description: String } """ Field placed on a record form, with its label, validation and conditional rules. """ type FormField implements FormContainerItemInterface { """Kind of column item — a placed field or an embedded web resource.""" kind: FormContainerItemKind! """Id of the field placed on the form.""" id: String! """When true, the field is shown in the mobile app.""" onMobile: Boolean """When true, the field is displayed but cannot be edited.""" readonly: Boolean """Label shown for the field on the form.""" label: String! """When true, the label uses the workspace's translated language strings.""" useLang: Boolean """Optional help text shown with the field.""" description: String """ Validation rules applied to the field's value (required, min/max, formula, …). """ validators: FieldValidator """ When true, the sub-label uses the workspace's translated language strings. """ subLabelUseLang: Boolean """Secondary label shown beneath the field's main label.""" subLabel: String """ When true, a foreign-currency field also shows its fixed base-currency value. """ showFixedValue: Boolean """ For dropdowns, how a value is pre-selected — none, the first option, or only when a single option exists. """ dropdownAutoselect: DropDownAutoselectEnum """For a product-list field, the product sections used to group products.""" productSections: [ProductSection!] """ For a product-list field, when true each product section shows the sum of its lines' Amount. """ productSectionTotals: Boolean """When true, the field is shown in the email add-in.""" inAddin: Boolean """ For a lookup field, how linked records are shown — a multi-selection list or cards. """ lookupVisualization: LookupVisualizationType """ When true, the opportunity value is calculated from its products by default. """ opptyValueAutoCalculateDefault: Boolean """Read-only label resolved into the current user's language.""" labelTranslated: String """Per-language overrides for the field label.""" labelTranslations: JSONString """Read-only help text resolved into the current user's language.""" descriptionTranslated: String """Per-language overrides for the field help text.""" descriptionTranslations: JSONString """Condition under which the field becomes read-only.""" readonlyRules: FieldFilter """Condition under which the field becomes required.""" requiredRules: FieldFilter """Condition under which the field is shown.""" visibilityRules: FieldFilter """ For a linked-items field, the entity types whose records may be linked. """ allowedEntities: [String!] } """How a dropdown field on a form pre-selects a value.""" enum DropDownAutoselectEnum { """No value is pre-selected.""" NoSelect """The first option is pre-selected.""" SelectFirst """The option is pre-selected only when it is the only one.""" SelectOnlyIfOneItem } """How a lookup field shows its linked records on a form.""" enum LookupVisualizationType { """As a multi-selection list (default).""" MultiSelection """As record cards.""" Card } """Validation rules of a field placed on a form.""" type FieldValidator { """When true, the field must be filled in.""" required: Boolean """ When true, the field is required only while its own step is the active step of a multi-step form. """ requiredOnlyOnCurrentStep: Boolean """ Minimum accepted value — a number or ISO date depending on the field type. """ minValue: String """ Maximum accepted value — a number or ISO date depending on the field type. """ maxValue: String """ Conditional formula that must evaluate to true for the value to be accepted. """ formula: FormulaValidator """When true, the value must be a valid email address.""" isEmail: Boolean """When true, the value must be a valid URL.""" isUrl: Boolean """ Key grouping this field with others, of which at least one must be filled in. """ requiredCombined: String """Minimum number of selections required for a multi-select field.""" requiredMinItems: Int """When true, the relation must point to a parent-account relationship.""" isParentAccountRelationType: Boolean """When true, the field accepts a date range rather than a single date.""" isDaterange: Boolean """Allowed integer-valued options, as name/value pairs.""" intEnum: [IntEnumItem] """Allowed bit-flag options, as name/value pairs.""" flagEnum: [IntEnumItem] """When true, an empty value is explicitly allowed.""" nullable: Boolean """When true, exactly one field in the combined group must be filled in.""" requiredExactlyOne: Boolean } """Allowed option of a field validator, as a name and an integer value.""" type IntEnumItem { """Display name of the option.""" key: String! """Integer value stored for the option.""" value: Int! } """ Formula a field value must satisfy, with the error message shown when it does not. """ type FormulaValidator { """ Boolean formula (Coevera calculation syntax) that must evaluate to true for the value to be valid. """ expression: String! """Error message shown when the formula evaluates to false.""" message: String! } """Smaller heading inside a section of a record form.""" type FormSubsection implements FormItemInterface { """Unique id of the form layout item.""" id: UUID! """When true, this item is shown in the mobile app.""" onMobile: Boolean """ Kind of layout item — separator, subsection, container, hardcoded container or step container. """ kind: FormItemKindEnum! """ When true, the subsection heading uses the workspace's translated language strings. """ useLang: Boolean """Heading text for the subsection.""" label: String! """Optional descriptive text shown beneath the subsection heading.""" description: String } """Section heading on a record form that groups the items below it.""" type FormSeparator implements FormItemInterface { """Unique id of the form layout item.""" id: UUID! """When true, this item is shown in the mobile app.""" onMobile: Boolean """ Kind of layout item — separator, subsection, container, hardcoded container or step container. """ kind: FormItemKindEnum! """ When true, the heading uses the workspace's translated language strings. """ useLang: Boolean """Heading text for the group separator.""" label: String! """Optional descriptive text shown beneath the group heading.""" description: String } """ Fixed block of a record form with predefined content, such as the account, contact or product name. """ type HardCodedContainer implements FormItemInterface { """Unique id of the form layout item.""" id: UUID! """When true, this item is shown in the mobile app.""" onMobile: Boolean """ Kind of layout item — separator, subsection, container, hardcoded container or step container. """ kind: FormItemKindEnum! """ Which built-in region this renders — account, contact or product name, or the message-to-sales-team block on a lost form. """ type: HardcodedContainerTypeEnum! """When true, this region is shown in the email add-in.""" inAddin: Boolean } """Built-in region placed on a form layout.""" enum HardcodedContainerTypeEnum { """Account name block.""" AccountName """Contact name block.""" ContactName """Product name block.""" ProductName """Message-to-sales-team block on a lost form.""" MessageToSalesTeam } """ Content of an online form: its questions and sections, header, footer, theme and submission settings. """ type OnlineForm { """ Top-level layout items (containers and sections) that make up the form body, in display order. """ fields: [OnlineFormItem]! """Header shown at the top of the form.""" header: OnlineFormHeader! """Footer containing the submit button shown at the bottom of the form.""" footer: OnlineFormFooter! """Visual theme settings for the form.""" theme: OnlineFormTheme! """ Behavioural settings controlling submission, notifications, limits, and record handling. """ settings: OnlineFormSettings! } """Top-level item of an online form: a row of questions or a section.""" union OnlineFormItem = OnlineFormContainer | OnlineFormSection """ What happens when an online form is submitted: records created, updated and linked, notifications, the confirmation page and response limits. """ type OnlineFormSettings { """If true, submitting the form updates an existing record.""" updateRecordEnabled: Boolean! """Template describing how the existing record is updated on submission.""" updateRecordForm: ProcessEntityTemplate """If true, submitting the form creates a new record.""" createRecordEnabled: Boolean! """Template describing how the new record is created on submission.""" createRecordForm: ProcessEntityTemplate """If true, submitting the form links the response to an existing record.""" linkRecordEnabled: Boolean! """ Settings for related records that are linked to existing records on submission. """ linkRelatedRecords: [OnlineFormRelatedRecordSettings!]! """ Settings for related records that are either linked if found or created otherwise on submission. """ linkOrCreateRelatedRecords: [OnlineFormRelatedRecordSettings!]! """ Settings for related records that are updated if found or created otherwise on submission. """ updateOrCreateRelatedRecords: [OnlineFormRelatedRecordSettings!]! """Settings for related records that are updated on submission.""" updateRelatedRecords: [OnlineFormRelatedRecordSettings!]! """Settings for related records that are created on submission.""" createRelatedRecords: [OnlineFormRelatedRecordSettings!]! """ If true, a PDF copy of the response is attached to the created or updated record. """ attachResponseAsPdf: Boolean! """If true, each respondent may submit the form only once.""" limitToSingleResponse: Boolean! """ If true, the form checks for a previous response from the same respondent before accepting a submission. """ checkForExistingResponse: Boolean! """If true, an email notification is sent when the form is submitted.""" notificationEnabled: Boolean! """ Who receives the submission notification: the form Owner, the PrimaryRecordOwner, and/or Custom email addresses. """ notificationRecipientType: [OnlineFormNotificationRecipientType!]! """Custom email addresses that receive the submission notification.""" notificationEmails: [String!]! """ If true, an email notification is sent when the form stops accepting responses. """ notificationLimitEnabled: Boolean! """ Who receives the limit-reached notification: the form Owner, the PrimaryRecordOwner, and/or Custom email addresses. """ notificationLimitRecipientType: [OnlineFormNotificationRecipientType!]! """Custom email addresses that receive the limit-reached notification.""" notificationLimitEmails: [String!]! """ What the respondent sees after submitting: a ConfirmationPage or a redirect to an ExternalUrl. """ confirmationPageType: OnlineFormConfirmationPageType! """Heading shown on the confirmation page after submission.""" confirmationPageTitle: String """Message shown on the confirmation page after submission.""" confirmationPageMessage: String """External URL the respondent is redirected to after submission.""" confirmationPageUrl: String """ If true, a response submitted without a record is linked to the existing record whose autolinkRecordFieldId value matches the autolinkFormFieldId answer. """ autolinkEnabled: Boolean! """ Identifier of the form field whose value is matched against records to auto-link a response. """ autolinkFormFieldId: ID """ Identifier of the record field matched against the form field value to auto-link a response. """ autolinkRecordFieldId: ID """ If true, all form content is shown on a single page rather than split across pages. """ singlePageContent: Boolean! """If true, the form stops accepting responses after a set date and time.""" responseAcceptanceDateLimitEnabled: Boolean! """Date and time after which the form no longer accepts responses.""" responseAcceptanceDateLimitDate: DateTime """Message shown to respondents after the date limit has passed.""" responseAcceptanceDateLimitMessage: String """Heading shown to respondents after the date limit has passed.""" responseAcceptanceDateLimitTitle: String """ If true, the form stops accepting responses once a threshold is reached. """ responseAcceptanceThresholdEnabled: Boolean! """ How the threshold is measured: TotalResponses, CustomCondition, or ProductsLimits. """ responseAcceptanceThresholdType: ResponseAcceptanceThresholdType! """ Maximum number of responses accepted when the threshold type is TotalResponses. """ responseAcceptanceThresholdNoOfResponses: Int """ Formula-based threshold configuration used when the threshold type is CustomCondition. """ responseAcceptanceThresholdCustomCondition: ResponseAcceptanceThresholdCustomCondition """Message shown to respondents after the threshold has been reached.""" responseAcceptanceThresholdMessage: String """Heading shown to respondents after the threshold has been reached.""" responseAcceptanceThresholdTitle: String """ Per-product quantity threshold configuration used when the threshold type is ProductsLimits. """ responseAcceptanceThresholdProductsLimits: ResponseAcceptanceThresholdProductsLimits """ If true, every response must identify an existing record; a submission that cannot be linked to a record is not accepted and the respondent is asked to identify their record. """ recordIdentificationEnabled: Boolean! """Message shown to respondents asking them to identify their record.""" recordIdentificationMessage: String """Heading shown to respondents asking them to identify their record.""" recordIdentificationTitle: String """ How record identification is presented: an in-form ConfirmationPage or a redirect to an ExternalUrl. """ recordIdentificationType: OnlineFormConfirmationPageType! """ External URL used for record identification when the identification type is ExternalUrl. """ recordIdentificationUrl: String """ Maximum total size, in megabytes, of the files uploaded across all responses of the form; once it is reached, the form stops accepting responses. """ maxTotalUploadedFilesSize: Int! """ If true, files uploaded via the form are attached to the created or updated record. """ attachFiles: Boolean! """ Identifier of the price list used to price products shown on the form; defaults to the current price list when not set. """ productsPriceListId: ID """Identifier of the currency in which product prices are shown.""" productsCurrencyId: ID! """ If true, the grand total of all selected products is shown on the form. """ productsShowGrandTotal: Boolean! """If true, per-product quantity limits are enforced for each response.""" productsResponseLimitsEnabled: Boolean! """Per-product quantity limits applied to a single response.""" productsResponseLimits: [OnlineFormProductsResponseLimit!]! """ If true, per-product quantity limits are enforced across all responses combined. """ productsTotalResponseLimitsEnabled: Boolean! """Per-product quantity limits applied across all responses combined.""" productsTotalResponseLimits: [OnlineFormProductsResponseLimit!]! """ If true, respondents may resume an unfinished response. Answers are held in the respondent's own browser; nothing is stored server-side. """ saveProgressEnabled: Boolean! """If true, each question is numbered on the form.""" showQuestionNumbers: Boolean! } """Who receives an online form notification email.""" enum OnlineFormNotificationRecipientType { """The owner of the online form.""" Owner """The owner of the record the response belongs to.""" PrimaryRecordOwner """The email addresses listed in the notification settings.""" Custom } """ What an online form respondent is shown: a page inside the form or a redirect to an external URL. """ enum OnlineFormConfirmationPageType { """A page with a title and message inside the form.""" ConfirmationPage """A redirect to the configured URL.""" ExternalUrl } """How the response limit of an online form is measured.""" enum ResponseAcceptanceThresholdType { """ The form stops accepting responses after responseAcceptanceThresholdNoOfResponses responses. """ TotalResponses """ Responses are limited by the formula values in responseAcceptanceThresholdCustomCondition, per response and in total. """ CustomCondition """ Responses are limited by the per-product quantity limits in responseAcceptanceThresholdProductsLimits. """ ProductsLimits } """Maximum quantity of one product that online form responses may select.""" type OnlineFormProductsResponseLimit { """If true, this product quantity limit is enforced.""" enabled: Boolean! """Identifier of the product field the limit applies to.""" fieldId: ID! """Maximum quantity of the product that may be selected.""" quantity: Int! } """ Product quantity limits after which an online form stops accepting responses. """ type ResponseAcceptanceThresholdProductsLimits { """ Per-product quantity limits that together determine when the form stops accepting responses. """ limits: [OnlineFormProductsResponseLimit!]! """ Whether all (And) or any (Or) of the product limits must be reached to stop accepting responses. """ operator: FilterGroupOperator! } """ Formula-based limit after which an online form stops accepting responses. """ type ResponseAcceptanceThresholdCustomCondition { """ Formula evaluated against each response to compute the value counted toward the acceptance limits. """ formula: String! """Maximum value a single response may contribute; must be 1 or greater.""" maxValuePerResponse: Int! """ Maximum combined value across all responses before the form stops accepting; must be 1 or greater. """ maxValueForAllResponses: Int! } """ Rule for a related record that is linked, created or updated when an online form response is submitted. """ type OnlineFormRelatedRecordSettings { """Identifier of this related-record rule.""" id: ID! """ Which related entity (via its relation) this rule links or creates records for when a response is submitted. """ relation: ProcessRecordNodeRelationEnum! """ Id of the lookup field defining the relation, when the relation is reached through a specific lookup field. """ relationLookupFieldId: String """ Record-creation form used to create the related record (for the link-or-create and update-or-create modes). """ createForm: ProcessEntityTemplate """ Record-edit form used to update the matched related record (for the update and update-or-create modes). """ updateForm: ProcessEntityTemplate """ Id of the form field whose value is matched against the related records to find the one to link. """ linkFormFieldId: ID """ Id of the related-record field matched against the form-field value when finding the record to link. """ linkRecordFieldId: ID """ If true, every matching related record is linked rather than only the first match. """ linkAll: Boolean! } """Theme of an online form, such as its header image.""" type OnlineFormTheme { """ Cloud storage identifier of the header or banner image used for the form theme. """ imageCloudObjectId: ID } """Footer of an online form with the submit button.""" type OnlineFormFooter { """Text shown on the form submit button.""" submitButtonLabel: String! """Horizontal alignment of the submit button: Left, Middle, or Right.""" submitButtonPosition: OnlineFormButtonPositionEnum! } """Horizontal alignment of the submit button on an online form.""" enum OnlineFormButtonPositionEnum { """The button is aligned to the left.""" Left """The button is centered.""" Middle """The button is aligned to the right.""" Right } """Header of an online form with its title and description.""" type OnlineFormHeader { """Heading text shown at the top of the form.""" title: String! """Subtitle text shown under the form heading.""" description: String! """If true, the header is shown on the form.""" visible: Boolean! """ If true, the header is repeated on every page of a multi-page form rather than only the first. """ showHeaderOnAllPages: Boolean! } """Section of an online form with its own title and description.""" type OnlineFormSection { """Unique identifier of the section within the form layout.""" id: ID! """Descriptive text shown under the section title.""" description: String! """Heading shown at the top of the section.""" title: String! """If true, the section is shown on the form.""" visible: Boolean! } """Row of an online form with columns of questions.""" type OnlineFormContainer { """Unique identifier of the container within the form layout.""" id: ID! """Columns that make up this container row, in left-to-right order.""" columns: [OnlineFormColumn!]! } """ Column of an online form container, holding form fields in display order. """ type OnlineFormColumn { """Unique identifier of the column within the container.""" id: ID! """Relative width of the column within its container row.""" size: Int! """Form fields placed in this column, in display order.""" fields: [OnlineFormFieldInterface!]! } """ Question of an online form; the answer is stored in a field of the record the response creates or updates. """ interface OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter } """Source of the value an online form field is prefilled with.""" enum OnlineFormPrefillTypeEnum { """A fixed value.""" Custom """The value of the record field given in prefillFieldId.""" Field } """ Question of an online form in which respondents select products and services. """ type OnlineFormProductsServicesField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """ If true, the combined total amount of selected products is shown on the form. """ showTotalAmount: Boolean! """If true, product images are shown alongside each product.""" showProductImages: Boolean! """If true, the number of products a respondent can select is capped.""" productSelectionLimitEnabled: Boolean! """ Maximum number of products the respondent may select when the selection limit is enabled. """ maxSelectedProducts: Int """ Placeholder text shown in the product-selection control before a product is chosen. """ placeholder: String } """File upload question of an online form.""" type OnlineFormFileUploadField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """ JSON configuration for the file upload, including the maximum number of files, the maximum file size, and the allowed file extensions. """ fileUploadOptions: FileUploadProperty! } """Phone number question of an online form.""" type OnlineFormPhoneField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty input.""" placeholder: String """Fixed text used to pre-populate the field when prefill is enabled.""" prefillText: String } """Checkbox question of an online form.""" type OnlineFormCheckboxField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown next to the checkbox.""" placeholder: String """Text label shown beside the checkbox.""" valueLabel: String """If true, the checkbox is checked by default when the form loads.""" valueDefaultChecked: Boolean! """ Checked or unchecked state used to pre-populate the field when prefill is enabled. """ prefillBoolean: Boolean } """Decimal number question of an online form.""" type OnlineFormFloatField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty input.""" placeholder: String """Fixed number used to pre-populate the field when prefill is enabled.""" prefillFloat: Float } """Whole number question of an online form.""" type OnlineFormIntegerField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty input.""" placeholder: String """ Fixed whole number used to pre-populate the field when prefill is enabled. """ prefillInteger: Int } """Single-line text question of an online form.""" type OnlineFormInputField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty input.""" placeholder: String """Fixed text used to pre-populate the field when prefill is enabled.""" prefillText: String } """ Email address input of an online form, filling an email field of the record the form creates. """ type OnlineFormEmailField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty input.""" placeholder: String """Fixed text used to pre-populate the field when prefill is enabled.""" prefillText: String } """Date and time question of an online form.""" type OnlineFormDateTimeField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty date and time input.""" placeholder: String """ Fixed date and time used to pre-populate the field when prefill is enabled. """ prefillDateTime: DateTime } """Date question of an online form.""" type OnlineFormDateField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty date input.""" placeholder: String """Fixed date used to pre-populate the field when prefill is enabled.""" prefillDate: Date } """Question of an online form with checkboxes, allowing several answers.""" type OnlineFormMultiselectCheckboxField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """ Per-option overrides controlling which choices are shown, their labels, and their order. """ valueOverrides: [OnlineFormValueOverride!]! """Identifiers of the options pre-selected when prefill is enabled.""" prefillValues: [ID] } """ Changed display of one option of a choice question on an online form: its label and position. """ type OnlineFormValueOverride { """Identifier of the underlying field option this override applies to.""" id: ID! """If true, this option is shown as a choice on the form.""" visible: Boolean """ Custom label shown for this option on the form, overriding the default option name. """ label: String """Position of this option in the displayed list of choices.""" sortOrder: Int } """ Rating question of an online form, answered by picking a value on a scale. """ type OnlineFormRatingField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Lowest value on the rating scale.""" valueFrom: Int! """Highest value on the rating scale.""" valueTo: Int! """Label shown next to the lowest value on the rating scale.""" valueFromLabel: String """Label shown next to the highest value on the rating scale.""" valueToLabel: String """Rating value pre-selected when prefill is enabled.""" prefillInteger: Int } """ Question of an online form with radio buttons, allowing a single answer. """ type OnlineFormRadioField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """ Per-option overrides controlling which choices are shown, their labels, and their order. """ valueOverrides: [OnlineFormValueOverride!]! """Identifier of the option pre-selected when prefill is enabled.""" prefillValue: ID } """Dropdown question of an online form, with a single answer.""" type OnlineFormDropdownField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """ Per-option overrides controlling which choices are shown, their labels, and their order. """ valueOverrides: [OnlineFormValueOverride!]! """Hint text shown when no option is selected.""" placeholder: String """Identifier of the option pre-selected when prefill is enabled.""" prefillValue: ID } """Multi-line text question of an online form.""" type OnlineFormTextAreaField implements OnlineFormFieldInterface { """Identifier of the entity field this form field captures.""" fieldId: String! """Label shown above the field on the form.""" name: String! """Help text shown under the field label on the form.""" description: String! """If true, an image is displayed alongside the field.""" imageEnabled: Boolean! """Cloud storage identifier of the image displayed with the field.""" imageCloudObjectId: ID """If true, the field is shown on the form.""" visible: Boolean! """If true, the field must be filled in before the form can be submitted.""" required: Boolean! """ If true, the field is displayed but cannot be edited by the respondent. """ readOnly: Boolean! """If true, the field is pre-populated with a value when the form loads.""" prefillEnabled: Boolean! """ Source of the prefill value: Custom for a fixed value, Field to copy from another field. """ prefillType: OnlineFormPrefillTypeEnum! """ Identifier of the field whose value is copied in when prefill type is Field. """ prefillFieldId: String """ Identifier of the lookup field used to resolve the prefill value when prefilling from a related record. """ prefillLookupFieldId: ID """ Filter conditions that control whether the field is shown, based on the values of other fields. """ conditionalRulesFilter: FieldFilter """Hint text shown inside the empty input.""" placeholder: String """Fixed text used to pre-populate the field when prefill is enabled.""" prefillText: String } """ Canvas of a solution: the nodes placed on it, the edges connecting them and the groups bundling them. """ type SolutionSchema { """Nodes placed on the canvas.""" nodes: [SolutionNodeInterface!]! """Typed edges between nodes.""" edges: [SolutionEdge!]! """Visual groups bundling nodes.""" groups: [SolutionGroup!]! """ Records the user removed from the canvas. The scan never adds them back on its own; picking one through the addRecordIds argument of scan restores it and removes it from this list. """ removedRecordIds: [UUID!]! } """A labelled, coloured container bundling a set of nodes on the canvas.""" type SolutionGroup { """Unique identifier of this group within the canvas.""" id: ID! """Group rectangle (position and size) on the canvas.""" position: Rectangle! """Display label of the group.""" name: String! """Group color.""" color: Int! } """A directed, typed edge between two nodes.""" type SolutionEdge { """Unique identifier of this edge within the canvas.""" id: ID! """Custom name for the edge, if the user has set one.""" name: String """Custom color for the edge, if the user has set one.""" color: Int """Id of the node the edge starts from.""" sourceNodeId: ID! """Id of the node the edge points to.""" targetNodeId: ID! """Type of connection the edge represents.""" type: SolutionEdgeType! } """ Kind of connection an edge represents. Manual edges are drawn by the user; the other types are derived from the records' configuration by the scan. """ enum SolutionEdgeType { """Drawn by the user.""" Manual """ The source changes records in a way that fires the target process's record trigger. """ TriggerImplicit """ A process or email sequence is explicitly configured to start the target process or enroll into the target sequence. """ TriggerExplicit """ A field, sales process, template, report or form link of the source is used in the target's configuration. """ UsedIn """A dashboard and a navigator share the same dashboard surface.""" Reference } """Common shape of every node placed on the canvas.""" interface SolutionNodeInterface { """Unique identifier of this node within the canvas.""" id: ID! """Node position on the canvas.""" position: Position! """ Node size in pixels, set when the user resizes the node on the canvas. Null means the default size. """ size: Size """Group this node belongs to, if any.""" groupId: ID """Custom name for the node, if the user has set one.""" name: String """Whether the node was added manually or by the auto-add scan engine.""" origin: SolutionNodeOrigin! } """How a node came to be on a solution canvas.""" enum SolutionNodeOrigin { """Added by a user; kept when the solution is rescanned.""" Manual """ Added automatically by the solution scan; can be removed by a later rescan. """ System } """A node representing a single referenced CRM record.""" type SolutionRecordNode implements SolutionNodeInterface { """Unique identifier of this node within the canvas.""" id: ID! """Node position on the canvas.""" position: Position! """ Node size in pixels, set when the user resizes the node on the canvas. Null means the default size. """ size: Size """Group this node belongs to, if any.""" groupId: ID """Custom name for the node, if the user has set one.""" name: String """Whether the node was added manually or by the auto-add scan engine.""" origin: SolutionNodeOrigin! """Id of the referenced record.""" recordId: ID! """Type of the referenced record.""" recordType: SolutionRecordNodeType! } """Type of the record a solution canvas node references.""" enum SolutionRecordNodeType { """An email template.""" EmailTemplate """A Navigator screen profile.""" Navigator """A dashboard.""" Dashboard """A saved view profile.""" Profile """A report.""" Report """An online form.""" OnlineForm """An Automatizer process.""" Process """An email sequence.""" EmailSequence } """ A width x height extent, without a position. Units are the consumer's (the Solution canvas stores node sizes in pixels). """ type Size { """ Horizontal extent, in the units of the layout that uses it (pixels for Solution canvas nodes). """ width: Int! """ Vertical extent, in the units of the layout that uses it (pixels for Solution canvas nodes). """ height: Int! } """A point on a canvas/grid, in integer grid units.""" type Position { """Horizontal position from the left edge.""" x: Int! """Vertical position from the top edge.""" y: Int! } """ The grouped "Entity Settings" node: custom fields, custom entity and sales processes of one entity. """ type SolutionEntityNode implements SolutionNodeInterface { """Unique identifier of this node within the canvas.""" id: ID! """Node position on the canvas.""" position: Position! """ Node size in pixels, set when the user resizes the node on the canvas. Null means the default size. """ size: Size """Group this node belongs to, if any.""" groupId: ID """Custom name for the node, if the user has set one.""" name: String """Whether the node was added manually or by the auto-add scan engine.""" origin: SolutionNodeOrigin! """Entity this settings node represents.""" entityName: EntityNameEnum! """API name of the custom entity, when the entity is a custom entity.""" entityApiName: String """Referenced custom fields, each with the canvas nodes using it.""" fieldIds: [SolutionEntityFieldRef!]! """Referenced lead process ids.""" leadProcessIds: [ID!]! """Referenced pipeline ids.""" pipelineIds: [ID!]! """Referenced quote process ids.""" quoteProcessIds: [ID!]! } """ A custom field shown on an entity-settings node, together with the canvas nodes whose configuration uses it. """ type SolutionEntityFieldRef { """Id of the referenced custom field.""" id: ID! """ Ids of the canvas nodes whose configuration uses this field. Updated when the canvas is scanned. """ nodeIds: [ID!]! } """ Definition of an automation process: what starts it and the tree of conditions and actions it runs. """ type ProcessSchema { """Timezone used to evaluate the process's scheduled steps.""" timezone: String """What starts the process — a record event, schedule, or manual launch.""" trigger: ProcessTrigger! """Ordered tree of process steps (conditions and actions).""" nodes: [ProcessNodeInterface!]! } """ What starts an automation process: a change of a record, a schedule, a manual start or an online form submission. """ union ProcessTrigger = ProcessRecordTrigger | ProcessScheduleTrigger | ProcessManualTrigger | ProcessOnlineFormTrigger """Trigger that starts a process when an online form is submitted.""" type ProcessOnlineFormTrigger { """ Type of record whose changes start this process, such as Lead, Opportunity, Account or Contact. """ entityType: EntityNameEnum! """ API name of the custom entity that starts this process. Set only when the trigger entity type is a custom entity. """ entityApiName: String """ Type of record the online form submission creates, such as Lead or Contact. """ recordType: EntityNameEnum! """ API name of the custom entity the online form submission creates. Set only when the created record type is a custom entity. """ recordApiName: String """Online form types whose submissions start this process.""" onlineForms: [UUID!]! } """Trigger that lets users start a process manually on a record.""" type ProcessManualTrigger implements ProcessActorInterface { """ Which users are allowed to start the process: the process owner, selected users and sales units, any user, or applications only. """ actor: ProcessRecordTriggerActorEnum! """ Sales units whose members are allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUnits: [UUID!]! """ Individual users allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUsers: [UUID!]! """ Type of record whose changes start this process, such as Lead, Opportunity, Account or Contact. """ entityType: EntityNameEnum! """ API name of the custom entity that starts this process. Set only when the trigger entity type is a custom entity. """ entityApiName: String } """ Trigger that starts a process on a schedule for the records of an entity. """ type ProcessScheduleTrigger implements ScheduleInterface { """ Date and time the schedule runs once. Set for a one-time schedule; left empty for recurring schedules that use the time-of-day and day fields instead. """ date: DateTime """ Time of day a recurring schedule runs, in minutes after midnight (0 to 1439). """ timeOfDay: Int """Weekdays a weekly schedule runs on, from 1 (Monday) to 7 (Sunday).""" dayOfWeek: [Int!] """Days of the month a monthly schedule runs on, from 1 to 31.""" dayOfMonth: [Int!] """ Type of record whose changes start this process, such as Lead, Opportunity, Account or Contact. """ entityType: EntityNameEnum! """ API name of the custom entity that starts this process. Set only when the trigger entity type is a custom entity. """ entityApiName: String } """ Trigger that starts a process on a change of a record, such as its creation, update or deletion. """ type ProcessRecordTrigger implements ProcessActorInterface { """ Which users are allowed to start the process: the process owner, selected users and sales units, any user, or applications only. """ actor: ProcessRecordTriggerActorEnum! """ Sales units whose members are allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUnits: [UUID!]! """ Individual users allowed to start the process. Applies when the actor is restricted to selected units and users. """ actorUsers: [UUID!]! """ Type of record whose changes start this process, such as Lead, Opportunity, Account or Contact. """ entityType: EntityNameEnum! """ API name of the custom entity that starts this process. Set only when the trigger entity type is a custom entity. """ entityApiName: String """ Record change that starts the process: record created, updated, created or updated, deleted, or an email sent or received. """ event: ProcessRecordTriggerEventEnum! """ Fields whose change starts the process. When empty, a change to any field qualifies. Applies to the update event. """ changedFields: [UUID!] """ Applications whose actions are allowed to start the process. When empty, no application restriction is applied. """ applications: [UUID!] """ Parent record type used when the trigger entity is a product line item, identifying whether the parent is an opportunity or a quote. """ parentEntityType: EntityNameEnum } """Record event that starts a record-triggered process.""" enum ProcessRecordTriggerEventEnum { """A record is created.""" Create """A record is created or updated.""" CreateOrUpdate """A record is updated.""" Update """A record is deleted.""" Delete """An outgoing email is sent (email-triggered processes).""" EmailSent """An incoming email is received (email-triggered processes).""" EmailReceived } """ Settings of a saved forecast: its period, breakdown dimensions, the opportunities included, quotas and the options of its list, trend and pipeline views. """ type BetterForecastSchema implements QuickFilterInterface { """ Quick-filter conditions applied on top of the forecast, letting the user narrow the included opportunities without changing the saved filter. """ quickFilter: QuickFilterTab! """Currency used for all monetary values in the forecast.""" currencyId: UUID! """Time granularity of the forecast — Monthly, Quarterly or Yearly.""" period: ForecastPeriodKind! """First day of the forecast period.""" startDate: Date! """Last day of the forecast period.""" endDate: Date! """ Breakdown dimension(s) the forecast is grouped by — Users, SalesUnits, Products, ProductCategories or Accounts. """ type: [ForecastType!]! """ Forecast rows — one per entity in the breakdown, with per-period values and quotas. """ items: [ForecastItem!]! """ Baseline that performance is compared against — PreviousPeriod, AveragePerformance or WeightedAveragePerformance. """ quotaComparisonType: ForecastPerformanceComparisonType! """Opportunity value field summed into the forecast.""" fieldId: ID! """Opportunity date field used to place each opportunity into a period.""" dateFieldId: ID! """ Field-condition filter selecting which opportunities feed the forecast. """ fieldFilter: FieldFilter! """Saved opportunity filter tab further scoping the forecast.""" filter: OpportunityFilterTab! """Pipeline the forecast is computed over.""" pipelineId: UUID! """Value columns shown in the forecast (prediction, open, comparison, …).""" columns: [ForecastColumn!]! """Optional field the forecast values are additionally grouped by.""" groupBy: UUID """When true, rows with no values are hidden.""" hideEmptyRows: Boolean! """Display options for the list view of the forecast.""" listViewOptions: ForecastListViewOptions! """Display options for the trend view of the forecast.""" trendViewOptions: ForecastTrendViewOptions! """Display options for the pipeline view of the forecast.""" pipelineViewOptions: ForecastPipelineViewOptions! """ When true, quotas are entered manually rather than derived from targets. """ quotaCustomMode: Boolean! """How a parent quota is split across child rows (e.g. evenly).""" quotaSplitType: OpportunityForecastQuotaSplitType! } """ Display options of a pipeline board of opportunity cards: sorting, how the cards are grouped and which details each card shows. """ type ForecastPipelineViewOptions { """Identifier of the field the records are sorted by.""" sortBy: ID! """Sort direction: Asc for ascending, Desc for descending.""" sortOrder: SortOrder! """ How opportunity cards are grouped on the pipeline board: NoGrouping, Owner, Account, Contact, Unit, or ClosingDate. """ groupBy: OpportunityGroupBy! """When true, shows the opportunity value on each card.""" showCardValue: Boolean! """When true, shows the opportunity ranking on each card.""" showCardRanking: Boolean! """When true, shows the assigned labels on each card.""" showCardLabels: Boolean! """When true, shows the opportunity velocity on each card.""" showCardVelocity: Boolean! """When true, shows the fitness indicator on each card.""" showCardFitness: Boolean! """Identifiers of additional fields to display on each card.""" showExtraFieldIds: [UUID!] } """How opportunity cards are grouped on a pipeline or archive board.""" enum OpportunityGroupBy { """Cards are not grouped.""" NoGrouping """Grouped by opportunity owner.""" Owner """Grouped by related account.""" Account """Grouped by related contact.""" Contact """Grouped by sales unit.""" Unit """Grouped by closing date.""" ClosingDate } """Display options of the trend view of a forecast.""" type ForecastTrendViewOptions { """ When true, the trend view shows cumulative running totals rather than the value for each period in isolation. """ runningTotal: Boolean! } """ Display options of the list view of a forecast: its columns and sorting. """ type ForecastListViewOptions { """ Columns shown in the forecast list view, each with its width and display options. """ columns: [GridColumnsOutput!]! """Id of the field the list view is sorted by.""" sortBy: ID! """Direction the list view is sorted in — Ascending or Descending.""" sortOrder: SortOrder! } """ Value column of a forecast, such as the open, won or predicted value, or a comparison. """ type ForecastColumn { """Id of the column.""" id: ID! """ Underlying value the column shows — Open, Won, WonOpen, Lost or Prediction. """ baseValue: ForecastBaseValueEnum! """ For open-value columns, how the value is weighted — Unweighted, Weighted, Ranked or Balanced. """ openValueType: ForecastOpenValueTypeEnum """ For comparison columns, the baseline compared against — Forecast, Quota, Prediction, PreviousPeriod or PreviousYear. """ valueComparison: ForecastValueComparisonEnum } """Opportunity value a forecast column is based on.""" enum ForecastBaseValueEnum { """Value of open opportunities.""" Open """Value of won opportunities.""" Won """Combined value of won and open opportunities.""" WonOpen """Value of lost opportunities.""" Lost """Value predicted from opportunities won before the forecast period.""" Prediction } """How the value of open opportunities is weighted in a forecast column.""" enum ForecastOpenValueTypeEnum { """Full opportunity value.""" Unweighted """Value multiplied by the pipeline step probability.""" Weighted """Value multiplied by the opportunity ranking.""" Ranked """Value multiplied by both the step probability and the ranking.""" Balanced } """Baseline a forecast column's value is compared against.""" enum ForecastValueComparisonEnum { """No comparison is shown.""" NoComparison """The forecast value entered for the row.""" Forecast """The quota set for the row.""" Quota """The value predicted from opportunities won before the forecast period.""" Prediction """The same value for the period of equal length immediately before.""" PreviousPeriod """The same value for the same period one year earlier.""" PreviousYear } """ Row of a forecast for one entity of the breakdown (user, sales unit, product, product category or account), with its values and quotas per period. """ type ForecastItem { """Id of this forecast row.""" id: ID! """ Id of the parent row in the breakdown hierarchy; empty for top-level rows. """ parentId: ID """ Id of the entity (user, sales unit, product, product category or account) this row represents. """ entityId: UUID! """Type of the entity this row represents.""" entityType: EntityNameEnum! """Per-period value and quota entries for this row.""" values: [ForecastItemValue!]! """Whether this row is included in forecast totals.""" isActive: Boolean! """How this row's quota is split across its child rows (e.g. evenly).""" quotaSplitType: OpportunityForecastQuotaSplitType! } """Forecast value and quota of a forecast row for one period.""" type ForecastItemValue { """First day of the period this value applies to.""" date: Date! """Forecasted or actual value for the period.""" value: Float """Quota target for the period.""" quota: Float } type Query { """Read operations for the records of every entity.""" entities: EntityRepositoryRegistry! } """ Entry point for reading records; each field holds the read operations of one entity. """ type EntityRepositoryRegistry { """Read operations for Account records.""" account: AccountRepository """Read operations for AccountDataExRelation records.""" accountDataExRelation: AccountDataExRelationRepository """Read operations for AccountKPI records.""" accountKpi: AccountKPIRepository """Read operations for AccountProductPricing records.""" accountProductPricing: AccountProductPricingRepository """Read operations for AccountRelation records.""" accountRelation: AccountRelationRepository """Read operations for AccountRelationLabel records.""" accountRelationLabel: AccountRelationLabelRepository """Read operations for AccountRelationType records.""" accountRelationType: AccountRelationTypeRepository """Read operations for AccountRole records.""" accountRole: AccountRoleRepository """Read operations for AccountSharingClientRelation records.""" accountSharingClientRelation: AccountSharingClientRelationRepository """Read operations for AccountSharingSalesUnitRelation records.""" accountSharingSalesUnitRelation: AccountSharingSalesUnitRelationRepository """Read operations for AccountSocialRelation records.""" accountSocialRelation: AccountSocialRelationRepository """Read operations for AccountType records.""" accountType: AccountTypeRepository """Read operations for Activity records.""" activity: ActivityRepository """Read operations for ActivityComment records.""" activityComment: ActivityCommentRepository """Read operations for ActivityDataExRelation records.""" activityDataExRelation: ActivityDataExRelationRepository """Read operations for ActivityKPI records.""" activityKpi: ActivityKPIRepository """Read operations for ActivityRelation records.""" activityRelation: ActivityRelationRepository """Read operations for AllowedAccountType records.""" allowedAccountType: AllowedAccountTypeRepository """Read operations for AllowedAppointmentType records.""" allowedAppointmentType: AllowedAppointmentTypeRepository """Read operations for AllowedCompanyEmail records.""" allowedCompanyEmail: AllowedCompanyEmailRepository """Read operations for AllowedCompanyPhone records.""" allowedCompanyPhone: AllowedCompanyPhoneRepository """Read operations for AllowedContactType records.""" allowedContactType: AllowedContactTypeRepository """Read operations for AllowedLeadType records.""" allowedLeadType: AllowedLeadTypeRepository """Read operations for AllowedPipeline records.""" allowedPipeline: AllowedPipelineRepository """Read operations for AllowedQuoteType records.""" allowedQuoteType: AllowedQuoteTypeRepository """Read operations for AllowedTaskType records.""" allowedTaskType: AllowedTaskTypeRepository """Read operations for ApiAccess records.""" apiAccess: ApiAccessRepository """Read operations for Application records.""" application: ApplicationRepository """Read operations for Appointment records.""" appointment: AppointmentRepository """Read operations for AppointmentClientInviteesRelation records.""" appointmentClientInviteesRelation: AppointmentClientInviteesRelationRepository """Read operations for AppointmentContactInviteesRelation records.""" appointmentContactInviteesRelation: AppointmentContactInviteesRelationRepository """Read operations for AppointmentReminder records.""" appointmentReminder: AppointmentReminderRepository """Read operations for AppointmentSchedule records.""" appointmentSchedule: AppointmentScheduleRepository """Read operations for AppointmentType records.""" appointmentType: AppointmentTypeRepository """Read operations for Approval records.""" approval: ApprovalRepository """Read operations for ApprovalApprover records.""" approvalApprover: ApprovalApproverRepository """Read operations for ApprovalProcess records.""" approvalProcess: ApprovalProcessRepository """Read operations for ApprovalProcessActivityLogLine records.""" approvalProcessActivityLogLine: ApprovalProcessActivityLogLineRepository """Read operations for Call records.""" call: CallRepository """Read operations for ChatConversation records.""" chatConversation: ChatConversationRepository """Read operations for Client records.""" client: ClientRepository """Read operations for ClientExcludedOppty records.""" clientExcludedOppty: ClientExcludedOpptyRepository """Read operations for ClientFavorite records.""" clientFavorite: ClientFavoriteRepository """Read operations for ClientSetting records.""" clientSetting: ClientSettingRepository """Read operations for ClientStoryRead records.""" clientStoryRead: ClientStoryReadRepository """Read operations for CloudObject records.""" cloudObject: CloudObjectRepository """Read operations for CloudObjectFolder records.""" cloudObjectFolder: CloudObjectFolderRepository """Read operations for CloudObjectRelation records.""" cloudObjectRelation: CloudObjectRelationRepository """Read operations for CloudObjectStepRelation records.""" cloudObjectStepRelation: CloudObjectStepRelationRepository """Read operations for CloudObjectTemplate records.""" cloudObjectTemplate: CloudObjectTemplateRepository """Read operations for CompanyEmail records.""" companyEmail: CompanyEmailRepository """Read operations for Contact records.""" contact: ContactRepository """Read operations for ContactAccountAccountRoleRelation records.""" contactAccountAccountRoleRelation: ContactAccountAccountRoleRelationRepository """Read operations for ContactAccountRelation records.""" contactAccountRelation: ContactAccountRelationRepository """Read operations for ContactDataExRelation records.""" contactDataExRelation: ContactDataExRelationRepository """Read operations for ContactKPI records.""" contactKpi: ContactKPIRepository """Read operations for ContactRelation records.""" contactRelation: ContactRelationRepository """Read operations for ContactRelationLabel records.""" contactRelationLabel: ContactRelationLabelRepository """Read operations for ContactRelationType records.""" contactRelationType: ContactRelationTypeRepository """Read operations for ContactSharingClientRelation records.""" contactSharingClientRelation: ContactSharingClientRelationRepository """Read operations for ContactSharingSalesUnitRelation records.""" contactSharingSalesUnitRelation: ContactSharingSalesUnitRelationRepository """Read operations for ContactSocialRelation records.""" contactSocialRelation: ContactSocialRelationRepository """Read operations for ContactType records.""" contactType: ContactTypeRepository """Read operations for CountryCrm records.""" countryCrm: CountryCrmRepository """Read operations for Currency records.""" currency: CurrencyRepository """Read operations for CurrencyExchangeRate records.""" currencyExchangeRate: CurrencyExchangeRateRepository """Read operations for CurrencyExchangeRatesList records.""" currencyExchangeRatesList: CurrencyExchangeRatesListRepository """Read operations for CustomEntity records.""" customEntity( """Name of custom entity type to use.""" entityApiName: String! ): CustomEntityRepository """Read operations for CustomEntityDataExRelation records.""" customEntityDataExRelation: CustomEntityDataExRelationRepository """Read operations for CustomEntityRelation records.""" customEntityRelation: CustomEntityRelationRepository """Read operations for CustomEntityRelationData records.""" customEntityRelationData: CustomEntityRelationDataRepository """Read operations for CustomEntitySharingClientRelation records.""" customEntitySharingClientRelation: CustomEntitySharingClientRelationRepository """Read operations for CustomEntitySharingSalesUnitRelation records.""" customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationRepository """Read operations for CustomEntityType records.""" customEntityType( """Name of custom entity type to use.""" entityApiName: String ): CustomEntityTypeRepository """Read operations for Data records.""" data: DataRepository """Read operations for Email records.""" email: EmailRepository """Read operations for EmailContentSharingClientRelation records.""" emailContentSharingClientRelation: EmailContentSharingClientRelationRepository """Read operations for EmailContentSharingSalesUnitRelation records.""" emailContentSharingSalesUnitRelation: EmailContentSharingSalesUnitRelationRepository """Read operations for EmailEvent records.""" emailEvent: EmailEventRepository """Read operations for EmailLabel records.""" emailLabel: EmailLabelRepository """Read operations for EmailLabelRelation records.""" emailLabelRelation: EmailLabelRelationRepository """Read operations for EmailMailboxRelation records.""" emailMailboxRelation: EmailMailboxRelationRepository """Read operations for EmailSequence records.""" emailSequence: EmailSequenceRepository """Read operations for EmailSequenceActivityLog records.""" emailSequenceActivityLog: EmailSequenceActivityLogRepository """Read operations for EmailSequenceActivityLogLine records.""" emailSequenceActivityLogLine: EmailSequenceActivityLogLineRepository """Read operations for EmailSequenceEnrolled records.""" emailSequenceEnrolled: EmailSequenceEnrolledRepository """Read operations for EmailTemplate records.""" emailTemplate: EmailTemplateRepository """Read operations for EmailTemplateFolder records.""" emailTemplateFolder: EmailTemplateFolderRepository """Read operations for EmailTemplateSharingClientRelation records.""" emailTemplateSharingClientRelation: EmailTemplateSharingClientRelationRepository """Read operations for EmailTemplateSharingSalesUnitRelation records.""" emailTemplateSharingSalesUnitRelation: EmailTemplateSharingSalesUnitRelationRepository """Read operations for EmailThreadMailboxClientReadState records.""" emailThreadMailboxClientReadState: EmailThreadMailboxClientReadStateRepository """Read operations for Entity records.""" entity: EntityRepository """Read operations for EntityFitness records.""" entityFitness: EntityFitnessRepository """Read operations for EntityFitnessIndicator records.""" entityFitnessIndicator: EntityFitnessIndicatorRepository """Read operations for EntityHealth records.""" entityHealth: EntityHealthRepository """Read operations for EntityScoring records.""" entityScoring: EntityScoringRepository """Read operations for EntitySettings records.""" entitySettings: EntitySettingsRepository """Read operations for Field records.""" field: FieldRepository """Read operations for FieldMapping records.""" fieldMapping: FieldMappingRepository """Read operations for FieldPermission records.""" fieldPermission: FieldPermissionRepository """Read operations for FieldSequence records.""" fieldSequence: FieldSequenceRepository """Read operations for Forecast records.""" forecast: ForecastRepository """Read operations for FormView records.""" formView: FormViewRepository """Read operations for FormViewSharingClientRelation records.""" formViewSharingClientRelation: FormViewSharingClientRelationRepository """Read operations for FormViewSharingSalesUnitRelation records.""" formViewSharingSalesUnitRelation: FormViewSharingSalesUnitRelationRepository """Read operations for GhostContact records.""" ghostContact: GhostContactRepository """Read operations for GhostContactAccountAccountRoleRelation records.""" ghostContactAccountAccountRoleRelation: GhostContactAccountAccountRoleRelationRepository """Read operations for GhostContactAccountRelation records.""" ghostContactAccountRelation: GhostContactAccountRelationRepository """Read operations for GhostLeadOpptyContactRelation records.""" ghostLeadOpptyContactRelation: GhostLeadOpptyContactRelationRepository """Read operations for GhostLeadOpptyContactSalesRoleRelation records.""" ghostLeadOpptyContactSalesRoleRelation: GhostLeadOpptyContactSalesRoleRelationRepository """Read operations for ImportMappingMask records.""" importMappingMask: ImportMappingMaskRepository """Read operations for InterfacePreview records.""" interfacePreview: InterfacePreviewRepository """Read operations for Lead records.""" lead: LeadRepository """Read operations for LeadOppty records.""" leadOppty: LeadOpptyRepository """Read operations for LeadOpptyAccountRelation records.""" leadOpptyAccountRelation: LeadOpptyAccountRelationRepository """Read operations for LeadOpptyContactGroupRelation records.""" leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationRepository """Read operations for LeadOpptyContactRelation records.""" leadOpptyContactRelation: LeadOpptyContactRelationRepository """Read operations for LeadOpptyContactSalesRoleRelation records.""" leadOpptyContactSalesRoleRelation: LeadOpptyContactSalesRoleRelationRepository """Read operations for LeadOpptyDataExRelation records.""" leadOpptyDataExRelation: LeadOpptyDataExRelationRepository """Read operations for LeadOpptyKPI records.""" leadOpptyKpi: LeadOpptyKPIRepository """Read operations for LeadOpptySharingClientRelation records.""" leadOpptySharingClientRelation: LeadOpptySharingClientRelationRepository """Read operations for LeadOpptySharingSalesUnitRelation records.""" leadOpptySharingSalesUnitRelation: LeadOpptySharingSalesUnitRelationRepository """Read operations for LeadOpptyStepCheckListRelation records.""" leadOpptyStepCheckListRelation: LeadOpptyStepCheckListRelationRepository """Read operations for LeadProcess records.""" leadProcess: LeadProcessRepository """Read operations for LeadType records.""" leadType: LeadTypeRepository """Read operations for MasterRight records.""" masterRight: MasterRightRepository """Read operations for Media records.""" media: MediaRepository """Read operations for Memo records.""" memo: MemoRepository """Read operations for MemoComment records.""" memoComment: MemoCommentRepository """Read operations for MessageRelation records.""" messageRelation: MessageRelationRepository """Read operations for MessageSharingClientRelation records.""" messageSharingClientRelation: MessageSharingClientRelationRepository """Read operations for MessageSharingSalesUnitRelation records.""" messageSharingSalesUnitRelation: MessageSharingSalesUnitRelationRepository """Read operations for Note records.""" note: NoteRepository """Read operations for OnlineForm records.""" onlineForm: OnlineFormRepository """Read operations for OnlineFormActivityLogLine records.""" onlineFormActivityLogLine: OnlineFormActivityLogLineRepository """Read operations for OnlineFormDataExRelation records.""" onlineFormDataExRelation: OnlineFormDataExRelationRepository """Read operations for OnlineFormRelation records.""" onlineFormRelation: OnlineFormRelationRepository """Read operations for OnlineFormStyle records.""" onlineFormStyle: OnlineFormStyleRepository """Read operations for OnlineFormType records.""" onlineFormType: OnlineFormTypeRepository """Read operations for OnlineFormTypeEmailRelation records.""" onlineFormTypeEmailRelation: OnlineFormTypeEmailRelationRepository """Read operations for Opportunity records.""" opportunity: OpportunityRepository """Read operations for OpportunityType records.""" opportunityType: OpportunityTypeRepository """Read operations for OpptyProductRelation records.""" opptyProductRelation: OpptyProductRelationRepository """Read operations for OpptyProductRelationDataExRelation records.""" opptyProductRelationDataExRelation: OpptyProductRelationDataExRelationRepository """Read operations for OpptyProductRelationRevenueSchedule records.""" opptyProductRelationRevenueSchedule: OpptyProductRelationRevenueScheduleRepository """Read operations for OpptyProductRelationRevenueSchedulePeriod records.""" opptyProductRelationRevenueSchedulePeriod: OpptyProductRelationRevenueSchedulePeriodRepository """Read operations for OpptyProductRelationType records.""" opptyProductRelationType: OpptyProductRelationTypeRepository """Read operations for OpptyRecurrence records.""" opptyRecurrence: OpptyRecurrenceRepository """Read operations for OpptyRevenueSchedule records.""" opptyRevenueSchedule: OpptyRevenueScheduleRepository """Read operations for OpptyRevenueSchedulePeriod records.""" opptyRevenueSchedulePeriod: OpptyRevenueSchedulePeriodRepository """Read operations for ParentAccountRelationType records.""" parentAccountRelationType: ParentAccountRelationTypeRepository """Read operations for Phone records.""" phone: PhoneRepository """Read operations for Pipeline records.""" pipeline: PipelineRepository """Read operations for Process records.""" process: ProcessRepository """Read operations for ProcessActivityLog records.""" processActivityLog: ProcessActivityLogRepository """Read operations for ProcessActivityLogLine records.""" processActivityLogLine: ProcessActivityLogLineRepository """Read operations for ProcessScheduledAction records.""" processScheduledAction: ProcessScheduledActionRepository """Read operations for ProcessTemplate records.""" processTemplate: ProcessTemplateRepository """Read operations for Product records.""" product: ProductRepository """Read operations for ProductCategory records.""" productCategory: ProductCategoryRepository """Read operations for ProductDataExRelation records.""" productDataExRelation: ProductDataExRelationRepository """Read operations for ProductPipelineRelation records.""" productPipelineRelation: ProductPipelineRelationRepository """Read operations for ProductPriceList records.""" productPriceList: ProductPriceListRepository """Read operations for ProductPriceListPrice records.""" productPriceListPrice: ProductPriceListPriceRepository """Read operations for ProductType records.""" productType: ProductTypeRepository """Read operations for Profile records.""" profile: ProfileRepository """Read operations for ProfileRelation records.""" profileRelation: ProfileRelationRepository """Read operations for ProfileSharingClientRelation records.""" profileSharingClientRelation: ProfileSharingClientRelationRepository """Read operations for ProfileSharingSalesUnitRelation records.""" profileSharingSalesUnitRelation: ProfileSharingSalesUnitRelationRepository """Read operations for Project records.""" project: ProjectRepository """Read operations for ProjectContactRelation records.""" projectContactRelation: ProjectContactRelationRepository """Read operations for ProjectDataExRelation records.""" projectDataExRelation: ProjectDataExRelationRepository """Read operations for ProjectKPI records.""" projectKpi: ProjectKPIRepository """Read operations for ProjectObjective records.""" projectObjective: ProjectObjectiveRepository """Read operations for ProjectSharingClientRelation records.""" projectSharingClientRelation: ProjectSharingClientRelationRepository """Read operations for ProjectSharingSalesUnitRelation records.""" projectSharingSalesUnitRelation: ProjectSharingSalesUnitRelationRepository """Read operations for ProjectType records.""" projectType: ProjectTypeRepository """Read operations for Quote records.""" quote: QuoteRepository """Read operations for QuoteAccountRelation records.""" quoteAccountRelation: QuoteAccountRelationRepository """Read operations for QuoteContactRelation records.""" quoteContactRelation: QuoteContactRelationRepository """Read operations for QuoteDataExRelation records.""" quoteDataExRelation: QuoteDataExRelationRepository """Read operations for QuoteKPI records.""" quoteKpi: QuoteKPIRepository """Read operations for QuoteProcess records.""" quoteProcess: QuoteProcessRepository """Read operations for QuoteSharingClientRelation records.""" quoteSharingClientRelation: QuoteSharingClientRelationRepository """Read operations for QuoteSharingSalesUnitRelation records.""" quoteSharingSalesUnitRelation: QuoteSharingSalesUnitRelationRepository """Read operations for QuoteType records.""" quoteType: QuoteTypeRepository """Read operations for Report records.""" report: ReportRepository """Read operations for ReportFolder records.""" reportFolder: ReportFolderRepository """Read operations for ReportSchedule records.""" reportSchedule: ReportScheduleRepository """Read operations for ReportSharingClientRelation records.""" reportSharingClientRelation: ReportSharingClientRelationRepository """Read operations for ReportSharingSalesUnitRelation records.""" reportSharingSalesUnitRelation: ReportSharingSalesUnitRelationRepository """Read operations for SalesRole records.""" salesRole: SalesRoleRepository """Read operations for SalesUnit records.""" salesUnit: SalesUnitRepository """Read operations for SalesUnitClientRelation records.""" salesUnitClientRelation: SalesUnitClientRelationRepository """Read operations for Solution records.""" solution: SolutionRepository """Read operations for SolutionTemplate records.""" solutionTemplate: SolutionTemplateRepository """Read operations for Step records.""" step: StepRepository """Read operations for StepChecklist records.""" stepChecklist: StepChecklistRepository """Read operations for StepChecklistSalesRoleRelation records.""" stepChecklistSalesRoleRelation: StepChecklistSalesRoleRelationRepository """Read operations for Tag records.""" tag: TagRepository """Read operations for TagRelation records.""" tagRelation: TagRelationRepository """Read operations for Target records.""" target: TargetRepository """Read operations for TargetRelation records.""" targetRelation: TargetRelationRepository """Read operations for Task records.""" task: TaskRepository """Read operations for TaskRecurrence records.""" taskRecurrence: TaskRecurrenceRepository """Read operations for TaskReminder records.""" taskReminder: TaskReminderRepository """Read operations for TaskSharingClientRelation records.""" taskSharingClientRelation: TaskSharingClientRelationRepository """Read operations for TaskSharingSalesUnitRelation records.""" taskSharingSalesUnitRelation: TaskSharingSalesUnitRelationRepository """Read operations for TaskType records.""" taskType: TaskTypeRepository """Read operations for TextMessage records.""" textMessage: TextMessageRepository """Read operations for TextMessageConversation records.""" textMessageConversation: TextMessageConversationRepository """Read operations for TextMessageConversationRelations records.""" textMessageConversationRelations: TextMessageConversationRelationsRepository """Read operations for Timeframe records.""" timeframe: TimeframeRepository """Read operations for Translation records.""" translation: TranslationRepository """Read operations for Type records.""" type: TypeRepository """Read operations for UnsubscribedPhone records.""" unsubscribedPhone: UnsubscribedPhoneRepository """Read operations for Webhook records.""" webhook: WebhookRepository """Read operations for WebhookEvent records.""" webhookEvent: WebhookEventRepository """Read operations for Webresource records.""" webresource: WebresourceRepository } """Read operations for Account records.""" type AccountRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountFilterInput """Sorting of the returned records.""" orderBy: [AccountOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountFilterInput """Sorting of the returned records.""" orderBy: [AccountOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns the accounts that can be set as the parent of the given account, which excludes the account itself and all its child accounts at any level. """ getEligibleParents( """Id of the account a parent is being chosen for.""" accountId: UUID! """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountFilterInput """Sorting of the returned records.""" orderBy: [AccountOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountEntity!]! """Returns the accounts linked to the given contact.""" getRelatedToContact( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountFilterInput """Sorting of the returned records.""" orderBy: [AccountOrderByInput!] """ Id of the contact; when omitted, accounts are not limited to one contact. """ contactId: UUID ): [AccountEntity!]! """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): AccountEntity! """ Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. """ aiAutoPrefill( """ Id of the suggested action, as returned by the AI record suggestions or AI chat. """ actionId: String! ): AccountAutoPrefill! } """ Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. """ type AccountEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. """ accountType: AccountTypeEntity """ Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. """ customerType: DataEntity """Industry the account operates in. Configurable per team space.""" industry: DataEntity """Sales user who owns this account.""" owner: ClientEntity """Parent account in a corporate hierarchy. Empty for top-level accounts.""" parentAccount: AccountEntity """ Type of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set. """ parentAccountRelationType: ParentAccountRelationTypeEntity """Profile picture or company logo associated with the account.""" picture: CloudObjectEntity """ Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """ Manual classification grade assigned to the account. Used in segmentation and reporting. """ accountClass: AccountClassEnum """Id of the account type assigned to this account.""" accountTypeId: ID """Street address of the account.""" address: String """City of the account address.""" city: String """Free-form notes describing the account.""" comments: String """Country of the account address.""" country: String """Id of the currency exchange rate list applied to this account.""" currencyExchangeRatesListId: ID """ Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. """ customerTypeId: ID """ Primary email address of the account. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """ Coarser bucket of healthStatus used for grouping and reporting. Read-only. """ healthCategory: ID """ Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. """ healthStatus: Int """ Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. """ homePage: String """Id of the industry classification.""" industryId: ID """ True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ Time when an AI-suggested account hierarchy was last applied to this account. """ lastAiAccountHierarchyApplied: DateTime """Time when an AI-suggested org chart was last applied to this account.""" lastAiOrgChartApplied: DateTime """Name of the entity and its default text representation.""" name: String! """Id of the account owner.""" ownerId: ID! """ Id of the parent account in the corporate hierarchy. Empty for top-level accounts. """ parentAccountId: ID """Id of the parent-account relationship type.""" parentAccountRelationTypeId: ID """ Primary phone number of the account. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """ Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. """ quickParentAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the account address.""" stateProvince: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the account address.""" zipCode: String """Revision when entity was lastly changed.""" revision: Int """Display version of the account name, used in lists and references.""" formattedName: String! """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int! """ Social network profiles linked to this account (e.g. LinkedIn, Facebook). """ socialMedia: AccountSocialRelationEntity """ Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter AccountSharingSalesUnitRelation relations by edge (relation) AccountSharingSalesUnitRelation attributes. """ filterEdge: AccountSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountSharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this account. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter AccountSharingClientRelation relations by edge (relation) AccountSharingClientRelation attributes. """ filterEdge: AccountSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountSharingClientRelationEntityConnection """Documents linked to this account.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ True when the current authenticated user has marked this account as favorite. Per-user. """ isFavorite: Boolean! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this account.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Saved view profiles this account currently matches.""" staticProfiles( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ProfileRelation relations by edge (relation) ProfileRelation attributes. """ filterEdge: ProfileRelationFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """ Composite entity-health summary, combining current and previous state with last-calculation metadata. Read-only; computed by Coevera. """ health: EntityHealthResult """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """ Approval request of this record that is pending or was rejected; null when there is none or it was approved. """ approval: ApprovalEntity } """ Configurable category of accounts that defines the form layout and settings used for accounts of that type. """ type AccountTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ True when the account type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """ Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. This payload conforms to the `EntityTypeSettings` JSON Schema: GET /api/v100/rest/schemas/EntityTypeSettings.json on your region's API host """ settings: EntityTypeSettings! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Action a user can perform on a record; instancePermissions returns the ones the current user holds on a given record. """ enum EntityPermsEnum { """Allows creating records of this type.""" Create """Allows viewing the record.""" Read """Allows editing the record.""" Write """Allows deleting the record.""" Delete """Allows changing the owner of the record.""" Ownership """Allows qualifying the lead into an opportunity.""" Qualify """Allows turning the opportunity back into a lead.""" BackToLead """Allows archiving the account, contact, lead, opportunity or quote.""" Archive """ Allows reactivating an archived account, contact, lead, opportunity or quote, or a completed or inactive target. """ Reactivate """ Allows giving up ownership of the lead or task so that it becomes unassigned. """ Release """Allows restoring the deleted record.""" Restore """ Allows the current user, as an invitee, to respond to the appointment invitation. """ Invitee """Allows moving the lead, opportunity or quote to a different step.""" Move """Allows creating a copy of the record.""" Copy """Allows moving the opportunity to a different pipeline.""" ChangePipeline """Allows moving the lead to a different lead process.""" ChangeLeadProcess """Allows moving the quote to a different quote process.""" ChangeQuoteProcess """Allows placing a call from the record through the calling integration.""" Call """Legacy value; no longer used.""" UnitMembership """Legacy value; no longer used.""" UserAndRoles """ Allows administrative operations reserved for administrative API accounts. """ ApiAdmin """Allows managing the documents attached to the pipeline step.""" StepDocuments """Allows merging duplicate records into this record.""" Merge """Allows taking ownership of the unassigned lead or task.""" Take """Legacy value; no longer used.""" AdminSetAutomationHub """Legacy value; no longer used.""" AdminAutomationHub """Allows marking the project or target as completed.""" Complete """Allows reopening the completed project.""" Reopen """ Allows transferring or deleting the reports, profiles, form views, email templates and import templates of the deactivated user. """ ManageUserData """ Allows reading the parts of the email template needed to use it, for example in a process or email sequence, without full read access. """ ReadCopy """Allows reading the body of the email.""" ContentRead """Allows changing who can read the body of the email.""" ContentOwnership """ Allows the current user, as a pending approver, to approve or reject the approval request. """ RespondToApproval """ Allows the current user, as a pending approver, to delegate the approval request to another user. """ DelegateApproval """Allows resubmitting a rejected approval request.""" ResubmitApproval """Allows cancelling the approval request.""" CancelApproval """ Allows reassigning the user seat to a different person by email address. """ ReassignClient """Allows resetting the password of the user.""" ResetPasswordClient } """ Set of exchange rates, one per currency, that applies from a given date until the next list takes effect. """ type CurrencyExchangeRatesListEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set. """ validFrom: DateTime! """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured in this list — one row per non-base currency in the space. """ currencyExchangeRates( """Filter Currency relations by target Currency attributes.""" filter: CurrencyFilterInput """ Filter CurrencyExchangeRate relations by edge (relation) CurrencyExchangeRate attributes. """ filterEdge: CurrencyExchangeRateFilterInput """Order Currency relations by target Currency attributes.""" orderBy: [CurrencyOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CurrencyExchangeRateEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of CurrencyExchangeRate records.""" type CurrencyExchangeRateEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CurrencyExchangeRateEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ The Relay compliant `PageInfo` type, containing data necessary to paginate this connection. """ type PageInfo { """When paginating forwards, are there more items?""" hasNextPage: Boolean! """When paginating backwards, are there more items?""" hasPreviousPage: Boolean! """When paginating backwards, the cursor to continue.""" startCursor: String """When paginating forwards, the cursor to continue.""" endCursor: String } """A Relay edge containing a `CurrencyExchangeRateEntity` and its cursor.""" type CurrencyExchangeRateEntityEdge { """The item at the end of the edge""" node: CurrencyExchangeRateEntity """A cursor for use in pagination""" cursor: String! } """ Exchange rate of a currency against the base currency within an exchange rate list. """ type CurrencyExchangeRateEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Effective period (exchange rate list) this rate belongs to.""" currencyExchangeRateList: CurrencyExchangeRatesListEntity """Currency the exchange rate applies to. Cannot be the base currency.""" currency: CurrencyEntity """Id of the exchange rate list (effective period) this rate belongs to.""" currencyExchangeRateListId: ID! """ Id of the currency the exchange rate applies to. Cannot be the base currency. """ currencyId: ID! """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: Float """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Currency used for monetary values in the space, converted from the base currency by exchange rates. """ type CurrencyEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" code: String! """ True for the space's base currency. There is exactly one base currency per space and it cannot be deleted. """ isBase: Boolean """ Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI. """ symbol: String """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured for this currency, one per exchange rate list (effective period). """ currencyExchangeRates( """ Filter CurrencyExchangeRatesList relations by target CurrencyExchangeRatesList attributes. """ filter: CurrencyExchangeRatesListFilterInput """ Filter CurrencyExchangeRate relations by edge (relation) CurrencyExchangeRate attributes. """ filterEdge: CurrencyExchangeRateFilterInput """ Order CurrencyExchangeRatesList relations by target CurrencyExchangeRatesList attributes. """ orderBy: [CurrencyExchangeRatesListOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CurrencyExchangeRateEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for CurrencyExchangeRatesList records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CurrencyExchangeRatesListFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CurrencyExchangeRatesListFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CurrencyExchangeRatesListFilterInput!] """Matches records that do not meet this filter.""" NOT: CurrencyExchangeRatesListFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set. """ validFrom: EntityFilterDateTimeField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Exchange rates configured in this list — one row per non-base currency in the space. Matches records where a related record meets these conditions. """ currencyExchangeRates: CurrencyExchangeRateFilterInput } """ Conditions on a text or identifier field. Several conditions given together must all match. """ input EntityFilterStringField { """ Exact match (case sensitive). Multiple values in list are evaluated as OR. """ eq: [String] """ True matches records where the field has no value; false matches records where it has one. """ null: Boolean """ Exact match (case insensitive). Multiple values in list are evaluated as OR. """ ieq: [String] """ True matches records where the text is missing or an empty string; false matches records with a non-empty text. """ empty: Boolean """ Compare against left side of string (case sensitive). Multiple values in list are evaluated as OR. """ starts: [String] """ Compare against right side of string (case sensitive). Multiple values in list are evaluated as OR. """ ends: [String] """ Substring match (case sensitive). Multiple values in list are evaluated as OR. """ contains: [String] """ Compare against left side of string (case insensitive). Multiple values in list are evaluated as OR. """ istarts: [String] """ Compare against right side of string (case insensitive). Multiple values in list are evaluated as OR. """ iends: [String] """ Substring match (case insensitive). Multiple values in list are evaluated as OR. """ icontains: [String] } """ Conditions on a date and time field. Several conditions given together must all match. """ input EntityFilterDateTimeField { """ Exact match (case sensitive). Multiple values in list are evaluated as OR. """ eq: [String] """ True matches records where the field has no value; false matches records where it has one. """ null: Boolean """Matches values before this moment.""" lt: DateTime """Matches values before or equal to this moment.""" lte: DateTime """Matches values after this moment.""" gt: DateTime """Matches values after or equal to this moment.""" gte: DateTime """ Exactly two values, start and end. Matches values in this range, including both ends. """ between: [DateTime] } """ Conditions on a numeric field. Several conditions given together must all match. """ input EntityFilterNumberField { """ Exact match (case sensitive). Multiple values in list are evaluated as OR. """ eq: [String] """ True matches records where the field has no value; false matches records where it has one. """ null: Boolean """Matches values lower than this number.""" lt: Float """Matches values lower than or equal to this number.""" lte: Float """Matches values greater than this number.""" gt: Float """Matches values greater than or equal to this number.""" gte: Float """ Exactly two values, lower and upper bound. Matches values in this range, including both bounds. """ between: [Float] } """ Filter conditions for CurrencyExchangeRate records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CurrencyExchangeRateFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CurrencyExchangeRateFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CurrencyExchangeRateFilterInput!] """Matches records that do not meet this filter.""" NOT: CurrencyExchangeRateFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the exchange rate list (effective period) this rate belongs to.""" currencyExchangeRateListId: EntityFilterStringField """ Id of the currency the exchange rate applies to. Cannot be the base currency. """ currencyId: EntityFilterStringField """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Effective period (exchange rate list) this rate belongs to. Matches records where a related record meets these conditions. """ currencyExchangeRateList: CurrencyExchangeRatesListFilterInput """ Currency the exchange rate applies to. Cannot be the base currency. Matches records where a related record meets these conditions. """ currency: CurrencyFilterInput } """ Filter conditions for Currency records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CurrencyFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CurrencyFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CurrencyFilterInput!] """Matches records that do not meet this filter.""" NOT: CurrencyFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" code: EntityFilterStringField """ True for the space's base currency. There is exactly one base currency per space and it cannot be deleted. """ isBase: Boolean """ Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI. """ symbol: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Exchange rates configured for this currency, one per exchange rate list (effective period). Matches records where a related record meets these conditions. """ currencyExchangeRates: CurrencyExchangeRateFilterInput } """ Sorting of CurrencyExchangeRatesList records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CurrencyExchangeRatesListOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set. """ validFrom: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Direction in which results are ordered by a field.""" enum OrderByEnum { """Ascending order.""" Asc """Descending order.""" Desc } """ Sorting of Currency records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CurrencyOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" code: OrderByEnum """ True for the space's base currency. There is exactly one base currency per space and it cannot be deleted. """ isBase: OrderByEnum """ Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI. """ symbol: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Option of a dropdown or multi-select field, one of the values users can choose from. """ type DataEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available. """ allowedBy: JSONString """ Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option). """ calcValue: Float """ Identifier of the data set this option belongs to. Shared by all options of a dropdown / radio / multiselect field. """ dataSetId: ID! """Name of the entity and its default text representation.""" optionName: String! """Position of the option within its data set; lower values appear first.""" sortOrder: Int! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Map of locale codes to translated option names (e.g. {"en-US": "Hot", "de-DE": "Heiß"}). Empty when no translations are defined. """ optionNameTranslations: JSONString! """ Option name in the current user's language, taken from optionNameTranslations. Empty when no translation is available for that language. """ optionNameTranslated: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ User of the space; owns records, belongs to sales units and has a user role that determines what they can do. """ type ClientEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Default sales unit for the user. New records the user creates are assigned to this unit by default. """ defaultUnit: SalesUnitEntity """ User role assigned to the user. Determines what features and entities the user can access. """ masterRight: MasterRightEntity """Id of the default sales unit.""" defaultUnitId: ID! """Email. Readonly information from UserProfile.""" email: String! """First name. Readonly information from UserProfile.""" firstName: String """Timestamp of the user's most recent login or API request.""" lastActive: DateTime """Last name. Readonly information from UserProfile.""" lastName: String """Id of the assigned user role.""" masterRightId: ID! """Middle name. Readonly information from UserProfile.""" middleName: String """Phone number. Readonly information from UserProfile.""" phone: String """Picture name. Readonly information from UserProfile.""" pictureUrl: String """Job title or position of the user.""" position: String """Region. Readonly information from UserProfile.""" region: String """ Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead. """ timezone: String """ Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person. """ type: ClientTypeEnum """Revision when entity was lastly changed.""" revision: Int """ Id of the identity provider the user signs in with by default. Empty when none is set or it is disabled. """ defaultIdp: Int """Id of the user account (login identity) this user belongs to.""" userProfileId: Int """Sales units the user belongs to (as member or manager).""" unitMembership( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter SalesUnitClientRelation relations by edge (relation) SalesUnitClientRelation attributes. """ filterEdge: SalesUnitClientRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SalesUnitClientRelationEntityConnection """Appointments marked as favorite by the user.""" appointmentFavorite( """Filter Appointment relations by target Appointment attributes.""" filter: AppointmentFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Appointment relations by target Appointment attributes.""" orderBy: [AppointmentOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """Tasks marked as favorite by the user.""" taskFavorite( """Filter Task relations by target Task attributes.""" filter: TaskFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Task relations by target Task attributes.""" orderBy: [TaskOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """Accounts marked as favorite by the user.""" accountFavorite( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """Contacts marked as favorite by the user.""" contactFavorite( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """Screen profiles marked as favorite by the user.""" profileFavorite( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """Reports marked as favorite by the user.""" reportFavorite( """Filter Report relations by target Report attributes.""" filter: ReportFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Report relations by target Report attributes.""" orderBy: [ReportOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """Leads marked as favorite by the user.""" leadFavorite( """Filter Lead relations by target Lead attributes.""" filter: LeadFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Lead relations by target Lead attributes.""" orderBy: [LeadOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """Opportunities marked as favorite by the user.""" opportunityFavorite( """Filter Opportunity relations by target Opportunity attributes.""" filter: OpportunityFilterInput """ Filter ClientFavorite relations by edge (relation) ClientFavorite attributes. """ filterEdge: ClientFavoriteFilterInput """Order Opportunity relations by target Opportunity attributes.""" orderBy: [OpportunityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """ IANA time zone name of the user (e.g. Europe/Prague), or empty when the time zone is set automatically from the user's operating system. Read-only. """ timezoneName: String """ Display name of the user, formatted according to the user's name format preference. """ name: String """Display name of the user (alias of name).""" formattedName: String! "\nList of all managed units (with expanded managed trees, includes whole managed unit subtree).\n" unitManagerIds: [UUID!]! "\nList of all units where a client is member only, not manager.\n" unitMemberIds: [UUID!]! """ State of the user's row-level access recalculation: NoRecalculation (up to date), Pending (queued), or InProgress. """ userRecalculationState: UserRecalculationStateEnum """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Sales unit (team) in the organization hierarchy that users belong to.""" type SalesUnitEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent sales unit, when this unit is nested. Empty for the root unit.""" parent: SalesUnitEntity """Profile picture (logo) of the sales unit.""" picture: CloudObjectEntity """Name of the entity and its default text representation.""" name: String! """Id of the parent unit, or empty for the root unit.""" parentId: ID """Id of the picture cloud object.""" pictureId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ File stored in the space, such as a document, image or recording, that can be attached to records. """ type CloudObjectEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Application that produced the object (e.g. Online Forms).""" application: ApplicationEntity """ Company-level folder that contains the object, when stored in the company document tree. """ companyCloudObjectFolder: CloudObjectFolderEntity """User who uploaded the object.""" creator: ClientEntity """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String! """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """Mime-type of the cloud object Is detected from content.""" mimeType: String """ Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. """ params: JSONString """Size of the object in bytes.""" size: Int! """ Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. """ type: CloudObjectTypeEnum! """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: String """Revision when entity was lastly changed.""" revision: Int """ Width and height of the image in pixels; empty for files that are not images. """ dimensions: CloudObjectDimensions """Duration of the audio recording in seconds; empty for other files.""" duration: Float """ Publicly accessible link to the file; empty unless the file is marked as public. """ publicUrl: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Application that works with the space, such as the web or mobile app, an Automation Hub integration or an API access; changes and events are attributed to it. """ type ApplicationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Identifier of the matching Automation Hub item, or empty for user-defined applications. Set automatically by Coevera when the application is registered through the Automation Hub. """ automationHubId: Int """ True when this application can register webhooks. Set when the application is created and cannot be changed afterwards. """ isTrigger: Boolean! """ True when this application is shown in the Automation Hub UI. Hidden applications are still functional but excluded from end-user discovery. """ isVisible: Boolean! """Name of the entity and its default text representation.""" name: String! """ True when this application can act on behalf of individual users (personal triggers). Set when the application is created and cannot be changed afterwards. """ usesImpersonation: Boolean """Revision when entity was lastly changed.""" revision: Int """ Per-context flags describing when this application is offered to users (triggers, personal triggers, display, filter). Computed by Coevera. """ useOptions: ApplicationUseOption! """Is application active.""" isActive: Boolean! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Where an application can be offered in the space: for webhooks, personal triggers, display and filters. """ type ApplicationUseOption { """ True when the application can be offered for webhooks (triggers) of the space. """ isAvailableForTrigger: Boolean! """ True when the application can be offered for personal triggers, which act on behalf of an individual user. """ isAvailableForPersonalTrigger: Boolean! """ False for applications that are not shown by name, such as the web and mobile apps. """ isDisplayable: Boolean! """ True when the application can be used as a filter value; false for applications that are deleted, inactive or whose integration is disabled. """ isFilterable: Boolean! } """ Folder that organizes files, either in the company documents or within a record. """ type CloudObjectFolderEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Online form template this folder is associated with, when the folder stores form submissions. """ onlineFormType: OnlineFormTypeEntity """ Parent folder, when this folder is nested. Empty for top-level folders. """ parentCloudObjectFolder: CloudObjectFolderEntity """ API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. """ entityApiName: String """ Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only. """ entityType: BaseEntityTypeEnum """Name of the entity and its default text representation.""" name: String! """ Id of the online form template, or empty when not associated with a form. """ onlineFormTypeId: ID """Id of the parent folder, or empty for top-level folders.""" parentCloudObjectFolderId: ID """Revision when entity was lastly changed.""" revision: Int """ Folder kind: Company for shared company folders, Record for folders attached to a specific record. """ type: CloudObjectFolderType! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Online form definition: the fields and settings of a web form whose submissions create or update records. """ type OnlineFormTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of the online form definition (formEdit): its fields, layout and settings. """ formEditApi: OnlineForm """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns the online form.""" owner: ClientEntity """Visual style applied to the form when rendered.""" style: OnlineFormStyleEntity """ When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. """ autoPrefillWithJavascript: Boolean """Free-text description shown alongside the form definition in the UI.""" description: String """ API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. """ entityApiName: String """ Entity the form is built for: its fields can be placed on the form and each submission is linked to a record of this entity. For custom entities, entityApiName identifies the custom entity. """ entityType: BaseEntityTypeEnum! """ Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. This payload conforms to the `OnlineForm` JSON Schema: GET /api/v100/rest/schemas/OnlineForm.json on your region's API host """ formEdit: JSONString! """ When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. """ isEnabled: Boolean! """ True when the form is system-managed and its schema cannot be edited by users. """ isReadonly: Boolean! """Timestamp of the most recent change to formEdit (form schema).""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String! """ Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. """ notificationsStatus: JSONString """Id of the owning user.""" ownerId: ID! """Id of the form style.""" styleId: ID! """Revision when entity was lastly changed.""" revision: Int """ Minimum response count required for the form to be considered "responsive" in reports and notifications. Empty when no threshold is configured. """ responseAcceptanceThreshold: Int """Total number of times the form link has been delivered to recipients.""" sentCount: Int """Number of distinct recipients the form link has been delivered to.""" sentUniqueCount: Int """Total number of submissions (responses) recorded for the form.""" responseCount: Int """Fraction (0–1) of unique recipients who submitted a response.""" responseRate: Float """ Timestamp of the most recent submission. Empty when the form has no responses. """ lastResponseDate: DateTime """ Name or email address of the respondent on the most recent submission. Empty when the form has no responses or the respondent could not be identified. """ lastResponseBy: String """ Solutions whose canvas contains this record. Deleted solutions are not included. """ solutions( """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionEntityConnection """Submissions (one per response) recorded for this form.""" activityLogs( """Filter OnlineForm relations by target OnlineForm attributes.""" filter: OnlineFormFilterInput """Order OnlineForm relations by target OnlineForm attributes.""" orderBy: [OnlineFormOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormEntityConnection """ Short identifier used in the public form URL (see link). Stable across the lifetime of the form. """ linkId: String! """ Sum of response values used to evaluate the response acceptance threshold (e.g. total responses, or evaluated value of the custom acceptance condition). Empty when no threshold is configured. """ summarizedResponseValues: Int """ Public URL for accessing the form (suitable for sharing with respondents). """ link: String """ Overall state of the form: Inactive while it has no active configuration, Active while accepting responses, Completed once the configured end condition is met. """ status: ProcessStatusEnum """ True when the form is configured with custom reCAPTCHA credentials; false when using the platform default reCAPTCHA setup. """ hasCustomRecaptcha: Boolean! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """Ids of all fields that appear in at least one submission of this form.""" usedFieldIds: [ID!]! """ Records the form was sent to or that responded to it, one item per record with its send and response dates and number of responses. """ responseSummaries( """ Which records to list: those that responded, those the form was sent to, those sent the form without responding, or responses not linked to any record. """ category: ResponseSummaryRelationCategory! """Column to sort by; the response or send date by default, per category.""" sortBy: OnlineFormTypeDetailGridSortBy """Sort direction; descending by default.""" sortOrder: SortOrder """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormResponseSummaryItemConnection """Submissions of this form with their answers.""" responses( """Conditions the submissions must match.""" filter: FieldFilterParams """Column to sort by; the response date by default.""" sortBy: OnlineFormTypeDetailResponseGridSortBy """ Form field whose answers the submissions are sorted by; required when `sortBy` is ResponseValue. """ sortByFieldId: ID """Sort direction; descending by default.""" sortOrder: SortOrder """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormResponseItemConnection """Files uploaded through the submissions of this form.""" uploadedFiles( """Conditions selecting the submissions whose files are returned.""" filter: OnlineFormFilterInput """ Limits the files to those uploaded through these form fields; all fields when omitted. """ fieldIds: [UUID!] ): OnlineFormUploadedFiles! } """ Visual style (colors, fonts, layout) that can be applied to online forms. """ type OnlineFormStyleEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """ JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. """ settings: OnlineFormStyleSettings """ When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Visual style of online forms: colors, spacing, borders and logo.""" type OnlineFormStyleSettings { """Background color of the page behind the form, as a CSS color.""" backgroundColor: String """Vertical padding of the area with the form buttons, as a CSS length.""" buttonAreaPaddingVertical: String """Horizontal padding of the area with the form buttons, as a CSS length.""" buttonAreaPaddingHorizontal: String """Background color of the form buttons, as a CSS color.""" buttonColor: String """Text color of the form buttons, as a CSS color.""" buttonFontColor: String """Corner radius of the form buttons, as a CSS length.""" buttonRadius: String """Horizontal padding of the layout columns, as a CSS length.""" columnsHorizontalPadding: String """Background color of the form itself, as a CSS color.""" formBackgroundColor: String """Horizontal padding of the form, as a CSS length.""" formHorizontalPadding: String """Vertical padding of the form, as a CSS length.""" formVerticalPadding: String """Space below the form header, as a CSS length.""" headerBottomMargin: String """Space below the description in the form header, as a CSS length.""" headerDescriptionBottomMargin: String """Horizontal padding of the form header, as a CSS length.""" headerHorizontalPadding: String """Vertical padding around the header image, as a CSS length.""" headerImageVerticalPadding: String """When true, the header ribbon of the form is shown.""" headerRibbonVisible: Boolean! """Space above the form title in the header, as a CSS length.""" headerTitleTopPadding: String """Background color of input fields, as a CSS color.""" inputBackgroundColor: String """Border color of input fields, as a CSS color.""" inputBorderColor: String """Corner radius of input fields, as a CSS length.""" inputBorderRadius: String """Border width of input fields, as a CSS length.""" inputBorderWidth: String """Background color of the input field that has focus, as a CSS color.""" inputFocusBackgroundColor: String """Border color of the input field that has focus, as a CSS color.""" inputFocusBorderColor: String """Text color of input fields, as a CSS color.""" inputFontColor: String """Background color of an input field under the pointer, as a CSS color.""" inputHoverBackgroundColor: String """Border color of an input field under the pointer, as a CSS color.""" inputHoverBorderColor: String """Main accent color of the form, as a CSS color.""" primaryColor: String! """Space below the description of a question, as a CSS length.""" questionDescriptionBottomMargin: String """Space below the title of a question, as a CSS length.""" questionTitleBottomMargin: String """Vertical margin around each question, as a CSS length.""" questionVerticalMargin: String """Vertical padding inside each question, as a CSS length.""" questionVerticalPadding: String """Background color of section headers, as a CSS color.""" sectionBackgroundColor: String """Text color of section headers, as a CSS color.""" sectionFontColor: String """Horizontal padding of section headers, as a CSS length.""" sectionHeaderHorizontalPadding: String """Vertical padding of section headers, as a CSS length.""" sectionHeaderVerticalPadding: String """Padding of form sections, as a CSS length.""" sectionPadding: String """When true, the logo is shown in the footer of the form.""" showFooterLogo: Boolean! """Space below the form title, as a CSS length.""" titleBottomMargin: String } """ Main record entity (lead, account, contact, opportunity, activity, opportunity product line, project, quote, online form, custom entity or product) that a setting, relation or query applies to. """ enum BaseEntityTypeEnum { """ Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. """ Lead """ Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. """ Account """ Person the sales team works with, usually linked to one or more accounts, leads and opportunities. """ Contact """ Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. """ Opportunity """ Task (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records. """ Task """ Meeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns. """ Appointment """Product line of an opportunity.""" OpptyProductRelation """ Project delivered for an account or run internally, with its objectives, activities and progress. """ Project """ Price offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process. """ Quote """ Submission (response) of an online form, with the answers and the records it created or updated. """ OnlineForm """ Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. """ CustomEntity """ Product or service in the catalog that can be added as a line item to opportunities and quotes. """ Product } """Paginated list of Solution records.""" type SolutionEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [SolutionEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `SolutionEntity` and its cursor.""" type SolutionEntityEdge { """The item at the end of the edge""" node: SolutionEntity """A cursor for use in pagination""" cursor: String! } """ Canvas that groups related automation tools (Automatizer processes, email sequences, online forms) and tracks their status and activity. """ type SolutionEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns the solution.""" owner: ClientEntity """Template this solution was created from, if any.""" solutionTemplate: SolutionTemplateEntity """Free-text description of the solution.""" description: String """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ Canvas of the solution as a JSON object conforming to the SolutionSchema type, with nodes, edges and groups. Validated on write; an invalid canvas is rejected. Full structure: https://developers.coevera.com/reference/graphql/types/s/#SolutionSchema """ settings: SolutionSchema """Template this solution was created from, if any.""" solutionTemplateId: ID """Number of nodes on the canvas.""" nodeCount: Int """ Live status derived from the activatable nodes (Automatizer, Email Sequence, Online Form): Active when all are enabled, Inactive when none are, Partial otherwise. """ status: SolutionStatusEnum """Tags attached to the solution for organisation/filtering.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Activity statistics of the solution's tools for the selected period, computed from their activity logs on every read. """ stats( """Time window the statistics cover.""" period: SolutionStatsPeriodEnum! ): SolutionStats! """ Activity of the solution's tools, newest first: Automatizer process runs, email-sequence runs and online-form submissions. Paging is forward-only with first/after; first defaults to 50 and is capped at 200. """ activityLogs( """Limit the runs to the given period (default All).""" period: SolutionStatsPeriodEnum """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionActivityLogConnection! } """ Ready-made solution offered in the template gallery as a starting point for new solutions. """ type SolutionTemplateEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template sets up.""" description: String """Name of the entity and its default text representation.""" name: String! """URL of the template preview image shown in the template gallery.""" previewImageUrl: String """ Preview of the template's canvas: the nodes, edges and groups the created solution will contain. Read-only. """ settings: SolutionTemplateSchema! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Preview canvas of a solution template: the nodes, edges and groups the created solution will contain, in the layout they will have after installation. """ type SolutionTemplateSchema { """Nodes of the template.""" nodes: [SolutionTemplateNodeInterface!]! """Typed edges between nodes.""" edges: [SolutionTemplateEdge!]! """Visual groups bundling nodes.""" groups: [SolutionTemplateGroup!]! } """Common shape of every node in the template preview canvas.""" interface SolutionTemplateNodeInterface { """Unique identifier of this node within the template.""" id: ID! """ Node position on the canvas; the created solution places the node at the same position. """ position: Position! """Group this node belongs to, if any.""" groupId: ID """Display name of the node in the template preview.""" name: String! """ Explanation of what the node does, provided by the template. Null when the template gives none; always null for entity nodes. """ description: String } """A directed, typed edge between two template nodes.""" type SolutionTemplateEdge { """Unique identifier of this edge within the template.""" id: ID! """Edge label, if the template defines one.""" name: String """Id of the node the edge starts from.""" sourceNodeId: ID! """Id of the node the edge points to.""" targetNodeId: ID! """Type of connection the edge represents.""" type: SolutionEdgeType! } """A labelled container bundling template nodes.""" type SolutionTemplateGroup { """Unique identifier of this group within the template.""" id: ID! """ Group rectangle (position and size) on the canvas; the created solution uses the same layout. """ position: Rectangle! """Display label of the group.""" name: String! """Group color.""" color: Int! } """ Overall status of a solution, derived from its Automatizer processes, email sequences and online forms. """ enum SolutionStatusEnum { """All of them are enabled.""" Active """Some of them are enabled.""" Partial """None of them is enabled.""" Inactive } """Paginated list of TagRelation records.""" type TagRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TagRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TagRelationEntity` and its cursor.""" type TagRelationEntityEdge { """The item at the end of the edge""" node: TagRelationEntity """A cursor for use in pagination""" cursor: String! } """Assignment of a tag to a record.""" type TagRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account the tag is attached to, or empty when not attached to an account. """ account: AccountEntity """ Appointment the tag is attached to, or empty when not attached to an appointment. """ appointment: AppointmentEntity """ Contact the tag is attached to, or empty when not attached to a contact. """ contact: ContactEntity """ Custom entity record the tag is attached to, or empty when not attached to a custom entity record. """ customEntity: CustomEntityEntity """Email the tag is attached to, or empty when not attached to an email.""" email: EmailEntity """Lead the tag is attached to, or empty when not attached to a lead.""" lead: LeadEntity """ Opportunity the tag is attached to, or empty when not attached to an opportunity. """ oppty: OpportunityEntity """ Sales process the tag is attached to, or empty when not attached to a process. """ process: ProcessEntity """ Project the tag is attached to, or empty when not attached to a project. """ project: ProjectEntity """Quote the tag is attached to, or empty when not attached to a quote.""" quote: QuoteEntity """ Solution the tag is attached to, or empty when not attached to a solution. """ solution: SolutionEntity """Tag being attached to the record.""" tag: TagEntity """Task the tag is attached to, or empty when not attached to a task.""" task: TaskEntity """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Meeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns. """ type AppointmentEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """ Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending. """ activeReminder: String """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment type that classifies this appointment. Drives form layout and icon. """ activityType: AppointmentTypeEntity """ Currency exchange rate list used to convert monetary fields linked to this appointment. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """Sales user who owns this appointment.""" owner: ClientEntity """ Master appointment of the recurring series this occurrence belongs to. Empty for standalone appointments and for the master itself. """ recurrenceMaster: AppointmentEntity """ Appointment schedule (booking link) this appointment was created through, or empty for appointments created directly. """ schedule: AppointmentScheduleEntity """ Sales unit this appointment is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """Id of the appointment type.""" activityTypeId: ID """Id of the currency exchange rate list applied to this appointment.""" currencyExchangeRatesListId: ID """Free-form description of the appointment.""" description: String """Duration of the appointment, derived from start/end dates.""" duration: Float """End timestamp of the appointment.""" endDate: DateTime! """ True when invitees are allowed to edit the appointment. Defaults to false. """ inviteesCanEdit: Boolean """ True when the recurrence series is still generating new occurrences. Read-only. """ isRecurrenceActive: Boolean """ True when this occurrence has been modified independently of the recurring series. Read-only. """ isRecurrenceException: Boolean """Free-text physical location of the appointment.""" location: String """ Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached. """ meetingUrl: AppointmentMeeting """ Original date of this occurrence in the recurring series. Set automatically. """ occurenceDate: DateTime """ Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails. """ organizer: String """Id of the appointment owner.""" ownerId: ID! """Id of the master appointment.""" recurrenceMasterId: ID """ iCalendar RRULE string describing the recurrence pattern (e.g. "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments. """ recurrenceRule: String """IANA timezone the recurrence rule is evaluated in.""" recurrenceTzid: String """Id of the appointment schedule.""" scheduleId: ID """ IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to evaluate availability against the schedule. """ scheduleTzid: String """Start timestamp of the appointment.""" startDate: DateTime """Short summary line shown in calendars and lists.""" subject: String! """ Discriminator identifying the concrete record type — always "appointment" for Appointment records. Read-only; useful when consuming polymorphic Activity results. """ tableName: String! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Current status of the appointment (NotStarted, InProgress, Completed, Canceled). Read-only; derived from the start/end times and the deleted flag. """ status: ActivityStatusEnum! """Accounts this appointment is linked to.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Contacts this appointment is linked to.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Leads this appointment is linked to.""" leadRelations( """Filter Lead relations by target Lead attributes.""" filter: LeadFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Lead relations by target Lead attributes.""" orderBy: [LeadOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Opportunities this appointment is linked to.""" opportunityRelations( """Filter Opportunity relations by target Opportunity attributes.""" filter: OpportunityFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Opportunity relations by target Opportunity attributes.""" orderBy: [OpportunityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """ Projects this appointment is linked to, including the per-objective ordering. """ projectRelations( """Filter Project relations by target Project attributes.""" filter: ProjectFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Project relations by target Project attributes.""" orderBy: [ProjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Quotes this appointment is linked to.""" quoteRelations( """Filter Quote relations by target Quote attributes.""" filter: QuoteFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Quote relations by target Quote attributes.""" orderBy: [QuoteOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Custom entity records this appointment is linked to.""" customEntityRelations( """Filter CustomEntity relations by target CustomEntity attributes.""" filter: CustomEntityFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order CustomEntity relations by target CustomEntity attributes.""" orderBy: [CustomEntityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """ Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record. """ inviteesContacts( """ Filter AppointmentContactInviteesRelation relations by target AppointmentContactInviteesRelation attributes. """ filter: AppointmentContactInviteesRelationFilterInput """ Order AppointmentContactInviteesRelation relations by target AppointmentContactInviteesRelation attributes. """ orderBy: [AppointmentContactInviteesRelationOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentContactInviteesRelationEntityConnection """Internal-user invitees on this appointment.""" inviteesClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter AppointmentClientInviteesRelation relations by edge (relation) AppointmentClientInviteesRelation attributes. """ filterEdge: AppointmentClientInviteesRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentClientInviteesRelationEntityConnection """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ True when this appointment is mirrored to an external calendar (Office 365, Exchange, Google). Read-only. """ has3rdPartyMapping: Boolean! """ Reminder set by the current authenticated user for this appointment. Per-user; empty when no reminder has been set. """ reminder: AppointmentReminderEntity """Documents linked to this appointment.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """Comments authored on this appointment.""" comments( """Filter ActivityComment relations by target ActivityComment attributes.""" filter: ActivityCommentFilterInput """Order ActivityComment relations by target ActivityComment attributes.""" orderBy: [ActivityCommentOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityCommentEntityConnection """Tag labels applied to this appointment.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Display name of the appointment (alias of subject).""" formattedName: String! """ Recurrence configuration for recurring appointments (parsed RRULE plus exception metadata). Empty for one-off appointments. """ recurrence: AppointmentRecurrence """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """ Recording attached to this activity, with its transcription and summary when available; null when there is none. """ mediaTranscription: MediaEntity } """ Configurable category of appointments, such as a meeting or a call, that defines their form layout and icon. """ type AppointmentTypeEntity { """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ JSON definition of the form layout used by the UI when creating or editing appointments of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """Icon used to display appointments of this type in the UI.""" icon: ActivityTypeIconEnum """ True when the appointment type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Icon used to display tasks or appointments of an activity type.""" enum ActivityTypeIconEnum { """Generic activity icon not tied to a specific kind of activity.""" GeneralIcon """Icon depicting a task; the default for task types.""" Task """Icon depicting an appointment; the default for appointment types.""" Appointment """Icon depicting a phone call.""" Call """Icon depicting an email.""" Mail """Icon depicting a message.""" Message """Icon depicting a ticketing system integration.""" TicketingIntegration """Icon depicting document management.""" DocumentManagement """Icon depicting event management.""" EventManagement """Icon depicting an accounting system.""" AccountingSystem """Icon depicting a marketing communication system.""" MarketingCommunicationSystems """Icon depicting order processing.""" OrderProcessing """Icon depicting web services.""" WebServices """Icon depicting a return merchandise authorization (RMA) system.""" ReturnMerchandiseAuthorizationSystems """Icon depicting sales automation.""" SalesAutomatization """Icon depicting SMS messaging.""" SmsMessaging """Icon depicting an ERP system.""" ErpSystems """Icon depicting data analytics.""" DataAnalytics """Icon depicting a warehouse.""" Warehouses """Icon depicting contact management.""" ContactManagement """Icon depicting a content management system.""" ContentManagementSystems """Icon depicting an inventory system.""" InventorySystems """Icon depicting a workflow.""" Workflow """Icon depicting an asset management system.""" AssetManagementSystem } """ Online booking link through which people book appointments with a user in the time slots the user has available. """ type AppointmentScheduleEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ User assigned as the appointment owner when a booking is made through this schedule. """ appointmentOwner: ClientEntity """Appointment type used when a booking is created.""" appointmentType: AppointmentTypeEntity """ Owner of the schedule (typically the team member whose availability is exposed). """ owner: ClientEntity """ Sender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmail: CompanyEmailEntity """Description applied to appointments booked through this schedule.""" appointmentDescription: String! """Duration of each booked appointment.""" appointmentDuration: Float """Location applied to appointments booked through this schedule.""" appointmentLocation: String! """ Where booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. """ appointmentLocationType: AppointmentScheduleLocationTypeEnum """Id of the user receiving the booking.""" appointmentOwnerId: ID! """Subject applied to appointments booked through this schedule.""" appointmentSubject: String! """ When true, booked appointments use the scheduleName as their subject instead of appointmentSubject. """ appointmentSubjectUsesScheduleName: Boolean! """ Id of the appointment type used for appointments booked through the schedule. """ appointmentTypeId: ID! """ IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined. """ availabilityTzid: String """ Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeAfter: Int! """ Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeBefore: Int! """ What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). """ confirmationPageType: AppointmentScheduleConfirmationPageTypeEnum """ Custom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect. """ confirmationPageUrl: String """ Master switch for the schedule. Disabled schedules do not accept new bookings. """ isEnabled: Boolean! """ Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). """ minimumNoticeTime: Int! """ Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name. """ name: String! """Id of the schedule owner.""" ownerId: ID! """ With Offset planning, how many days ahead the schedule remains bookable. """ planningDayOffset: Int! """With Period planning, first date bookings are accepted for.""" planningPeriodFrom: Date """With Period planning, last date bookings are accepted for.""" planningPeriodTo: Date """ Time window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period). """ planningType: AppointmentSchedulePlanningTypeEnum """ True when a reminder email is sent to invitees ahead of the booked appointment. """ reminderEmailEnabled: Boolean! """ Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType. """ reminderEmailOffset: Int! """Time unit of reminderEmailOffset: Minute, Hour, Day or Week.""" reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum """ Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmailId: ID """ Public-facing name of the schedule, shown to bookers on the booking page. """ scheduleName: String! """ Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). """ timeIncrement: Int! """ Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. """ type: AppointmentScheduleTypeEnum """Public URL slug of the schedule, used to share the booking page.""" url: String! """ Custom fields the booker is asked to fill in on the booking page, in display order. """ additionalFieldsData: [AppointmentScheduleAdditionalField!]! """ Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone. """ availabilityData: AppointmentScheduleAvailability! """ Default invitees added to appointments booked through this schedule (Coevera users or external email addresses). """ appointmentInviteesData: [AppointmentScheduleInvitee!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Start times of the free booking slots the schedule offers between the two dates. Empty when the schedule is disabled. """ availableSlots( """IANA time zone the returned start times are expressed in.""" tzId: String! """First day of the range, inclusive.""" from: Date! """Last day of the range, inclusive.""" to: Date! ): [DateTime!]! """Number of appointments booked through this schedule.""" createdAppointmentsCount: Int! """ Number of appointments booked through this schedule that are not finished. """ upcomingAppointmentsCount: Int! """ Number of appointments booked through this schedule that were completed. """ completedAppointmentsCount: Int! """ Number of appointments booked through this schedule that were canceled. """ canceledAppointmentsCount: Int! } """ Shared company mailbox connected to the space that users can send emails from, such as a sales or support address. """ type CompanyEmailEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Email address of the company mailbox (the From address).""" email: String """ False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise. """ enabled: Boolean! """ Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration. """ errorCode: Int """Display name of the company email account, shown in the UI.""" name: String! """ URL of the avatar image used as the sender picture for emails sent from this account. """ pictureUrl: String """ Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid. """ serviceType: EmailServiceTypeEnum! """ Provider-specific configuration for the mailbox (e.g. parse_subdomain for SendGrid). """ settings: JSONString """ OAuth/secret credentials for the mailbox. Read-only and only returned to service-to-service callers; setting via the public API is not supported. """ token: String """ List of capabilities supported by the underlying email service (e.g. CanSyncBounces, CanSyncIncoming). """ features: [EmailAccountFeatureEnum!]! """ Stable UUID derived from the mailbox address and service type, used to correlate the company email account with its integration settings entry. """ mailboxId: UUID """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Daily sending limit of the email account and the number of emails sent from it in the last 24 hours. """ limits: EmailAccountLimit! } """Capability supported by an email account's service.""" enum EmailAccountFeatureEnum { """Bounced emails are detected and recorded.""" CanSyncBounces """Incoming emails, such as replies, are synchronized into Coevera.""" CanSyncIncoming } """ Daily sending limit of a company email account and how many emails were sent from it in the last 24 hours. """ type EmailAccountLimit { """ Maximum number of emails the email service of the account allows to send in 24 hours. """ messagesPerDay: Int! """ Number of emails sent from the account through Coevera in the last 24 hours. """ sentMessages: Int! } """Where meetings booked through an appointment schedule take place.""" enum AppointmentScheduleLocationTypeEnum { """Location given in appointmentLocation.""" Custom """Microsoft Teams online meeting.""" Microsoft """Zoom online meeting.""" Zoom } """What the booker sees after confirming a booking.""" enum AppointmentScheduleConfirmationPageTypeEnum { """The built-in confirmation page is shown.""" ConfirmationPage """The booker is redirected to confirmationPageUrl.""" ExternalUrl } """Time window in which an appointment schedule accepts bookings.""" enum AppointmentSchedulePlanningTypeEnum { """Bookings are accepted for any future date.""" Infinite """Bookings are accepted up to planningDayOffset days ahead.""" Offset """ Bookings are accepted only between planningPeriodFrom and planningPeriodTo. """ Period } """Time unit of the reminder email offset of an appointment schedule.""" enum AppointmentScheduleReminderOffsetTypeEnum { """Offset measured in minutes.""" Minute """Offset measured in hours.""" Hour """Offset measured in days.""" Day """Offset measured in weeks.""" Week } """Kind of meeting booked through an appointment schedule.""" enum AppointmentScheduleTypeEnum { """The booker meets only the schedule owner.""" OneToOne """ The booker meets the schedule owner together with their team members at the same time. """ Group } """ Appointment field the booker fills in on the booking page of an appointment schedule. """ type AppointmentScheduleAdditionalField { """ Id of the appointment field the booker fills in; the value is saved on the booked appointment. """ fieldId: ID! """Label of the field on the booking page.""" label: String! """True when the booker must fill in the field.""" isRequired: Boolean! } """ Weekly availability of an appointment schedule: the time windows in which appointments can be booked on each weekday. """ type AppointmentScheduleAvailability { """Availability on Mondays.""" monday: AppointmentScheduleDayAvailability! """Availability on Tuesdays.""" tuesday: AppointmentScheduleDayAvailability! """Availability on Wednesdays.""" wednesday: AppointmentScheduleDayAvailability! """Availability on Thursdays.""" thursday: AppointmentScheduleDayAvailability! """Availability on Fridays.""" friday: AppointmentScheduleDayAvailability! """Availability on Saturdays.""" saturday: AppointmentScheduleDayAvailability! """Availability on Sundays.""" sunday: AppointmentScheduleDayAvailability! } """Availability of an appointment schedule on one weekday.""" type AppointmentScheduleDayAvailability { """ True when bookings can be made on this weekday; when false, the slots are ignored. """ isEnabled: Boolean! """ Time windows of the day in which bookings can be made; overlapping windows are merged. """ slots: [AppointmentScheduleAvailabilitySlot!]! } """Time window of a day in which appointments can be booked.""" type AppointmentScheduleAvailabilitySlot { """ Start of the time window, in seconds after midnight (e.g. 32400 for 09:00) in the availabilityTzid timezone of the schedule. """ start: Int! """ End of the time window, in seconds after midnight. A booked appointment, including its buffer times, must fit inside one window. """ end: Int! } """ Default invitee of an appointment schedule: a Coevera user, a contact or an external email address. """ type AppointmentScheduleInvitee { """ Kind of invitee: a Coevera user (Client), a contact (Contact) or an external email address (Email). Only Client invitees are added to booked appointments. """ type: AppointmentScheduleInviteeType! """Email address of the invitee.""" email: String! """Id of the user or contact; empty for an Email invitee.""" entityId: ID } """Kind of default invitee of an appointment schedule.""" enum AppointmentScheduleInviteeType { """Coevera user; entityId identifies the user.""" Client """Contact; entityId identifies the contact.""" Contact """External email address given in email.""" Email } """Online meeting (Microsoft Teams or Zoom) linked to an appointment.""" type AppointmentMeeting { """URL participants use to join the online meeting.""" joinUrl: String! """Online meeting service: Microsoft Teams (MsTeams) or Zoom.""" type: AppointmentMeetingTypeEnum! } """Online meeting service used for an appointment's meeting link.""" enum AppointmentMeetingTypeEnum { """Microsoft Teams meeting.""" MsTeams """Zoom meeting.""" Zoom } """Paginated list of ActivityRelation records.""" type ActivityRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ActivityRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ActivityRelationEntity` and its cursor.""" type ActivityRelationEntityEdge { """The item at the end of the edge""" node: ActivityRelationEntity """A cursor for use in pagination""" cursor: String! } """ Link of a task or an appointment to a record it concerns, such as an account, contact, lead, opportunity, project or quote. """ type ActivityRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account the activity is linked to, or empty when not linked to an account. """ account: AccountEntity """ Appointment side of the link. Set when activityId resolves to an Appointment; otherwise empty. """ appointment: AppointmentEntity """ Task side of the link. Set when activityId resolves to a Task; otherwise empty. """ task: TaskEntity """ Contact the activity is linked to, or empty when not linked to a contact. """ contact: ContactEntity """Custom entity record the activity is linked to, or empty.""" customEntity: CustomEntityEntity """ Lead the activity is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity the activity is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """ Project the activity is linked to, or empty when not linked to a project. """ project: ProjectEntity """Project objective the activity advances, or empty.""" projectObjective: ProjectObjectiveEntity """Quote the activity is linked to, or empty when not linked to a quote.""" quote: QuoteEntity """Id of the linked account.""" accountId: ID """Id of the appointment or task on this link.""" activityId: ID! """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project.""" projectId: ID """ Id of the project objective the activity advances, or empty when it is not linked to one. """ projectObjectiveId: ID """Id of the linked quote.""" quoteId: ID """ Display order of the activity within its project objective. Required only when projectId is set. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Task (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records. """ type TaskEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """ Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending. """ activeReminder: String """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Task type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon. """ activityType: TaskTypeEntity """ Call record associated with this task when the task represents a phone call. """ call: CallEntity """Configurable outcome of the call (e.g. Reached, Voicemail, No Answer).""" callOutcome: DataEntity """ Currency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ Sales user who owns this task. May be empty when the task is unassigned and available for take-over. """ owner: ClientEntity """ Sales unit this task is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """Id of the task type.""" activityTypeId: ID """ Duration of the recorded call. Set automatically when the task is linked to a call log. """ callDuration: Int """Id of the linked call record.""" callId: ID """ Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). """ callOutcomeId: ID """Id of the currency exchange rate list applied to this task.""" currencyExchangeRatesListId: ID """Free-form description of what the task entails.""" description: String """Date by which the task is expected to be completed.""" dueDate: Date """ Estimated duration of the task. Stored as a duration value (days/hours/minutes). """ duration: Float """Id of the task owner.""" ownerId: ID """Priority level of the task: Low, Medium or High.""" priority: PriorityEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when work on the task is scheduled to begin.""" startDate: Date """ Current status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done. """ status: TaskStatusEnum """Short summary line shown in lists and notifications.""" subject: String! """ Discriminator identifying the concrete record type — always "task" for Task records. Read-only; useful when consuming polymorphic Activity results. """ tableName: String! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter TaskSharingSalesUnitRelation relations by edge (relation) TaskSharingSalesUnitRelation attributes. """ filterEdge: TaskSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskSharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this task. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter TaskSharingClientRelation relations by edge (relation) TaskSharingClientRelation attributes. """ filterEdge: TaskSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskSharingClientRelationEntityConnection """Accounts this task is linked to.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Contacts this task is linked to.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Leads this task is linked to.""" leadRelations( """Filter Lead relations by target Lead attributes.""" filter: LeadFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Lead relations by target Lead attributes.""" orderBy: [LeadOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Opportunities this task is linked to.""" opportunityRelations( """Filter Opportunity relations by target Opportunity attributes.""" filter: OpportunityFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Opportunity relations by target Opportunity attributes.""" orderBy: [OpportunityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Projects this task is linked to, including the per-objective ordering.""" projectRelations( """Filter Project relations by target Project attributes.""" filter: ProjectFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Project relations by target Project attributes.""" orderBy: [ProjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Quotes this task is linked to.""" quoteRelations( """Filter Quote relations by target Quote attributes.""" filter: QuoteFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order Quote relations by target Quote attributes.""" orderBy: [QuoteOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """Custom entity records this task is linked to.""" customEntityRelations( """Filter CustomEntity relations by target CustomEntity attributes.""" filter: CustomEntityFilterInput """ Filter ActivityRelation relations by edge (relation) ActivityRelation attributes. """ filterEdge: ActivityRelationFilterInput """Order CustomEntity relations by target CustomEntity attributes.""" orderBy: [CustomEntityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. """ reminder: TaskReminderEntity """ Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. """ taskRecurrence: TaskRecurrenceEntity """Documents linked to this task.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """Comments authored on this task.""" comments( """Filter ActivityComment relations by target ActivityComment attributes.""" filter: ActivityCommentFilterInput """Order ActivityComment relations by target ActivityComment attributes.""" orderBy: [ActivityCommentOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityCommentEntityConnection """Tag labels applied to this task.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Display name of the task (alias of subject).""" formattedName: String! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """ Recording attached to this activity, with its transcription and summary when available; null when there is none. """ mediaTranscription: MediaEntity } """Task type that classifies tasks and defines their form and icon.""" type TaskTypeEntity { """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ JSON definition of the form layout used by the UI when creating or editing tasks of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """Icon used to display tasks of this type in the UI.""" icon: ActivityTypeIconEnum """ True when the task type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Phone call logged in the space, linked to the user who made it and to the contact, account, lead or opportunity it concerns. """ type CallEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account the call is linked to, when applicable.""" account: AccountEntity """User who initiated the call.""" caller: ClientEntity """ User the call was made with, when the call was an internal user-to-user call. """ client: ClientEntity """Contact the call is linked to, when applicable.""" contact: ContactEntity """Lead the call is linked to, when the call is associated with a lead.""" lead: LeadEntity """ Opportunity the call is linked to, when the call is associated with an opportunity. """ oppty: OpportunityEntity """Specific opportunity line-item discussed on the call, when applicable.""" opptyProductRelation: OpptyProductRelationEntity """Product discussed on the call, when applicable.""" product: ProductEntity """Id of the linked account.""" accountId: ID """Id of the calling user.""" callerId: ID! """Id of the user the call was made with.""" clientId: ID """Id of the linked contact.""" contactId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked opportunity product line-item.""" opptyProductRelationId: ID """External phone number called or received, in E.164 format.""" phoneNumber: String """Id of the linked product.""" productId: ID """External transcription identifier from the calling provider.""" transcriptionId: String """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US"). """ transcriptionLanguage: String """AI-generated summary of the call transcription.""" transcriptionSummary: String """ Id of the call-log record from the calling provider that this call is associated with. """ twilioCallLogId: ID! """ Id of the cloud object holding the transcription payload, when available. """ transcriptionFileId: UUID """ Id of the cloud object holding the call audio recording, when available. """ audioId: UUID """ External call identifier from the calling provider (e.g. Twilio Call SID). """ twilioCallSid: String! """ Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording. """ audioStatus: AudioStatus """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """Audio recording of the call (MP3 file); empty when none is stored.""" audio: CloudObjectEntity """Task that represents this phone call; empty when there is none.""" task: TaskEntity """Transcription of the call as a JSON file; empty when none is stored.""" transcriptionFile: CloudObjectEntity """ Recording of this call, with its transcription and summary when available; null when there is none. """ mediaTranscription: MediaEntity } """ Person the sales team works with, usually linked to one or more accounts, leads and opportunities. """ type ContactEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Contact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply. """ contactType: ContactTypeEntity """ Currency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """Sales user who owns this contact.""" owner: ClientEntity """Profile picture associated with the contact.""" picture: CloudObjectEntity """ Sales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """Street address of the contact.""" address: String """City of the contact address.""" city: String """Free-form notes describing the contact.""" comments: String """Id of the contact type assigned to this contact.""" contactTypeId: ID """Country of the contact address.""" country: String """Id of the currency exchange rate list applied to this contact.""" currencyExchangeRatesListId: ID """ Primary email address of the contact. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """Given name of the contact.""" firstName: String """ Gender of the contact: Unknown when not specified, Male, Female or NonBinary. """ gender: GenderEnum """ True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Family name of the contact.""" lastName: String """Middle name of the contact, if applicable.""" middleName: String """Id of the contact owner.""" ownerId: ID! """ Primary phone number of the contact. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """Job title or position of the contact.""" position: String """ Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. """ quickAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the contact address.""" stateProvince: String """ Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. """ title: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the contact address.""" zipCode: String """Revision when entity was lastly changed.""" revision: Int """ Display version of the contact name (title, first, middle, last). Used in lists and references. """ formattedName: String! """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int! """ Social network profiles linked to this contact (e.g. LinkedIn, Facebook). """ socialMedia: ContactSocialRelationEntity """ Primary account this contact belongs to. Set automatically when the contact has an account relation marked as primary. """ primaryAccount: AccountEntity """ Accounts this contact is linked to. Each link records the role and position the contact has at the related account. """ accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter ContactAccountRelation relations by edge (relation) ContactAccountRelation attributes. """ filterEdge: ContactAccountRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactAccountRelationEntityConnection """ Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter ContactSharingSalesUnitRelation relations by edge (relation) ContactSharingSalesUnitRelation attributes. """ filterEdge: ContactSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactSharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter ContactSharingClientRelation relations by edge (relation) ContactSharingClientRelation attributes. """ filterEdge: ContactSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactSharingClientRelationEntityConnection """Documents linked to this contact.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ True when the current authenticated user has marked this contact as favorite. Per-user. """ isFavorite: Boolean! """Roles of Contact in his primary Account.""" primaryAccountAccountRoles: [ContactAccountAccountRoleRelationEntity!] """Job position of Contact in his primary Account.""" primaryAccountPosition: String """ Job position of Contact in his primary Account or quick account position if Contact has no primary Account. """ accountPosition: String """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this contact.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Saved view profiles this contact currently matches.""" staticProfiles( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ProfileRelation relations by edge (relation) ProfileRelation attributes. """ filterEdge: ProfileRelationFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """Org chart relationship of Contact in his primary Account.""" primaryAccountRelationship: String """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """ Approval request of this record that is pending or was rejected; null when there is none or it was approved. """ approval: ApprovalEntity } """ Configurable category of contacts that defines the form layout and settings used for contacts of that type. """ type ContactTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ JSON definition of the edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ True when the contact type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """ Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. This payload conforms to the `EntityTypeSettings` JSON Schema: GET /api/v100/rest/schemas/EntityTypeSettings.json on your region's API host """ settings: EntityTypeSettings! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Gender of a contact.""" enum GenderEnum { """Gender is not specified.""" Unknown """The contact is male.""" Male """The contact is female.""" Female """The contact is non-binary.""" NonBinary } """ Social network profiles of a contact, such as their LinkedIn, Twitter or Facebook profiles. """ type ContactSocialRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity. Must match with Contact id.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the contact.""" angellistUrl: String """Crunchbase profile URL of the contact.""" crunchbaseUrl: String """Disqus profile URL of the contact.""" disqusUrl: String """Facebook profile id of the contact.""" facebookId: String """Facebook profile URL of the contact.""" facebookUrl: String """Flickr profile URL of the contact.""" flickrUrl: String """Foursquare profile URL of the contact.""" foursquareUrl: String """Google profile id of the contact.""" googleId: String """Google+ profile URL of the contact.""" googlePlusUrl: String """Gravatar profile URL of the contact.""" gravatarUrl: String """Klout profile URL of the contact.""" kloutUrl: String """LinkedIn profile id of the contact.""" linkedinId: String """LinkedIn profile URL of the contact.""" linkedinUrl: String """Pinterest profile URL of the contact.""" pinterestUrl: String """Quora profile URL of the contact.""" quoraUrl: String """Reddit profile URL of the contact.""" redditUrl: String """Skype contact URL or username of the contact.""" skypeUrl: String """SlideShare profile URL of the contact.""" slideshareUrl: String """Twitter (X) user id of the contact.""" twitterId: String """Twitter (X) profile URL of the contact.""" twitterUrl: String """Vimeo profile URL of the contact.""" vimeoUrl: String """WordPress site URL of the contact.""" wordpressUrl: String """XING profile URL of the contact.""" xingUrl: String """Yahoo profile URL of the contact.""" yahooUrl: String """Yelp profile URL of the contact.""" yelpUrl: String """YouTube channel URL of the contact.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ContactAccountRelation records.""" type ContactAccountRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactAccountRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ContactAccountRelationEntity` and its cursor. """ type ContactAccountRelationEntityEdge { """The item at the end of the edge""" node: ContactAccountRelationEntity """A cursor for use in pagination""" cursor: String! } """ Link between a contact and an account they work for, with their position and their place in the account org chart. """ type ContactAccountRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account the contact is linked to.""" account: AccountEntity """Contact linked to the account.""" contact: ContactEntity """Id of the account the contact is linked to.""" accountId: ID! """Free-form note describing this contact-account link.""" comment: String """Id of the contact linked to the account.""" contactId: ID! """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: Boolean """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: Boolean """Job title or position the contact holds at the account.""" position: String """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Roles the contact holds within the linked account.""" accountRoles: [ContactAccountAccountRoleRelationEntity!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Strength of a contact's relationship within an account or lead/opportunity org chart. """ enum OrgRelationshipTypeEnum { """No relationship is recorded.""" NoRelationship """The relationship is weak.""" Weak """The relationship is of moderate strength.""" Moderate """The relationship is strong.""" Strong } """ Role assigned to a contact at an account, on the link between the contact and the account. """ type ContactAccountAccountRoleRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Role assigned to the contact at the account.""" accountRole: AccountRoleEntity """Contact-account link this role assignment belongs to.""" contactAccountRelation: ContactAccountRelationEntity """Id of the role assigned to the contact at the account.""" accountRoleId: ID! """Id of the contact-account link.""" contactAccountRelationId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Role a contact can hold at an account, configurable per space and assigned on the link between the contact and the account. """ type AccountRoleEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """Name of the entity and its default text representation.""" label: String! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for Account records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Manual classification grade assigned to the account. Used in segmentation and reporting. """ accountClass: AccountClassEnumFilterInput """Id of the account type assigned to this account.""" accountTypeId: EntityFilterStringField """Street address of the account.""" address: EntityFilterStringField """City of the account address.""" city: EntityFilterStringField """Free-form notes describing the account.""" comments: EntityFilterStringField """Country of the account address.""" country: EntityFilterStringField """Id of the currency exchange rate list applied to this account.""" currencyExchangeRatesListId: EntityFilterStringField """ Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. """ customerTypeId: EntityFilterStringField """ Primary email address of the account. Used as default recipient for emails sent from Coevera. """ email1: EntityFilterStringField """Additional email address.""" email2: EntityFilterStringField """Additional email address.""" email3: EntityFilterStringField """Additional email address.""" email4: EntityFilterStringField """Additional email address.""" email5: EntityFilterStringField """ Coarser bucket of healthStatus used for grouping and reporting. Read-only. """ healthCategory: EntityFilterStringField """ Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. """ healthStatus: EntityFilterNumberField """ Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. """ homePage: EntityFilterStringField """Id of the industry classification.""" industryId: EntityFilterStringField """ True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ Time when an AI-suggested account hierarchy was last applied to this account. """ lastAiAccountHierarchyApplied: EntityFilterDateTimeField """Time when an AI-suggested org chart was last applied to this account.""" lastAiOrgChartApplied: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the account owner.""" ownerId: EntityFilterStringField """ Id of the parent account in the corporate hierarchy. Empty for top-level accounts. """ parentAccountId: EntityFilterStringField """Id of the parent-account relationship type.""" parentAccountRelationTypeId: EntityFilterStringField """ Primary phone number of the account. Used as default target for click-to-call. """ phone1: EntityFilterStringField """Additional phone number.""" phone2: EntityFilterStringField """Additional phone number.""" phone3: EntityFilterStringField """Additional phone number.""" phone4: EntityFilterStringField """Additional phone number.""" phone5: EntityFilterStringField """Id of the profile picture document.""" pictureId: EntityFilterStringField """ Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. """ quickParentAccountName: EntityFilterStringField """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnumFilterInput """State or province of the account address.""" stateProvince: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """ZIP or postal code of the account address.""" zipCode: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int """Matches records related to at least one of the listed records.""" relatedEntities: [EntityFilterRelatedField] """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. Matches records where a related record meets these conditions. """ accountType: AccountTypeFilterInput """ Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. Matches records where a related record meets these conditions. """ customerType: DataFilterInput """ Industry the account operates in. Configurable per team space. Matches records where a related record meets these conditions. """ industry: DataFilterInput """ Sales user who owns this account. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Parent account in a corporate hierarchy. Empty for top-level accounts. Matches records where a related record meets these conditions. """ parentAccount: AccountFilterInput """ Type of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set. Matches records where a related record meets these conditions. """ parentAccountRelationType: ParentAccountRelationTypeFilterInput """ Profile picture or company logo associated with the account. Matches records where a related record meets these conditions. """ picture: CloudObjectFilterInput """ Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Social network profiles linked to this account (e.g. LinkedIn, Facebook). Matches records where a related record meets these conditions. """ socialMedia: AccountSocialRelationFilterInput """ Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: AccountSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this account. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: AccountSharingClientRelationFilterInput """ Documents linked to this account. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Tag labels applied to this account. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput """ Saved view profiles this account currently matches. Matches records where a related record meets these conditions. """ staticProfiles: ProfileRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccountClassEnumFilterInput { """Matches any of the listed values.""" eq: [AccountClassEnum!] """Matches values that do not meet this condition.""" NOT: AccountClassEnumFilterInput } """Classification grade of an account.""" enum AccountClassEnum { """The account is not classified.""" NoClass """Most valuable accounts (class A).""" ClassA """Second most valuable accounts (class B).""" ClassB """Third most valuable accounts (class C).""" ClassC """Least valuable accounts (class D).""" ClassD } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ShareModeEnumFilterInput { """Matches any of the listed values.""" eq: [ShareModeEnum!] """Matches values that do not meet this condition.""" NOT: ShareModeEnumFilterInput } """ A set of records of one entity type that the result must be related to. """ input EntityFilterRelatedField { """Entity type of the related records.""" entity: EntityLacotaType """Ids of the related records.""" entityIds: [UUID] } """ Conditions on a single custom field. Several conditions given together must all match. """ input CustomField { """ Exact match (case sensitive). Multiple values in list are evaluated as OR. """ eq: [String] """ True matches records where the field has no value; false matches records where it has one. """ null: Boolean """ Exact match (case insensitive). Multiple values in list are evaluated as OR. """ ieq: [String] """ True matches records where the text is missing or an empty string; false matches records with a non-empty text. """ empty: Boolean """ Compare against left side of string (case sensitive). Multiple values in list are evaluated as OR. """ starts: [String] """ Compare against right side of string (case sensitive). Multiple values in list are evaluated as OR. """ ends: [String] """ Substring match (case sensitive). Multiple values in list are evaluated as OR. """ contains: [String] """ Compare against left side of string (case insensitive). Multiple values in list are evaluated as OR. """ istarts: [String] """ Compare against right side of string (case insensitive). Multiple values in list are evaluated as OR. """ iends: [String] """ Substring match (case insensitive). Multiple values in list are evaluated as OR. """ icontains: [String] """Matches values lower than this number.""" lt: Float """Matches values lower than or equal to this number.""" lte: Float """Matches values greater than this number.""" gt: Float """Matches values greater than or equal to this number.""" gte: Float """ Exactly two values, lower and upper bound. Matches values in this range, including both bounds. """ between: [Float] """Api name of custom field.""" field: String! } """ Filter conditions for AccountType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ True when the account type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for Data records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input DataFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [DataFilterInput!] """Matches records that meet all of the listed filters.""" AND: [DataFilterInput!] """Matches records that do not meet this filter.""" NOT: DataFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option). """ calcValue: EntityFilterNumberField """ Identifier of the data set this option belongs to. Shared by all options of a dropdown / radio / multiselect field. """ dataSetId: EntityFilterStringField """Name of the entity and its default text representation.""" optionName: EntityFilterStringField """Position of the option within its data set; lower values appear first.""" sortOrder: EntityFilterNumberField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for Client records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ClientFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ClientFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ClientFilterInput!] """Matches records that do not meet this filter.""" NOT: ClientFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the default sales unit.""" defaultUnitId: EntityFilterStringField """Email. Readonly information from UserProfile.""" email: EntityFilterStringField """First name. Readonly information from UserProfile.""" firstName: EntityFilterStringField """Timestamp of the user's most recent login or API request.""" lastActive: EntityFilterDateTimeField """Last name. Readonly information from UserProfile.""" lastName: EntityFilterStringField """Id of the assigned user role.""" masterRightId: EntityFilterStringField """Middle name. Readonly information from UserProfile.""" middleName: EntityFilterStringField """Phone number. Readonly information from UserProfile.""" phone: EntityFilterStringField """Picture name. Readonly information from UserProfile.""" pictureUrl: EntityFilterStringField """Job title or position of the user.""" position: EntityFilterStringField """Region. Readonly information from UserProfile.""" region: EntityFilterStringField """ Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead. """ timezone: EntityFilterStringField """ Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person. """ type: ClientTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Display name of the user, formatted according to the user's name format preference. """ name: String """ Default sales unit for the user. New records the user creates are assigned to this unit by default. Matches records where a related record meets these conditions. """ defaultUnit: SalesUnitFilterInput """ User role assigned to the user. Determines what features and entities the user can access. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput """ Sales units the user belongs to (as member or manager). Matches records where a related record meets these conditions. """ unitMembership: SalesUnitClientRelationFilterInput """ Appointments marked as favorite by the user. Matches records where a related record meets these conditions. """ appointmentFavorite: ClientFavoriteFilterInput """ Tasks marked as favorite by the user. Matches records where a related record meets these conditions. """ taskFavorite: ClientFavoriteFilterInput """ Accounts marked as favorite by the user. Matches records where a related record meets these conditions. """ accountFavorite: ClientFavoriteFilterInput """ Contacts marked as favorite by the user. Matches records where a related record meets these conditions. """ contactFavorite: ClientFavoriteFilterInput """ Screen profiles marked as favorite by the user. Matches records where a related record meets these conditions. """ profileFavorite: ClientFavoriteFilterInput """ Reports marked as favorite by the user. Matches records where a related record meets these conditions. """ reportFavorite: ClientFavoriteFilterInput """ Leads marked as favorite by the user. Matches records where a related record meets these conditions. """ leadFavorite: ClientFavoriteFilterInput """ Opportunities marked as favorite by the user. Matches records where a related record meets these conditions. """ opportunityFavorite: ClientFavoriteFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ClientTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ClientTypeEnum!] """Matches values that do not meet this condition.""" NOT: ClientTypeEnumFilterInput } """Kind of user in the space.""" enum ClientTypeEnum { """Regular user of the space.""" Customer """Coevera customer-support user with access to the space.""" Support """ Placeholder user in a demo space that has not been assigned to a real person yet. """ Placeholder } """ Filter conditions for SalesUnit records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input SalesUnitFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [SalesUnitFilterInput!] """Matches records that meet all of the listed filters.""" AND: [SalesUnitFilterInput!] """Matches records that do not meet this filter.""" NOT: SalesUnitFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the parent unit, or empty for the root unit.""" parentId: EntityFilterStringField """Id of the picture cloud object.""" pictureId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Parent sales unit, when this unit is nested. Empty for the root unit. Matches records where a related record meets these conditions. """ parent: SalesUnitFilterInput """ Profile picture (logo) of the sales unit. Matches records where a related record meets these conditions. """ picture: CloudObjectFilterInput } """ Filter conditions for CloudObject records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CloudObjectFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CloudObjectFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CloudObjectFilterInput!] """Matches records that do not meet this filter.""" NOT: CloudObjectFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the producing application.""" applicationId: EntityFilterStringField """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: EntityFilterStringField """Id of the uploading user.""" creatorId: EntityFilterStringField """File name (with extension) used when downloading the object.""" filename: EntityFilterStringField """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """Mime-type of the cloud object Is detected from content.""" mimeType: EntityFilterStringField """Size of the object in bytes.""" size: EntityFilterNumberField """ Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. """ type: CloudObjectTypeEnumFilterInput """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnumFilterInput """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Application that produced the object (e.g. Online Forms). Matches records where a related record meets these conditions. """ application: ApplicationFilterInput """ Company-level folder that contains the object, when stored in the company document tree. Matches records where a related record meets these conditions. """ companyCloudObjectFolder: CloudObjectFolderFilterInput """ User who uploaded the object. Matches records where a related record meets these conditions. """ creator: ClientFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input CloudObjectTypeEnumFilterInput { """Matches any of the listed values.""" eq: [CloudObjectTypeEnum!] """Matches values that do not meet this condition.""" NOT: CloudObjectTypeEnumFilterInput } """Where a document or image is stored and how its content is obtained.""" enum CloudObjectTypeEnum { """ Use on create when url points to a file already uploaded to Coevera storage; the object is then saved as S3File. """ S3FileUpload """ File stored in Coevera storage; content can be sent directly or is downloaded from url. """ S3File """ Image stored in Coevera storage, such as a record picture or product image. """ S3Image """File linked from Google Drive.""" GoogleDriveFile """File linked from OneDrive.""" OneDriveFile """File linked from Box.""" BoxFile """File linked from Dropbox.""" DropboxFile """File linked from SharePoint.""" SharepointFile """Link to an external web page or resource.""" ExternalURL """File linked from Alfresco.""" AlfrescoFile """File referenced by a direct download URL.""" UrlFile } """ Conditions on an enumeration field. Several conditions given together must all match. """ input UploadSourceEnumFilterInput { """Matches any of the listed values.""" eq: [UploadSourceEnum!] """Matches values that do not meet this condition.""" NOT: UploadSourceEnumFilterInput } """Editor in which an uploaded image is embedded.""" enum UploadSourceEnum { """Image embedded in an email template.""" EmailTemplate """Image embedded in rich-text content, such as a note or description.""" RichTextEditor } """ Filter conditions for Application records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ApplicationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ApplicationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ApplicationFilterInput!] """Matches records that do not meet this filter.""" NOT: ApplicationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Identifier of the matching Automation Hub item, or empty for user-defined applications. Set automatically by Coevera when the application is registered through the Automation Hub. """ automationHubId: EntityFilterNumberField """ True when this application can register webhooks. Set when the application is created and cannot be changed afterwards. """ isTrigger: Boolean """ True when this application is shown in the Automation Hub UI. Hidden applications are still functional but excluded from end-user discovery. """ isVisible: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when this application can act on behalf of individual users (personal triggers). Set when the application is created and cannot be changed afterwards. """ usesImpersonation: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for CloudObjectFolder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CloudObjectFolderFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CloudObjectFolderFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CloudObjectFolderFilterInput!] """Matches records that do not meet this filter.""" NOT: CloudObjectFolderFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. """ entityApiName: EntityFilterStringField """ Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only. """ entityType: BaseEntityTypeEnumFilterInput """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Id of the online form template, or empty when not associated with a form. """ onlineFormTypeId: EntityFilterStringField """Id of the parent folder, or empty for top-level folders.""" parentCloudObjectFolderId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Folder kind: Company for shared company folders, Record for folders attached to a specific record. """ type: CloudObjectFolderType """ Online form template this folder is associated with, when the folder stores form submissions. Matches records where a related record meets these conditions. """ onlineFormType: OnlineFormTypeFilterInput """ Parent folder, when this folder is nested. Empty for top-level folders. Matches records where a related record meets these conditions. """ parentCloudObjectFolder: CloudObjectFolderFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input BaseEntityTypeEnumFilterInput { """Matches any of the listed values.""" eq: [BaseEntityTypeEnum!] """Matches values that do not meet this condition.""" NOT: BaseEntityTypeEnumFilterInput } """Kind of document folder.""" enum CloudObjectFolderType { """Shared company folder, not tied to a record.""" Company """Folder attached to a specific record.""" Record } """ Filter conditions for OnlineFormType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OnlineFormTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OnlineFormTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OnlineFormTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: OnlineFormTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. """ autoPrefillWithJavascript: Boolean """Free-text description shown alongside the form definition in the UI.""" description: EntityFilterStringField """ API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. """ entityApiName: EntityFilterStringField """ Entity the form is built for: its fields can be placed on the form and each submission is linked to a record of this entity. For custom entities, entityApiName identifies the custom entity. """ entityType: BaseEntityTypeEnumFilterInput """ When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. """ isEnabled: Boolean """ True when the form is system-managed and its schema cannot be edited by users. """ isReadonly: Boolean """Timestamp of the most recent change to formEdit (form schema).""" lastSchemaChange: EntityFilterDateTimeField """Timestamp of the most recent change to isEnabled.""" lastStatusChange: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """Id of the form style.""" styleId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Minimum response count required for the form to be considered "responsive" in reports and notifications. Empty when no threshold is configured. """ responseAcceptanceThreshold: Int """Total number of times the form link has been delivered to recipients.""" sentCount: Int """Number of distinct recipients the form link has been delivered to.""" sentUniqueCount: Int """Total number of submissions (responses) recorded for the form.""" responseCount: Int """Fraction (0–1) of unique recipients who submitted a response.""" responseRate: Float """ Timestamp of the most recent submission. Empty when the form has no responses. """ lastResponseDate: DateTime """ Name or email address of the respondent on the most recent submission. Empty when the form has no responses or the respondent could not be identified. """ lastResponseBy: String """ Overall state of the form: Inactive while it has no active configuration, Active while accepting responses, Completed once the configured end condition is met. """ status: ProcessStatusEnum """ User who owns the online form. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Visual style applied to the form when rendered. Matches records where a related record meets these conditions. """ style: OnlineFormStyleFilterInput """ Submissions (one per response) recorded for this form. Matches records where a related record meets these conditions. """ activityLogs: OnlineFormFilterInput } """ Result of a process, email sequence or approval run or step, or the overall status derived from recent runs. """ enum ProcessStatusEnum { """Completed successfully.""" Ok """ Completed with warnings, such as skipped records, or a scheduled step was canceled. """ Warning """Failed.""" Error """Not active yet; its active-from date is in the future.""" Scheduled """No longer active; its active-to date has passed.""" Expired } """ Filter conditions for OnlineFormStyle records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OnlineFormStyleFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OnlineFormStyleFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OnlineFormStyleFilterInput!] """Matches records that do not meet this filter.""" NOT: OnlineFormStyleFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """ When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for OnlineForm records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OnlineFormFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OnlineFormFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OnlineFormFilterInput!] """Matches records that do not meet this filter.""" NOT: OnlineFormFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the currency exchange rate list applied to product line items at submission time. """ currencyExchangeRatesListId: EntityFilterStringField """Id of the linked email record, when available.""" emailId: EntityFilterStringField """Id of the online form definition.""" onlineFormTypeId: EntityFilterStringField """Id of the selected currency.""" productCurrencyId: EntityFilterStringField """Id of the selected price list.""" productPriceListId: EntityFilterStringField """ Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. """ status: ProcessStatusEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format. """ recordName: EntityFilterStringField """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Currency exchange rate list applied to product line-items at submission time. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Email submitted with the response, used for identification or response notifications. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Online form definition this submission belongs to. Matches records where a related record meets these conditions. """ onlineFormType: OnlineFormTypeFilterInput """ Currency selected by the respondent for product line-items, when the form contains products. Matches records where a related record meets these conditions. """ productCurrency: CurrencyFilterInput """ Product price list selected by the respondent, when the form contains products. Matches records where a related record meets these conditions. """ productPriceList: ProductPriceListFilterInput """ Accounts the submission was linked to. Matches records where a related record meets these conditions. """ accountRelations: OnlineFormRelationFilterInput """ Contacts the submission was linked to. Matches records where a related record meets these conditions. """ contactRelations: OnlineFormRelationFilterInput """ Leads the submission was linked to. Matches records where a related record meets these conditions. """ leadRelations: OnlineFormRelationFilterInput """ Opportunities the submission was linked to. Matches records where a related record meets these conditions. """ opportunityRelations: OnlineFormRelationFilterInput """ Quotes the submission was linked to. Matches records where a related record meets these conditions. """ quoteRelations: OnlineFormRelationFilterInput """ Projects the submission was linked to. Matches records where a related record meets these conditions. """ projectRelations: OnlineFormRelationFilterInput """ Custom entity records the submission was linked to. Matches records where a related record meets these conditions. """ customEntityRelations: OnlineFormRelationFilterInput """ Activity log lines describing what was done with this submission (visible only). Matches records where a related record meets these conditions. """ lines: OnlineFormActivityLogLineFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProcessStatusEnumFilterInput { """Matches any of the listed values.""" eq: [ProcessStatusEnum!] """Matches values that do not meet this condition.""" NOT: ProcessStatusEnumFilterInput } """ Filter conditions for Email records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Comma-separated list of blind-carbon-copy recipients.""" bcc: EntityFilterStringField """ HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. """ body: EntityFilterStringField """ Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. """ bodySummary: EntityFilterStringField """Comma-separated list of carbon-copy recipients.""" cc: EntityFilterStringField """ Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmailId: EntityFilterStringField """ How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). """ contentShareMode: ContentShareModeEnumFilterInput """MIME content type of the body (e.g. text/html, text/plain).""" contentType: EntityFilterStringField """ Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. """ dateSent: EntityFilterDateTimeField """Direction of the email (Incoming, Outgoing).""" direction: EmailDirectionEnumFilterInput """ Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmailId: EntityFilterStringField """ Numeric error code recorded when the email failed to send. Zero when no error occurred. """ errorCode: EntityFilterNumberField """ True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. """ isDraft: Boolean """ True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. """ isTracked: Boolean """ External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. """ originalId: EntityFilterStringField """Id of the email owner.""" ownerId: EntityFilterStringField """Id of the parent (master) email.""" parentEmailId: EntityFilterStringField """ Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. """ sendAt: EntityFilterDateTimeField """Sender address as it appeared on the email (free-text "From" header).""" sender: EntityFilterStringField """Id of the matched sender account.""" senderAccountId: EntityFilterStringField """Id of the matched sender user.""" senderClientId: EntityFilterStringField """Id of the matched sender contact.""" senderContactId: EntityFilterStringField """Id of the personal email-integration account that sent this email.""" senderEmailAccountId: EntityFilterStringField """ Tone of the email (Negative, Neutral or Positive) as assessed by AI from its content; empty until assessed. Returned only to users with read permission on the email content. """ sentiment: EmailSentimentEnumFilterInput """ Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnumFilterInput """Name of the entity and its default text representation.""" subject: EntityFilterStringField """ Discriminator identifying the concrete record type — always "email" for Email records. Read-only; useful when consuming polymorphic Message results. """ tableName: EntityFilterStringField """Id of the email template.""" templateId: EntityFilterStringField """Identifier grouping emails belonging to the same conversation thread.""" threadId: EntityFilterStringField """Comma-separated list of primary recipients.""" to: EntityFilterStringField """ Whether the email is an individual email (Standard) or part of a mass email (Mass). """ type: EmailTypeEnumFilterInput """IMAP UID of the email on the source mailbox.""" uid: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Ids of the mailboxes (company or personal) the email envelope belongs to, aggregated from the active emailMailboxRelation rows. """ mailboxIds: [UUID!] """ Configured company email used as the From / Reply-To. Empty when sent from the user mailbox. Matches records where a related record meets these conditions. """ companyEmail: CompanyEmailFilterInput """ The original email a draft was started from (reply/forward source), or empty for a standalone draft. Matches records where a related record meets these conditions. """ draftParentEmail: EmailFilterInput """ Sales user who owns this email. May be empty for unassigned emails. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ For mass emails: the master email this copy was generated from. Empty for the master and for non-mass emails. Matches records where a related record meets these conditions. """ parentEmail: EmailFilterInput """ Account record matched as the sender, or empty when the sender does not match an existing Account. Matches records where a related record meets these conditions. """ senderAccount: AccountFilterInput """ Internal user matched as the sender, or empty when the sender is external. Matches records where a related record meets these conditions. """ senderClient: ClientFilterInput """ Contact record matched as the sender, or empty when the sender does not match an existing Contact. Matches records where a related record meets these conditions. """ senderContact: ContactFilterInput """ Email template used to compose this email, or empty when none was used. Matches records where a related record meets these conditions. """ template: EmailTemplateFilterInput """ Sales units that have been granted shared access to this email envelope. Matches records where a related record meets these conditions. """ sharingUnits: MessageSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this email envelope. Matches records where a related record meets these conditions. """ sharingClients: MessageSharingClientRelationFilterInput """ Sales units that have been granted access to the email body when contentShareMode is restricted. Matches records where a related record meets these conditions. """ contentSharingUnits: EmailContentSharingSalesUnitRelationFilterInput """ Users that have been granted access to the email body when contentShareMode is restricted. Matches records where a related record meets these conditions. """ contentSharingClients: EmailContentSharingClientRelationFilterInput """ Accounts this email is linked to. Matches records where a related record meets these conditions. """ accountRelations: MessageRelationFilterInput """ Contacts this email is linked to. Matches records where a related record meets these conditions. """ contactRelations: MessageRelationFilterInput """ Projects this email is linked to. Matches records where a related record meets these conditions. """ projectRelations: MessageRelationFilterInput """ Custom entity records this email is linked to. Matches records where a related record meets these conditions. """ customEntityRelations: MessageRelationFilterInput """ Leads this email is linked to. Matches records where a related record meets these conditions. """ leadRelations: MessageRelationFilterInput """ Opportunities this email is linked to. Matches records where a related record meets these conditions. """ opportunityRelations: MessageRelationFilterInput """ Quotes this email is linked to. Matches records where a related record meets these conditions. """ quoteRelations: MessageRelationFilterInput """ Tag labels applied to this email. Visible only to users that can read the email body. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput """ Attachments and other documents linked to this email. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ContentShareModeEnumFilterInput { """Matches any of the listed values.""" eq: [ContentShareModeEnum!] """Matches values that do not meet this condition.""" NOT: ContentShareModeEnumFilterInput } """Who can read the body of an email.""" enum ContentShareModeEnum { """ The owner, users the email is shared with, and the users and units listed in contentSharingClients and contentSharingUnits. """ Custom """Only the owner, the sender and users the email is shared with.""" Private """Everyone who can see the email.""" Public } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailDirectionEnumFilterInput { """Matches any of the listed values.""" eq: [EmailDirectionEnum!] """Matches values that do not meet this condition.""" NOT: EmailDirectionEnumFilterInput } """Direction of an email or text message.""" enum EmailDirectionEnum { """Sent from Coevera or by a user's mailbox.""" OutgoingEmail """Received from another party.""" IncomingEmail } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailSentimentEnumFilterInput { """Matches any of the listed values.""" eq: [EmailSentimentEnum!] """Matches values that do not meet this condition.""" NOT: EmailSentimentEnumFilterInput } """Tone of an email as assessed by AI.""" enum EmailSentimentEnum { """The email has a negative tone.""" Negative """The email has a neutral tone.""" Neutral """The email has a positive tone.""" Positive } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailTypeEnumFilterInput { """Matches any of the listed values.""" eq: [EmailTypeEnum!] """Matches values that do not meet this condition.""" NOT: EmailTypeEnumFilterInput } """Whether an email is an individual email or part of a mass email.""" enum EmailTypeEnum { """Individual email.""" Standard """Mass email sent to many recipients.""" Mass } """ Filter conditions for CompanyEmail records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CompanyEmailFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CompanyEmailFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CompanyEmailFilterInput!] """Matches records that do not meet this filter.""" NOT: CompanyEmailFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Email address of the company mailbox (the From address).""" email: EntityFilterStringField """ False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise. """ enabled: Boolean """ Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration. """ errorCode: EntityFilterNumberField """Display name of the company email account, shown in the UI.""" name: EntityFilterStringField """ URL of the avatar image used as the sender picture for emails sent from this account. """ pictureUrl: EntityFilterStringField """ Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid. """ serviceType: EmailServiceTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailServiceTypeEnumFilterInput { """Matches any of the listed values.""" eq: [EmailServiceTypeEnum!] """Matches values that do not meet this condition.""" NOT: EmailServiceTypeEnumFilterInput } """ Filter conditions for Contact records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Street address of the contact.""" address: EntityFilterStringField """City of the contact address.""" city: EntityFilterStringField """Free-form notes describing the contact.""" comments: EntityFilterStringField """Id of the contact type assigned to this contact.""" contactTypeId: EntityFilterStringField """Country of the contact address.""" country: EntityFilterStringField """Id of the currency exchange rate list applied to this contact.""" currencyExchangeRatesListId: EntityFilterStringField """ Primary email address of the contact. Used as default recipient for emails sent from Coevera. """ email1: EntityFilterStringField """Additional email address.""" email2: EntityFilterStringField """Additional email address.""" email3: EntityFilterStringField """Additional email address.""" email4: EntityFilterStringField """Additional email address.""" email5: EntityFilterStringField """Given name of the contact.""" firstName: EntityFilterStringField """ Gender of the contact: Unknown when not specified, Male, Female or NonBinary. """ gender: GenderEnumFilterInput """ True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Family name of the contact.""" lastName: EntityFilterStringField """Middle name of the contact, if applicable.""" middleName: EntityFilterStringField """Id of the contact owner.""" ownerId: EntityFilterStringField """ Primary phone number of the contact. Used as default target for click-to-call. """ phone1: EntityFilterStringField """Additional phone number.""" phone2: EntityFilterStringField """Additional phone number.""" phone3: EntityFilterStringField """Additional phone number.""" phone4: EntityFilterStringField """Additional phone number.""" phone5: EntityFilterStringField """Id of the profile picture document.""" pictureId: EntityFilterStringField """Job title or position of the contact.""" position: EntityFilterStringField """ Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. """ quickAccountName: EntityFilterStringField """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnumFilterInput """State or province of the contact address.""" stateProvince: EntityFilterStringField """ Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. """ title: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """ZIP or postal code of the contact address.""" zipCode: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """Matches records related to at least one of the listed records.""" relatedEntities: [EntityFilterRelatedField] """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Contact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply. Matches records where a related record meets these conditions. """ contactType: ContactTypeFilterInput """ Currency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Sales user who owns this contact. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Profile picture associated with the contact. Matches records where a related record meets these conditions. """ picture: CloudObjectFilterInput """ Sales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Matches records where a related record meets these conditions. """ socialMedia: ContactSocialRelationFilterInput """ Primary account this contact belongs to. Set automatically when the contact has an account relation marked as primary. Matches records where a related record meets these conditions. """ primaryAccount: AccountFilterInput """ Accounts this contact is linked to. Each link records the role and position the contact has at the related account. Matches records where a related record meets these conditions. """ accountRelations: ContactAccountRelationFilterInput """ Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: ContactSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: ContactSharingClientRelationFilterInput """ Documents linked to this contact. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Tag labels applied to this contact. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput """ Saved view profiles this contact currently matches. Matches records where a related record meets these conditions. """ staticProfiles: ProfileRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input GenderEnumFilterInput { """Matches any of the listed values.""" eq: [GenderEnum!] """Matches values that do not meet this condition.""" NOT: GenderEnumFilterInput } """ Filter conditions for ContactType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ True when the contact type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for ContactSocialRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactSocialRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactSocialRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactSocialRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactSocialRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity. Must match with Contact id.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """AngelList profile URL of the contact.""" angellistUrl: EntityFilterStringField """Crunchbase profile URL of the contact.""" crunchbaseUrl: EntityFilterStringField """Disqus profile URL of the contact.""" disqusUrl: EntityFilterStringField """Facebook profile id of the contact.""" facebookId: EntityFilterStringField """Facebook profile URL of the contact.""" facebookUrl: EntityFilterStringField """Flickr profile URL of the contact.""" flickrUrl: EntityFilterStringField """Foursquare profile URL of the contact.""" foursquareUrl: EntityFilterStringField """Google profile id of the contact.""" googleId: EntityFilterStringField """Google+ profile URL of the contact.""" googlePlusUrl: EntityFilterStringField """Gravatar profile URL of the contact.""" gravatarUrl: EntityFilterStringField """Klout profile URL of the contact.""" kloutUrl: EntityFilterStringField """LinkedIn profile id of the contact.""" linkedinId: EntityFilterStringField """LinkedIn profile URL of the contact.""" linkedinUrl: EntityFilterStringField """Pinterest profile URL of the contact.""" pinterestUrl: EntityFilterStringField """Quora profile URL of the contact.""" quoraUrl: EntityFilterStringField """Reddit profile URL of the contact.""" redditUrl: EntityFilterStringField """Skype contact URL or username of the contact.""" skypeUrl: EntityFilterStringField """SlideShare profile URL of the contact.""" slideshareUrl: EntityFilterStringField """Twitter (X) user id of the contact.""" twitterId: EntityFilterStringField """Twitter (X) profile URL of the contact.""" twitterUrl: EntityFilterStringField """Vimeo profile URL of the contact.""" vimeoUrl: EntityFilterStringField """WordPress site URL of the contact.""" wordpressUrl: EntityFilterStringField """XING profile URL of the contact.""" xingUrl: EntityFilterStringField """Yahoo profile URL of the contact.""" yahooUrl: EntityFilterStringField """Yelp profile URL of the contact.""" yelpUrl: EntityFilterStringField """YouTube channel URL of the contact.""" youtubeUrl: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for ContactAccountRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactAccountRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactAccountRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactAccountRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactAccountRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account the contact is linked to.""" accountId: EntityFilterStringField """Free-form note describing this contact-account link.""" comment: EntityFilterStringField """Id of the contact linked to the account.""" contactId: EntityFilterStringField """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: Boolean """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: Boolean """Job title or position the contact holds at the account.""" position: EntityFilterStringField """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrgRelationshipTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the contact is linked to. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Contact linked to the account. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Roles the contact holds within the linked account. Matches records where a related record meets these conditions. """ accountRoles: ContactAccountAccountRoleRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input OrgRelationshipTypeEnumFilterInput { """Matches any of the listed values.""" eq: [OrgRelationshipTypeEnum!] """Matches values that do not meet this condition.""" NOT: OrgRelationshipTypeEnumFilterInput } """ Filter conditions for ContactAccountAccountRoleRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactAccountAccountRoleRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactAccountAccountRoleRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactAccountAccountRoleRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactAccountAccountRoleRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the role assigned to the contact at the account.""" accountRoleId: EntityFilterStringField """Id of the contact-account link.""" contactAccountRelationId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Role assigned to the contact at the account. Matches records where a related record meets these conditions. """ accountRole: AccountRoleFilterInput """ Contact-account link this role assignment belongs to. Matches records where a related record meets these conditions. """ contactAccountRelation: ContactAccountRelationFilterInput } """ Filter conditions for AccountRole records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountRoleFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountRoleFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountRoleFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountRoleFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """Name of the entity and its default text representation.""" label: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for ContactSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared contact.""" contactId: EntityFilterStringField """ Access the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Contact being shared. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Sales unit the contact is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input SharingRoleEnumFilterInput { """Matches any of the listed values.""" eq: [SharingRoleEnum!] """Matches values that do not meet this condition.""" NOT: SharingRoleEnumFilterInput } """ Access a sharing entry gives the user or sales unit on the shared record. """ enum SharingRoleEnum { """Can view the record.""" Watcher """Can view and edit the record.""" Editor } """ Filter conditions for ContactSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the shared contact.""" contactId: EntityFilterStringField """ Access the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the contact is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Contact being shared. Matches records where a related record meets these conditions. """ contact: ContactFilterInput } """ Filter conditions for CloudObjectRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CloudObjectRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CloudObjectRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CloudObjectRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: CloudObjectRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the linked appointment or task, or empty when not linked.""" activityId: EntityFilterStringField """Id of the linked approval process.""" approvalProcessId: EntityFilterStringField """Id of the linked call.""" callId: EntityFilterStringField """ Id of the folder within the parent record, or empty when stored at the record root. """ cloudObjectFolderId: EntityFilterStringField """Id of the linked file.""" cloudObjectId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked custom entity record.""" customEntityId: EntityFilterStringField """Id of the linked email sequence.""" emailSequenceId: EntityFilterStringField """Id of the linked email template.""" emailTemplateId: EntityFilterStringField """Id of the linked field mapping.""" fieldMappingId: EntityFilterStringField """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: EntityFilterStringField """Id of the linked media record.""" mediaId: EntityFilterStringField """Id of the linked email or memo, or empty when not linked.""" messageId: EntityFilterStringField """Id of the online form field the file was uploaded into.""" onlineFormFieldId: EntityFilterStringField """Id of the linked online form submission.""" onlineFormId: EntityFilterStringField """Id of the linked sales process.""" processId: EntityFilterStringField """Id of the linked sales process template.""" processTemplateId: EntityFilterStringField """Id of the linked project.""" projectId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """Id of the linked report schedule.""" reportScheduleId: EntityFilterStringField """Id of the linked text message.""" textMessageId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the file is attached to, or empty when not attached to an account. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Appointment the file is attached to. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task the file is attached to. Set when activityId resolves to a Task. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Approval process the file is attached to. Matches records where a related record meets these conditions. """ approvalProcess: ApprovalProcessFilterInput """ Call the file is attached to (e.g. a call recording). Matches records where a related record meets these conditions. """ call: CallFilterInput """ Folder the file is filed under within the parent record, or empty when stored at the record root. Matches records where a related record meets these conditions. """ cloudObjectFolder: CloudObjectFolderFilterInput """ Cloud object (file) being linked. Matches records where a related record meets these conditions. """ cloudObject: CloudObjectFilterInput """ Contact the file is attached to, or empty when not attached to a contact. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record the file is attached to. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Email sequence the file is attached to. Matches records where a related record meets these conditions. """ emailSequence: EmailSequenceFilterInput """ Email template the file is attached to as a template attachment. Matches records where a related record meets these conditions. """ emailTemplate: EmailTemplateFilterInput """ Field mapping the file is attached to (e.g. an import file). Matches records where a related record meets these conditions. """ fieldMapping: FieldMappingFilterInput """ Lead the file is attached to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the file is attached to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Media record the file is attached to. Matches records where a related record meets these conditions. """ media: MediaFilterInput """ Email the file is attached to (e.g. an email attachment). Set when messageId resolves to an Email. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Memo the file is attached to. Set when messageId resolves to a Memo. Matches records where a related record meets these conditions. """ memo: MemoFilterInput """ Online form field the file was uploaded into. Matches records where a related record meets these conditions. """ onlineFormField: FieldFilterInput """ Online form submission the file was uploaded with. Matches records where a related record meets these conditions. """ onlineForm: OnlineFormFilterInput """ Sales process the file is attached to. Matches records where a related record meets these conditions. """ process: ProcessFilterInput """ Sales process template the file is attached to. Matches records where a related record meets these conditions. """ processTemplate: ProcessTemplateFilterInput """ Project the file is attached to. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote the file is attached to. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Report schedule the file is attached to (e.g. an exported report). Matches records where a related record meets these conditions. """ reportSchedule: ReportScheduleFilterInput """ Text message (SMS/MMS) the file is attached to. Matches records where a related record meets these conditions. """ textMessage: TextMessageFilterInput } """ Filter conditions for Appointment records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AppointmentFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AppointmentFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AppointmentFilterInput!] """Matches records that do not meet this filter.""" NOT: AppointmentFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment type.""" activityTypeId: EntityFilterStringField """Id of the currency exchange rate list applied to this appointment.""" currencyExchangeRatesListId: EntityFilterStringField """Free-form description of the appointment.""" description: EntityFilterStringField """Duration of the appointment, derived from start/end dates.""" duration: EntityFilterNumberField """End timestamp of the appointment.""" endDate: EntityFilterDateTimeField """ True when invitees are allowed to edit the appointment. Defaults to false. """ inviteesCanEdit: Boolean """ True when the recurrence series is still generating new occurrences. Read-only. """ isRecurrenceActive: Boolean """ True when this occurrence has been modified independently of the recurring series. Read-only. """ isRecurrenceException: Boolean """Free-text physical location of the appointment.""" location: EntityFilterStringField """ Original date of this occurrence in the recurring series. Set automatically. """ occurenceDate: EntityFilterDateTimeField """ Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails. """ organizer: EntityFilterStringField """Id of the appointment owner.""" ownerId: EntityFilterStringField """Id of the master appointment.""" recurrenceMasterId: EntityFilterStringField """ iCalendar RRULE string describing the recurrence pattern (e.g. "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments. """ recurrenceRule: EntityFilterStringField """IANA timezone the recurrence rule is evaluated in.""" recurrenceTzid: EntityFilterStringField """Id of the appointment schedule.""" scheduleId: EntityFilterStringField """ IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to evaluate availability against the schedule. """ scheduleTzid: EntityFilterStringField """Start timestamp of the appointment.""" startDate: EntityFilterDateTimeField """Short summary line shown in calendars and lists.""" subject: EntityFilterStringField """ Discriminator identifying the concrete record type — always "appointment" for Appointment records. Read-only; useful when consuming polymorphic Activity results. """ tableName: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Current status of the appointment (NotStarted, InProgress, Completed, Canceled). Read-only; derived from the start/end times and the deleted flag. """ status: ActivityStatusEnumFilterInput """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Appointment type that classifies this appointment. Drives form layout and icon. Matches records where a related record meets these conditions. """ activityType: AppointmentTypeFilterInput """ Currency exchange rate list used to convert monetary fields linked to this appointment. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Sales user who owns this appointment. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Master appointment of the recurring series this occurrence belongs to. Empty for standalone appointments and for the master itself. Matches records where a related record meets these conditions. """ recurrenceMaster: AppointmentFilterInput """ Appointment schedule (booking link) this appointment was created through, or empty for appointments created directly. Matches records where a related record meets these conditions. """ schedule: AppointmentScheduleFilterInput """ Sales unit this appointment is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Accounts this appointment is linked to. Matches records where a related record meets these conditions. """ accountRelations: ActivityRelationFilterInput """ Contacts this appointment is linked to. Matches records where a related record meets these conditions. """ contactRelations: ActivityRelationFilterInput """ Leads this appointment is linked to. Matches records where a related record meets these conditions. """ leadRelations: ActivityRelationFilterInput """ Opportunities this appointment is linked to. Matches records where a related record meets these conditions. """ opportunityRelations: ActivityRelationFilterInput """ Projects this appointment is linked to, including the per-objective ordering. Matches records where a related record meets these conditions. """ projectRelations: ActivityRelationFilterInput """ Quotes this appointment is linked to. Matches records where a related record meets these conditions. """ quoteRelations: ActivityRelationFilterInput """ Custom entity records this appointment is linked to. Matches records where a related record meets these conditions. """ customEntityRelations: ActivityRelationFilterInput """ Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record. Matches records where a related record meets these conditions. """ inviteesContacts: AppointmentContactInviteesRelationFilterInput """ Internal-user invitees on this appointment. Matches records where a related record meets these conditions. """ inviteesClients: AppointmentClientInviteesRelationFilterInput """ Reminder set by the current authenticated user for this appointment. Per-user; empty when no reminder has been set. Matches records where a related record meets these conditions. """ reminder: AppointmentReminderFilterInput """ Documents linked to this appointment. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Comments authored on this appointment. Matches records where a related record meets these conditions. """ comments: ActivityCommentFilterInput """ Tag labels applied to this appointment. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ActivityStatusEnumFilterInput { """Matches any of the listed values.""" eq: [ActivityStatusEnum!] """Matches values that do not meet this condition.""" NOT: ActivityStatusEnumFilterInput } """ Filter conditions for AppointmentType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AppointmentTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AppointmentTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AppointmentTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AppointmentTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Icon used to display appointments of this type in the UI.""" icon: ActivityTypeIconEnumFilterInput """ True when the appointment type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ActivityTypeIconEnumFilterInput { """Matches any of the listed values.""" eq: [ActivityTypeIconEnum!] """Matches values that do not meet this condition.""" NOT: ActivityTypeIconEnumFilterInput } """ Filter conditions for AppointmentSchedule records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AppointmentScheduleFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AppointmentScheduleFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AppointmentScheduleFilterInput!] """Matches records that do not meet this filter.""" NOT: AppointmentScheduleFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Description applied to appointments booked through this schedule.""" appointmentDescription: EntityFilterStringField """Duration of each booked appointment.""" appointmentDuration: EntityFilterNumberField """Location applied to appointments booked through this schedule.""" appointmentLocation: EntityFilterStringField """ Where booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. """ appointmentLocationType: AppointmentScheduleLocationTypeEnumFilterInput """Id of the user receiving the booking.""" appointmentOwnerId: EntityFilterStringField """Subject applied to appointments booked through this schedule.""" appointmentSubject: EntityFilterStringField """ When true, booked appointments use the scheduleName as their subject instead of appointmentSubject. """ appointmentSubjectUsesScheduleName: Boolean """ Id of the appointment type used for appointments booked through the schedule. """ appointmentTypeId: EntityFilterStringField """ IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined. """ availabilityTzid: EntityFilterStringField """ Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeAfter: EntityFilterNumberField """ Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeBefore: EntityFilterNumberField """ What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). """ confirmationPageType: AppointmentScheduleConfirmationPageTypeEnumFilterInput """ Custom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect. """ confirmationPageUrl: EntityFilterStringField """ Master switch for the schedule. Disabled schedules do not accept new bookings. """ isEnabled: Boolean """ Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). """ minimumNoticeTime: EntityFilterNumberField """ Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name. """ name: EntityFilterStringField """Id of the schedule owner.""" ownerId: EntityFilterStringField """ With Offset planning, how many days ahead the schedule remains bookable. """ planningDayOffset: EntityFilterNumberField """ Time window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period). """ planningType: AppointmentSchedulePlanningTypeEnumFilterInput """ True when a reminder email is sent to invitees ahead of the booked appointment. """ reminderEmailEnabled: Boolean """ Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType. """ reminderEmailOffset: EntityFilterNumberField """Time unit of reminderEmailOffset: Minute, Hour, Day or Week.""" reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnumFilterInput """ Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmailId: EntityFilterStringField """ Public-facing name of the schedule, shown to bookers on the booking page. """ scheduleName: EntityFilterStringField """ Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). """ timeIncrement: EntityFilterNumberField """ Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. """ type: AppointmentScheduleTypeEnumFilterInput """Public URL slug of the schedule, used to share the booking page.""" url: EntityFilterStringField """ User assigned as the appointment owner when a booking is made through this schedule. Matches records where a related record meets these conditions. """ appointmentOwner: ClientFilterInput """ Appointment type used when a booking is created. Matches records where a related record meets these conditions. """ appointmentType: AppointmentTypeFilterInput """ Owner of the schedule (typically the team member whose availability is exposed). Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. Matches records where a related record meets these conditions. """ replyCompanyEmail: CompanyEmailFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AppointmentScheduleLocationTypeEnumFilterInput { """Matches any of the listed values.""" eq: [AppointmentScheduleLocationTypeEnum!] """Matches values that do not meet this condition.""" NOT: AppointmentScheduleLocationTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AppointmentScheduleConfirmationPageTypeEnumFilterInput { """Matches any of the listed values.""" eq: [AppointmentScheduleConfirmationPageTypeEnum!] """Matches values that do not meet this condition.""" NOT: AppointmentScheduleConfirmationPageTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AppointmentSchedulePlanningTypeEnumFilterInput { """Matches any of the listed values.""" eq: [AppointmentSchedulePlanningTypeEnum!] """Matches values that do not meet this condition.""" NOT: AppointmentSchedulePlanningTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AppointmentScheduleReminderOffsetTypeEnumFilterInput { """Matches any of the listed values.""" eq: [AppointmentScheduleReminderOffsetTypeEnum!] """Matches values that do not meet this condition.""" NOT: AppointmentScheduleReminderOffsetTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AppointmentScheduleTypeEnumFilterInput { """Matches any of the listed values.""" eq: [AppointmentScheduleTypeEnum!] """Matches values that do not meet this condition.""" NOT: AppointmentScheduleTypeEnumFilterInput } """ Filter conditions for ActivityRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ActivityRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ActivityRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ActivityRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ActivityRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the appointment or task on this link.""" activityId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked custom entity record.""" customEntityId: EntityFilterStringField """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: EntityFilterStringField """Id of the linked project.""" projectId: EntityFilterStringField """ Id of the project objective the activity advances, or empty when it is not linked to one. """ projectObjectiveId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """ Display order of the activity within its project objective. Required only when projectId is set. """ sortOrder: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the activity is linked to, or empty when not linked to an account. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Appointment side of the link. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task side of the link. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Contact the activity is linked to, or empty when not linked to a contact. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record the activity is linked to, or empty. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Lead the activity is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the activity is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Project the activity is linked to, or empty when not linked to a project. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Project objective the activity advances, or empty. Matches records where a related record meets these conditions. """ projectObjective: ProjectObjectiveFilterInput """ Quote the activity is linked to, or empty when not linked to a quote. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Filter conditions for Task records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TaskFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TaskFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TaskFilterInput!] """Matches records that do not meet this filter.""" NOT: TaskFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the task type.""" activityTypeId: EntityFilterStringField """ Duration of the recorded call. Set automatically when the task is linked to a call log. """ callDuration: EntityFilterNumberField """Id of the linked call record.""" callId: EntityFilterStringField """ Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). """ callOutcomeId: EntityFilterStringField """Id of the currency exchange rate list applied to this task.""" currencyExchangeRatesListId: EntityFilterStringField """Free-form description of what the task entails.""" description: EntityFilterStringField """ Estimated duration of the task. Stored as a duration value (days/hours/minutes). """ duration: EntityFilterNumberField """Id of the task owner.""" ownerId: EntityFilterStringField """Priority level of the task: Low, Medium or High.""" priority: PriorityEnumFilterInput """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnumFilterInput """ Current status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done. """ status: TaskStatusEnumFilterInput """Short summary line shown in lists and notifications.""" subject: EntityFilterStringField """ Discriminator identifying the concrete record type — always "task" for Task records. Read-only; useful when consuming polymorphic Activity results. """ tableName: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Task type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon. Matches records where a related record meets these conditions. """ activityType: TaskTypeFilterInput """ Call record associated with this task when the task represents a phone call. Matches records where a related record meets these conditions. """ call: CallFilterInput """ Configurable outcome of the call (e.g. Reached, Voicemail, No Answer). Matches records where a related record meets these conditions. """ callOutcome: DataFilterInput """ Currency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Sales user who owns this task. May be empty when the task is unassigned and available for take-over. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales unit this task is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: TaskSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this task. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: TaskSharingClientRelationFilterInput """ Accounts this task is linked to. Matches records where a related record meets these conditions. """ accountRelations: ActivityRelationFilterInput """ Contacts this task is linked to. Matches records where a related record meets these conditions. """ contactRelations: ActivityRelationFilterInput """ Leads this task is linked to. Matches records where a related record meets these conditions. """ leadRelations: ActivityRelationFilterInput """ Opportunities this task is linked to. Matches records where a related record meets these conditions. """ opportunityRelations: ActivityRelationFilterInput """ Projects this task is linked to, including the per-objective ordering. Matches records where a related record meets these conditions. """ projectRelations: ActivityRelationFilterInput """ Quotes this task is linked to. Matches records where a related record meets these conditions. """ quoteRelations: ActivityRelationFilterInput """ Custom entity records this task is linked to. Matches records where a related record meets these conditions. """ customEntityRelations: ActivityRelationFilterInput """ Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. Matches records where a related record meets these conditions. """ reminder: TaskReminderFilterInput """ Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. Matches records where a related record meets these conditions. """ taskRecurrence: TaskRecurrenceFilterInput """ Documents linked to this task. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Comments authored on this task. Matches records where a related record meets these conditions. """ comments: ActivityCommentFilterInput """ Tag labels applied to this task. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input PriorityEnumFilterInput { """Matches any of the listed values.""" eq: [PriorityEnum!] """Matches values that do not meet this condition.""" NOT: PriorityEnumFilterInput } """Priority of a task.""" enum PriorityEnum { """Low priority.""" Low """Medium priority.""" Medium """High priority.""" High } """ Conditions on an enumeration field. Several conditions given together must all match. """ input TaskStatusEnumFilterInput { """Matches any of the listed values.""" eq: [TaskStatusEnum!] """Matches values that do not meet this condition.""" NOT: TaskStatusEnumFilterInput } """Status of a task.""" enum TaskStatusEnum { """Work on the task has not started.""" NotStarted """The task is being worked on.""" InProgress """The task is waiting on someone or something else.""" Waiting """The task is done.""" Completed """The task has been postponed.""" Deferred } """ Filter conditions for TaskType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TaskTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TaskTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TaskTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: TaskTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Icon used to display tasks of this type in the UI.""" icon: ActivityTypeIconEnumFilterInput """ True when the task type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for Call records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CallFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CallFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CallFilterInput!] """Matches records that do not meet this filter.""" NOT: CallFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the calling user.""" callerId: EntityFilterStringField """Id of the user the call was made with.""" clientId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: EntityFilterStringField """Id of the linked opportunity product line-item.""" opptyProductRelationId: EntityFilterStringField """External phone number called or received, in E.164 format.""" phoneNumber: EntityFilterStringField """Id of the linked product.""" productId: EntityFilterStringField """External transcription identifier from the calling provider.""" transcriptionId: EntityFilterStringField """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US"). """ transcriptionLanguage: EntityFilterStringField """AI-generated summary of the call transcription.""" transcriptionSummary: EntityFilterStringField """ Id of the call-log record from the calling provider that this call is associated with. """ twilioCallLogId: EntityFilterStringField """ Account the call is linked to, when applicable. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ User who initiated the call. Matches records where a related record meets these conditions. """ caller: ClientFilterInput """ User the call was made with, when the call was an internal user-to-user call. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Contact the call is linked to, when applicable. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Lead the call is linked to, when the call is associated with a lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the call is linked to, when the call is associated with an opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Specific opportunity line-item discussed on the call, when applicable. Matches records where a related record meets these conditions. """ opptyProductRelation: OpptyProductRelationFilterInput """ Product discussed on the call, when applicable. Matches records where a related record meets these conditions. """ product: ProductFilterInput } """ Filter conditions for Lead records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the currency exchange rate list applied to this lead.""" currencyExchangeRatesListId: EntityFilterStringField """Free-form description of the lead.""" description: EntityFilterStringField """ True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """User-set colored flag used to highlight the lead in lists and reports.""" labelFlag: LabelFlagEnumFilterInput """Time when an AI-suggested buying center was last applied to this lead.""" lastAiBuyingCenterApplied: EntityFilterDateTimeField """ Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). """ leadSourceId: EntityFilterStringField """ Id of the lead type that classifies the lead and drives which form, fields and lead process apply. """ leadTypeId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the lead owner.""" ownerId: EntityFilterStringField """ Free-text company email captured at lead creation when no Account record has been linked yet. """ quickAccountEmail: EntityFilterStringField """ Free-text company name captured at lead creation when no Account record has been linked yet. """ quickAccountName: EntityFilterStringField """ Free-text company phone captured at lead creation when no Account record has been linked yet. """ quickAccountPhone: EntityFilterStringField """ Free-text contact name captured at lead creation when no Contact record has been linked yet. """ quickContactName: EntityFilterStringField """ Free-text contact email captured at lead creation when no Contact record has been linked yet. """ quickEmail: EntityFilterStringField """ Free-text contact phone captured at lead creation when no Contact record has been linked yet. """ quickPhone: EntityFilterStringField """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. """ ranking: EntityFilterNumberField """ Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. """ reasonOfCloseDescription: EntityFilterStringField """ Id of the reason recorded when the lead is archived (lost), or empty when none was given. """ reasonOfCloseId: EntityFilterStringField """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnumFilterInput """Id of the lead process step.""" stepId: EntityFilterStringField """ Discriminator identifying the concrete record type — always "lead" for Lead records. Read-only; useful when consuming polymorphic LeadOppty results. """ tableName: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events. """ status: LeadStatusEnumFilterInput """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int """Matches records related to at least one of the listed records.""" relatedEntities: [EntityFilterRelatedField] """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space. Matches records where a related record meets these conditions. """ leadSource: DataFilterInput """ Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply. Matches records where a related record meets these conditions. """ leadType: LeadTypeFilterInput """ Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it. Matches records where a related record meets these conditions. """ reasonOfClose: DataFilterInput """ Step in the lead process the lead is currently in. Matches records where a related record meets these conditions. """ step: StepFilterInput """ Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Primary contact of this lead. Set automatically from the contact relation marked as primary. Matches records where a related record meets these conditions. """ primaryContact: ContactFilterInput """ Primary account of this lead. Set automatically from the account relation marked as primary. Matches records where a related record meets these conditions. """ primaryAccount: AccountFilterInput """ Contacts linked to this lead, including their roles and org-chart positions. Matches records where a related record meets these conditions. """ contactRelations: LeadOpptyContactRelationFilterInput """ Accounts linked to this lead, including the primary-account flag. Matches records where a related record meets these conditions. """ accountRelations: LeadOpptyAccountRelationFilterInput """ Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: LeadOpptySharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: LeadOpptySharingClientRelationFilterInput """ Documents linked to this lead. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Tag labels applied to this lead. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput """ Saved view profiles this lead currently matches. Matches records where a related record meets these conditions. """ staticProfiles: ProfileRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input LabelFlagEnumFilterInput { """Matches any of the listed values.""" eq: [LabelFlagEnum!] """Matches values that do not meet this condition.""" NOT: LabelFlagEnumFilterInput } """Flags that highlight a lead or opportunity; several can be combined.""" enum LabelFlagEnum { """Marked as a priority.""" Priority """Marked as hot.""" Hot """Marked as stalled.""" Stalled } """ Conditions on an enumeration field. Several conditions given together must all match. """ input LeadStatusEnumFilterInput { """Matches any of the listed values.""" eq: [LeadStatusEnum!] """Matches values that do not meet this condition.""" NOT: LeadStatusEnumFilterInput } """Status of a lead.""" enum LeadStatusEnum { """The lead is active.""" Open """The lead was archived as lost.""" Lost """The lead was qualified into an opportunity.""" Qualified } """ Filter conditions for LeadType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """True when the lost form is required on archiving leads of this type.""" formLostEnabled: Boolean """ True when the lead type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Id of the lead process that leads of this type follow.""" leadProcessId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Lead process (pipeline) this lead type follows. Matches records where a related record meets these conditions. """ leadProcess: LeadProcessFilterInput } """ Filter conditions for LeadProcess records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadProcessFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadProcessFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadProcessFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadProcessFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for Step records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input StepFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [StepFilterInput!] """Matches records that meet all of the listed filters.""" AND: [StepFilterInput!] """Matches records that do not meet this filter.""" NOT: StepFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-text description shown in the step UI.""" description: EntityFilterStringField """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: EntityFilterNumberField """Id of the opportunity pipeline.""" pipelineId: EntityFilterStringField """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: EntityFilterStringField """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: EntityFilterNumberField """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Lead process this step belongs to. Set when the step is part of a lead process. Matches records where a related record meets these conditions. """ leadProcess: LeadProcessFilterInput """ Opportunity pipeline this step belongs to. Set when the step is part of an opportunity pipeline. Matches records where a related record meets these conditions. """ pipeline: PipelineFilterInput """ Quote process this step belongs to. Set when the step is part of a quote process. Matches records where a related record meets these conditions. """ quoteProcess: QuoteProcessFilterInput """ Files attached to the step (e.g. step-specific documentation or templates). Matches records where a related record meets these conditions. """ documents: CloudObjectStepRelationFilterInput """ Checklist items the user must complete before moving a record out of this step. Matches records where a related record meets these conditions. """ stepChecklists: StepChecklistFilterInput } """ Filter conditions for Pipeline records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input PipelineFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [PipelineFilterInput!] """Matches records that meet all of the listed filters.""" AND: [PipelineFilterInput!] """Matches records that do not meet this filter.""" NOT: PipelineFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for QuoteProcess records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteProcessFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteProcessFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteProcessFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteProcessFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for CloudObjectStepRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CloudObjectStepRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CloudObjectStepRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CloudObjectStepRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: CloudObjectStepRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the attached file.""" cloudObjectId: EntityFilterStringField """Position of the file within the step's document list.""" sortOrder: EntityFilterNumberField """Id of the pipeline step.""" stepId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ File attached to the step. Matches records where a related record meets these conditions. """ cloudObject: CloudObjectFilterInput """ Pipeline step the file is attached to. Matches records where a related record meets these conditions. """ step: StepFilterInput } """ Filter conditions for StepChecklist records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input StepChecklistFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [StepChecklistFilterInput!] """Matches records that meet all of the listed filters.""" AND: [StepChecklistFilterInput!] """Matches records that do not meet this filter.""" NOT: StepChecklistFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: EntityFilterStringField """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: StepChecklistDocumentFormatEnumFilterInput """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: EntityFilterStringField """Free-text description shown alongside the checklist item.""" description: EntityFilterStringField """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: EntityFilterStringField """Id of the related field.""" fieldId: EntityFilterStringField """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: StepChecklistTypeEnumFilterInput """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: StepChecklistValidationEnumFilterInput """Display label of the checklist item.""" label: EntityFilterStringField """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: Boolean """Id of the related process.""" processId: EntityFilterStringField """Id of the recipient field.""" sendEmailFieldId: EntityFilterStringField """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: EntityFilterStringField """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: EntityFilterStringField """ Position of the checklist item within its step; lower values appear first. """ sortOrder: EntityFilterNumberField """Id of the pipeline or process step this checklist item belongs to.""" stepId: EntityFilterStringField """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: StepChecklistVisibilityEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment type that satisfies this checklist item. Set when activityTypeId resolves to an AppointmentType. Matches records where a related record meets these conditions. """ appointmentType: AppointmentTypeFilterInput """ Task type that satisfies this checklist item. Set when activityTypeId resolves to a TaskType. Matches records where a related record meets these conditions. """ taskType: TaskTypeFilterInput """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. Matches records where a related record meets these conditions. """ cloudObjectTemplate: CloudObjectTemplateFilterInput """ Email sequence the item should enroll the record into. Matches records where a related record meets these conditions. """ emailSequence: EmailSequenceFilterInput """ Field whose value satisfies this checklist item. Set when itemType is FieldType. Matches records where a related record meets these conditions. """ field: FieldFilterInput """ Automatizer process that completes the item once it has run for the record. Set when itemType is RunProcess. Matches records where a related record meets these conditions. """ process: ProcessFilterInput """ Field that supplies the recipient email address when the checklist item triggers sending an email. Matches records where a related record meets these conditions. """ sendEmailField: FieldFilterInput """ Contact or Account lookup field whose primary record supplies the recipient. When set, sendEmailField is read from that record instead of the Primary Contact or Primary Account. Only lookup fields with a primary record are valid. Matches records where a related record meets these conditions. """ sendEmailLookupField: FieldFilterInput """ Email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail. Matches records where a related record meets these conditions. """ sendEmailTemplate: EmailTemplateFilterInput """ Pipeline or process step this checklist item belongs to. Matches records where a related record meets these conditions. """ step: StepFilterInput """ Sales roles the checklist item is shown to. Empty means the item is shown to all roles. Matches records where a related record meets these conditions. """ salesRoles: StepChecklistSalesRoleRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input StepChecklistDocumentFormatEnumFilterInput { """Matches any of the listed values.""" eq: [StepChecklistDocumentFormatEnum!] """Matches values that do not meet this condition.""" NOT: StepChecklistDocumentFormatEnumFilterInput } """ File format of the document a checklist item generates from a document template. """ enum StepChecklistDocumentFormatEnum { """The document template's own format.""" Default """PDF.""" Pdf } """ Conditions on an enumeration field. Several conditions given together must all match. """ input StepChecklistTypeEnumFilterInput { """Matches any of the listed values.""" eq: [StepChecklistTypeEnum!] """Matches values that do not meet this condition.""" NOT: StepChecklistTypeEnumFilterInput } """Kind of sales step checklist item, which determines what completes it.""" enum StepChecklistTypeEnum { """Plain item, completed when a user checks it off.""" Default """ Completed through an activity of the selected task or appointment type. """ ActivityType """Completed when the selected field on the record has a value.""" FieldType """Completed when a note is created for the item.""" CreateNote """Completed when a document is attached for the item.""" AttachDocument """Completed when an email is sent for the item.""" SendEmail """ Completed when a document is generated from the selected document template. """ UseDocumentTemplate """Completed when the record is enrolled in the selected email sequence.""" EnrollToEmailSequence """ Completed when the selected Automatizer process has run for the record. """ RunProcess """ Completed when contacts with all the selected sales roles are linked to the lead or opportunity. """ MapSalesRole """ Item for building the influence map, completed when a user checks it off. """ CreateInfluenceMap } """ Conditions on an enumeration field. Several conditions given together must all match. """ input StepChecklistValidationEnumFilterInput { """Matches any of the listed values.""" eq: [StepChecklistValidationEnum!] """Matches values that do not meet this condition.""" NOT: StepChecklistValidationEnumFilterInput } """ Condition a step checklist item must meet before a record can move forward past the step; items without a value are optional. """ enum StepChecklistValidationEnum { """ The item must be completed, for example checked off or its field filled in. """ Required """ The activity linked to the item must be completed (task completed or appointment ended); allowed only for activity items. """ RelatedActivityCompleted """An activity must be linked to the item.""" RelatedActivityLinked } """ Conditions on an enumeration field. Several conditions given together must all match. """ input StepChecklistVisibilityEnumFilterInput { """Matches any of the listed values.""" eq: [StepChecklistVisibilityEnum!] """Matches values that do not meet this condition.""" NOT: StepChecklistVisibilityEnumFilterInput } """When a step checklist item is shown on a record.""" enum StepChecklistVisibilityEnum { """The item is always shown.""" Always """The item is shown only when the record matches visibilityCondition.""" Condition } """ Filter conditions for CloudObjectTemplate records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CloudObjectTemplateFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CloudObjectTemplateFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CloudObjectTemplateFilterInput!] """Matches records that do not meet this filter.""" NOT: CloudObjectTemplateFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the producing application.""" applicationId: EntityFilterStringField """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: EntityFilterStringField """Id of the uploading user.""" creatorId: EntityFilterStringField """File name (with extension) used when downloading the object.""" filename: EntityFilterStringField """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """Mime-type of the cloud object Is detected from content.""" mimeType: EntityFilterStringField """Size of the object in bytes.""" size: EntityFilterNumberField """ Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. """ status: CloudObjectTemplateStatusEnumFilterInput """ Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. """ templateEntityName: EntityNameEnum """ Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. Set on create only. """ type: CloudObjectTypeEnumFilterInput """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnumFilterInput """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. """ templateEntityApiName: String """ Application that produced the object (e.g. Online Forms). Matches records where a related record meets these conditions. """ application: ApplicationFilterInput """ Company-level folder that contains the object, when stored in the company document tree. Matches records where a related record meets these conditions. """ companyCloudObjectFolder: CloudObjectFolderFilterInput """ User who uploaded the object. Matches records where a related record meets these conditions. """ creator: ClientFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input CloudObjectTemplateStatusEnumFilterInput { """Matches any of the listed values.""" eq: [CloudObjectTemplateStatusEnum!] """Matches values that do not meet this condition.""" NOT: CloudObjectTemplateStatusEnumFilterInput } """Whether a document template is available for use.""" enum CloudObjectTemplateStatusEnum { """Template is available for generating documents.""" Active """Template is kept but not offered for generating documents.""" Inactive } """ Filter conditions for EmailSequence records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailSequenceFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailSequenceFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailSequenceFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailSequenceFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Reason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only. """ deactivationReason: EmailSequenceDeactivationReasonEnumFilterInput """Free-form description of the sequence.""" description: EntityFilterStringField """ Master switch for the sequence. Read-only on this surface — change it via the enable / disable mutations. """ isEnabled: Boolean """Timestamp of the most recent change to settings. Read-only.""" lastSchemaChange: EntityFilterDateTimeField """Timestamp of the most recent change to isEnabled. Read-only.""" lastStatusChange: EntityFilterDateTimeField """Display name of the email sequence.""" name: EntityFilterStringField """Id of the email sequence owner.""" ownerId: EntityFilterStringField """ Process category of the sequence (e.g. EmailSequence vs other process types). """ type: ProcessTypeEnumFilterInput """ Effective status of the sequence (e.g. Scheduled, Running, Expired, Error). Read-only; derived from the active-from / active-to settings and the most recent activity log status. """ status: ProcessStatusEnum """ Timestamp the sequence last produced a run (delivered or attempted a step). """ lastEmailSequenceRun: DateTime """ Fraction of delivered emails (0–1) where at least one tracked link was clicked. """ clickRate: Float """ Fraction of sent emails (0–1) that bounced (the recipient mailserver rejected them). """ bounceRate: Float """ Fraction of delivered emails (0–1) that recorded at least one open event. """ openRate: Float """Fraction of delivered emails (0–1) where the recipient replied.""" replyRate: Float """Fraction of delivered emails (0–1) where the recipient unsubscribed.""" unsubscribeRate: Float """ Total number of emails produced (queued) by the sequence across all steps. """ createdCount: Int """ Total number of emails actually delivered by the sequence across all steps. """ sentCount: Int """ Number of records (Accounts/Contacts/Leads/Opportunities) currently enrolled in this sequence. """ enrollCount: Int """ Entity name whose records trigger automatic enrollment into this sequence (e.g. "Lead", "Contact"). Empty when the sequence is manually enrolled only. """ triggerEntityName: EntityNameEnum """ Id of the field on the trigger entity whose value change drives enrollment (e.g. a step field on a Lead). Empty when no field-based trigger is configured. """ triggerFieldId: UUID """Number of steps configured in the sequence.""" stepCount: Int """ User who owns this email sequence. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Run history of the sequence — one log per scheduled execution. Matches records where a related record meets these conditions. """ activityLogs: EmailSequenceActivityLogFilterInput """ Attachments and other documents linked to this sequence. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Enrolment records (recipients currently or previously running through the sequence). Matches records where a related record meets these conditions. """ enrolled: EmailSequenceEnrolledFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailSequenceDeactivationReasonEnumFilterInput { """Matches any of the listed values.""" eq: [EmailSequenceDeactivationReasonEnum!] """Matches values that do not meet this condition.""" NOT: EmailSequenceDeactivationReasonEnumFilterInput } """Why an email sequence is currently disabled.""" enum EmailSequenceDeactivationReasonEnum { """The sequence is enabled.""" NoReason """A user disabled the sequence.""" Manual """The sequence was suspended automatically after repeated failed runs.""" TooManyErrors """ The sequence was suspended because the feature is no longer available in the space. """ DisabledFeature } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProcessTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ProcessTypeEnum!] """Matches values that do not meet this condition.""" NOT: ProcessTypeEnumFilterInput } """Scope of an Automatizer process.""" enum ProcessTypeEnum { """Owned by one user and started only by that user's own actions.""" Personal """ Shared for the whole space; its trigger decides whose actions start it. """ Space } """ Filter conditions for EmailSequenceActivityLog records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailSequenceActivityLogFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailSequenceActivityLogFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailSequenceActivityLogFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailSequenceActivityLogFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the user who initiated the run, or empty for runs triggered by automation. """ actorId: EntityFilterStringField """ Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. """ applicationId: EntityFilterStringField """Id of the email sequence this activity log belongs to.""" emailSequenceId: EntityFilterStringField """Timestamp when the run finished. Empty for runs still in progress.""" endTime: EntityFilterDateTimeField """ True when the run was a dry-run / test execution and did not produce real-side effects. """ isTestRun: Boolean """Timestamp when the run started.""" startTime: EntityFilterDateTimeField """Outcome of the run (e.g. Ok, Error, Cancelled).""" status: ProcessStatusEnumFilterInput """ Display name of the record this run enrolled (e.g. contact name). Read-only; computed by Coevera. """ recordName: String """ Email address of the record this run enrolled. Read-only; computed by Coevera. """ recordEmail: String """ User who initiated the run, or empty for runs triggered by automation. Matches records where a related record meets these conditions. """ actor: ClientFilterInput """ Application context the run was triggered in (e.g. browser, automation, third-party integration). Matches records where a related record meets these conditions. """ application: ApplicationFilterInput """ Email sequence this activity log belongs to. Matches records where a related record meets these conditions. """ emailSequence: EmailSequenceFilterInput """ Step-by-step log lines produced during the run. Matches records where a related record meets these conditions. """ lines: EmailSequenceActivityLogLineFilterInput } """ Filter conditions for EmailSequenceActivityLogLine records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailSequenceActivityLogLineFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailSequenceActivityLogLineFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailSequenceActivityLogLineFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailSequenceActivityLogLineFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the activity log this line belongs to.""" emailSequenceActivityLogId: EntityFilterStringField """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its log run.""" sortOrder: EntityFilterNumberField """Outcome of the step the line represents (e.g. Ok, Error, Skipped).""" status: ProcessStatusEnumFilterInput """ Activity log this line belongs to. Matches records where a related record meets these conditions. """ emailSequenceActivityLog: EmailSequenceActivityLogFilterInput } """ Filter conditions for EmailSequenceEnrolled records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailSequenceEnrolledFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailSequenceEnrolledFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailSequenceEnrolledFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailSequenceEnrolledFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the enrolled account.""" accountId: EntityFilterStringField """ Id of the user who triggered the enrolment, or empty for runs triggered by automation. """ actorId: EntityFilterStringField """ Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in. """ applicationId: EntityFilterStringField """Id of the enrolled contact.""" contactId: EntityFilterStringField """Id of the activity log run that produced this enrolment.""" emailSequenceActivityLogId: EntityFilterStringField """Id of the email sequence this enrolment belongs to.""" emailSequenceId: EntityFilterStringField """ Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active. """ endReason: EmailSequenceEndReasonEnumFilterInput """ Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active. """ endTime: EntityFilterDateTimeField """ Id of the enrolled record: the account, contact, lead, opportunity or project that is set. Read-only. """ entityId: EntityFilterStringField """Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only.""" entityType: BaseEntityTypeEnumFilterInput """ True when this enrolment is excluded from sequence statistics (e.g. after a stats reset). """ excludedFromStats: Boolean """Id of the enrolled lead.""" leadId: EntityFilterStringField """Id of the enrolled opportunity.""" opptyId: EntityFilterStringField """Id of the enrolled project.""" projectId: EntityFilterStringField """Timestamp when the enrolment started.""" startTime: EntityFilterDateTimeField """Number of steps the enrolment has reached. Read-only.""" stepCount: EntityFilterNumberField """ Display name of the enrolled record, formatted according to the calling user's preferred name format. Empty when the underlying record has been deleted. """ name: EntityFilterStringField """Email address used for delivery of this enrolment.""" address: EntityFilterStringField """ Zero-based index of the next step the enrolment will execute (i.e. one past the highest stepIndex recorded in EmailSequenceEnrolledStatus). Empty before the first step runs. """ stepIndex: Int """ Status of the enrolment's most recent sequence run (e.g. Ok, Warning, Error). Empty before the first run. """ status: ProcessStatusEnum """ Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entityType. """ entityName: EntityNameEnum """ Account that was enrolled, when the trigger entity is an Account; otherwise empty. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ User who triggered the enrolment, or empty for runs triggered by automation. Matches records where a related record meets these conditions. """ actor: ClientFilterInput """ Application context the enrolment was triggered in. Matches records where a related record meets these conditions. """ application: ApplicationFilterInput """ Contact that was enrolled, when the trigger entity is a Contact; otherwise empty. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Activity log run that produced this enrolment. Matches records where a related record meets these conditions. """ emailSequenceActivityLog: EmailSequenceActivityLogFilterInput """ Email sequence this enrolment belongs to. Matches records where a related record meets these conditions. """ emailSequence: EmailSequenceFilterInput """ Lead that was enrolled, when the trigger entity is a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Project that was enrolled, when the trigger entity is a Project; otherwise empty. Matches records where a related record meets these conditions. """ project: ProjectFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailSequenceEndReasonEnumFilterInput { """Matches any of the listed values.""" eq: [EmailSequenceEndReasonEnum!] """Matches values that do not meet this condition.""" NOT: EmailSequenceEndReasonEnumFilterInput } """Why a record's enrollment in an email sequence ended.""" enum EmailSequenceEndReasonEnum { """The enrollment has not ended; the record is still in the sequence.""" NoReason """ The record was removed before finishing, for example manually, by a process, by a step condition or because the sequence expired. """ Unenrolled """The record went through all steps of the sequence.""" Finished } """ Filter conditions for Opportunity records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpportunityFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpportunityFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpportunityFilterInput!] """Matches records that do not meet this filter.""" NOT: OpportunityFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the quote currently synchronized with this opportunity, or empty when no quote is active. A quote can be active on only one opportunity at a time. """ activeQuoteId: EntityFilterStringField """Id of the currency exchange rate list applied to this opportunity.""" currencyExchangeRatesListId: EntityFilterStringField """Free-form description of the opportunity.""" description: EntityFilterStringField """ True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. """ isValueAutoCalculate: Boolean """ User-set colored flag used to highlight the opportunity in lists and reports. """ labelFlag: LabelFlagEnumFilterInput """ Time when an AI-suggested buying center was last applied to this opportunity. """ lastAiBuyingCenterApplied: EntityFilterDateTimeField """Id of the lead source the opportunity originated from.""" leadSourceId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the opportunity type.""" opptyTypeId: EntityFilterStringField """Id of the opportunity owner.""" ownerId: EntityFilterStringField """ Id of the currency used for product line-item prices on this opportunity. """ productCurrencyId: EntityFilterStringField """ Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. """ productPriceListId: EntityFilterStringField """ Free-text company email captured at opportunity creation when no Account record has been linked yet. """ quickAccountEmail: EntityFilterStringField """ Free-text company name captured at opportunity creation when no Account record has been linked yet. """ quickAccountName: EntityFilterStringField """ Free-text company phone captured at opportunity creation when no Account record has been linked yet. """ quickAccountPhone: EntityFilterStringField """ Free-text contact name captured at opportunity creation when no Contact record has been linked yet. """ quickContactName: EntityFilterStringField """ Free-text contact email captured at opportunity creation when no Contact record has been linked yet. """ quickEmail: EntityFilterStringField """ Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. """ quickPhone: EntityFilterStringField """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. """ ranking: EntityFilterNumberField """Free-form note explaining why the opportunity was archived (lost).""" reasonOfCloseDescription: EntityFilterStringField """ Id of the reason of close option selected when the opportunity was archived (lost). """ reasonOfCloseId: EntityFilterStringField """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnumFilterInput """Id of the pipeline step.""" stepId: EntityFilterStringField """ Discriminator identifying the concrete record type — always "opportunity" for Opportunity records. Read-only; useful when consuming polymorphic LeadOppty results. """ tableName: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """ True when the opportunity has gone through the qualification step at least once. """ wasQualified: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int """ Id of the pipeline the opportunity runs in. Read-only; derived from the opportunity type. Useful as a filter when listing opportunities by pipeline. """ pipelineId: EntityFilterStringField """ Current status of the opportunity (Open, Won, Lost). Read-only; derived from the current pipeline step and the archived flag. """ status: OpptyStatusEnumFilterInput """Matches records related to at least one of the listed records.""" relatedEntities: [EntityFilterRelatedField] """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Quote currently used to drive the opportunity (e.g. for synchronisation of monetary fields). Empty when no quote is active. Matches records where a related record meets these conditions. """ activeQuote: QuoteFilterInput """ Currency exchange rate list used to convert monetary fields linked to this opportunity. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ How the opportunity originated (e.g. Website, Referral, Trade Show). Configurable per team space. Matches records where a related record meets these conditions. """ leadSource: DataFilterInput """ Opportunity type that classifies this opportunity. Each type maps to one pipeline and drives which form, fields and stages apply. Matches records where a related record meets these conditions. """ opptyType: OpportunityTypeFilterInput """ Sales user who owns this opportunity. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Currency used for product line-item prices on this opportunity. Matches records where a related record meets these conditions. """ productCurrency: CurrencyFilterInput """ Product price list used to populate prices for product line items added to this opportunity. Empty to use catalog defaults. Matches records where a related record meets these conditions. """ productPriceList: ProductPriceListFilterInput """ Configurable reason recorded when the opportunity is archived (lost). Required when the lost form mandates it. Matches records where a related record meets these conditions. """ reasonOfClose: DataFilterInput """ Pipeline step the opportunity is currently sitting in. Reaching the last step in the pipeline marks the opportunity as won; archiving sets it to lost. Matches records where a related record meets these conditions. """ step: StepFilterInput """ Sales unit this opportunity is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. Matches records where a related record meets these conditions. """ opptyRecurrence: OpptyRecurrenceFilterInput """ Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. Matches records where a related record meets these conditions. """ revenueSchedule: OpptyRevenueScheduleFilterInput """ Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when isValueAutoCalculate is true. Matches records where a related record meets these conditions. """ productRelations: OpptyProductRelationFilterInput """ Primary contact of this opportunity. Set automatically from the contact relation marked as primary. Matches records where a related record meets these conditions. """ primaryContact: ContactFilterInput """ Primary account of this opportunity. Set automatically from the account relation marked as primary. Matches records where a related record meets these conditions. """ primaryAccount: AccountFilterInput """ Contacts linked to this opportunity, including their roles and org-chart positions. Matches records where a related record meets these conditions. """ contactRelations: LeadOpptyContactRelationFilterInput """ Accounts linked to this opportunity, including the primary-account flag. Matches records where a related record meets these conditions. """ accountRelations: LeadOpptyAccountRelationFilterInput """ Documents linked to this opportunity. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Quotes prepared for this opportunity. Matches records where a related record meets these conditions. """ quoteRelations: QuoteFilterInput """ Sales units that have been granted shared access to this opportunity. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: LeadOpptySharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this opportunity. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: LeadOpptySharingClientRelationFilterInput """ Tag labels applied to this opportunity. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput """ Saved view profiles this opportunity currently matches. Matches records where a related record meets these conditions. """ staticProfiles: ProfileRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input OpptyStatusEnumFilterInput { """Matches any of the listed values.""" eq: [OpptyStatusEnum!] """Matches values that do not meet this condition.""" NOT: OpptyStatusEnumFilterInput } """Status of an opportunity.""" enum OpptyStatusEnum { """The opportunity is active in the pipeline.""" Open """The opportunity was archived without being won.""" Lost """The opportunity reached the last step of its pipeline.""" Won } """ Filter conditions for Quote records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: EntityFilterStringField """Free-form description of the quote.""" description: EntityFilterStringField """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the opportunity.""" opptyId: EntityFilterStringField """Id of the quote owner.""" ownerId: EntityFilterStringField """Id of the currency used for product line-item prices on this quote.""" productCurrencyId: EntityFilterStringField """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: EntityFilterStringField """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: EntityFilterStringField """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: EntityFilterStringField """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: EntityFilterStringField """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: EntityFilterStringField """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: EntityFilterStringField """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: EntityFilterStringField """ Auto-generated sequential identifier of the quote, used for human-readable reference. """ quoteNumber: EntityFilterStringField """Id of the quote type that classifies this quote.""" quoteTypeId: EntityFilterStringField """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: EntityFilterStringField """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: EntityFilterStringField """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnumFilterInput """Id of the quote-process step.""" stepId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Id of the quote process the quote runs in. Read-only; derived from the quote type. Useful as a filter when listing quotes by process. """ pipelineId: EntityFilterStringField """ Current status of the quote (Open, Lost, Accepted). Read-only; derived from the current step and the archived flag. """ status: QuoteStatusEnumFilterInput """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Currency exchange rate list used to convert monetary fields linked to this quote. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Opportunity this quote was prepared for. Empty for standalone quotes. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Sales user who owns this quote. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Currency used for product line-item prices on this quote. Matches records where a related record meets these conditions. """ productCurrency: CurrencyFilterInput """ Product price list used to populate prices for product line items added to this quote. Empty to use catalog defaults. Matches records where a related record meets these conditions. """ productPriceList: ProductPriceListFilterInput """ Quote type that classifies this quote. Each type maps to one quote process and drives which form, fields and stages apply. Matches records where a related record meets these conditions. """ quoteType: QuoteTypeFilterInput """ Configurable reason recorded when the quote is archived (lost). Required when the lost form mandates it. Matches records where a related record meets these conditions. """ reasonOfClose: DataFilterInput """ Quote-process step the quote is currently sitting in. Reaching the last step in the process marks the quote as accepted. Matches records where a related record meets these conditions. """ step: StepFilterInput """ Sales unit this quote is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to totalAmount. Matches records where a related record meets these conditions. """ productRelations: OpptyProductRelationFilterInput """ Primary contact of this quote. Set automatically from the contact relation marked as primary. Matches records where a related record meets these conditions. """ primaryContact: ContactFilterInput """ Primary account of this quote. Set automatically from the account relation marked as primary. Matches records where a related record meets these conditions. """ primaryAccount: AccountFilterInput """ Contacts linked to this quote. Matches records where a related record meets these conditions. """ contactRelations: QuoteContactRelationFilterInput """ Accounts linked to this quote, including the primary-account flag. Matches records where a related record meets these conditions. """ accountRelations: QuoteAccountRelationFilterInput """ Documents linked to this quote. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Sales units that have been granted shared access to this quote. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: QuoteSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this quote. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: QuoteSharingClientRelationFilterInput """ Saved view profiles this quote currently matches. Matches records where a related record meets these conditions. """ staticProfiles: ProfileRelationFilterInput """ Tag labels applied to this quote. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input QuoteStatusEnumFilterInput { """Matches any of the listed values.""" eq: [QuoteStatusEnum!] """Matches values that do not meet this condition.""" NOT: QuoteStatusEnumFilterInput } """Status of a quote.""" enum QuoteStatusEnum { """The quote is active.""" Open """The quote was archived without being accepted.""" Lost """The quote reached the last step of its quote process.""" Accepted } """ Filter conditions for ProductPriceList records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProductPriceListFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProductPriceListFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProductPriceListFilterInput!] """Matches records that do not meet this filter.""" NOT: ProductPriceListFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-form description of the price list.""" description: EntityFilterStringField """ Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates. """ isActive: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled). """ type: ProductPriceListTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ True for the team space default price list, which cannot be deleted. Read-only. """ isDefault: Boolean """ Effective status of the price list (Active, Inactive, Scheduled, Expired). Read-only; derived from isActive and the start/end dates. """ status: ProductPriceListStatusEnum """ Per-product, per-currency prices configured in the price list. Matches records where a related record meets these conditions. """ productPriceListPrices: ProductPriceListPriceFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProductPriceListTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ProductPriceListTypeEnum!] """Matches values that do not meet this condition.""" NOT: ProductPriceListTypeEnumFilterInput } """Kind of price list.""" enum ProductPriceListTypeEnum { """Regular price list that offers product prices to matching records.""" Standard """ Price schedule with special prices; while active, its lowest applicable price takes precedence over standard price lists. """ Scheduled } """Effective status of a price list.""" enum ProductPriceListStatusEnum { """The price list is switched on and within its validity dates.""" Active """The price list is switched off.""" Inactive """The price list's start date is in the future.""" Scheduled """The price list's end date has passed.""" Expired } """ Filter conditions for ProductPriceListPrice records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProductPriceListPriceFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProductPriceListPriceFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProductPriceListPriceFilterInput!] """Matches records that do not meet this filter.""" NOT: ProductPriceListPriceFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the currency the price is denominated in.""" currencyId: EntityFilterStringField """ Price amount stored at 6-decimal precision; values set via the API are rounded. """ price: EntityFilterNumberField """Id of the product the price applies to.""" productId: EntityFilterStringField """Id of the price list this price belongs to.""" productPriceListId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Currency the price value is denominated in. Matches records where a related record meets these conditions. """ currency: CurrencyFilterInput """ Product the price applies to. Matches records where a related record meets these conditions. """ product: ProductFilterInput """ Price list the price belongs to. Matches records where a related record meets these conditions. """ productPriceList: ProductPriceListFilterInput } """ Filter conditions for Product records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProductFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProductFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProductFilterInput!] """Matches records that do not meet this filter.""" NOT: ProductFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Whether this product can be added to all pipelines or only the explicitly linked subset (see productPipelineRelations). """ allowedPipelines: AccessPipelinesEnumFilterInput """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: EntityFilterStringField """Free-form description of the product.""" description: EntityFilterStringField """Name of the product, shown in catalogues and pickers.""" name: EntityFilterStringField """Id of the product picture document.""" pictureId: EntityFilterStringField """ Id of the product category this product belongs to, or empty when it is not categorized. """ productCategoryId: EntityFilterStringField """Id of the product type that classifies this product.""" productTypeId: EntityFilterStringField """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: EntityFilterStringField """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Id of a pipeline. Matches products that can be used in it: products available in all pipelines and products assigned to this pipeline. """ allowedForPipeline: UUID """Filters products by whether their product type has been deleted.""" isTypeDeleted: Boolean """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Currency exchange rate list used to convert monetary fields linked to this product. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Product picture. Matches records where a related record meets these conditions. """ picture: CloudObjectFilterInput """ Product category this product belongs to. Categories form a hierarchy used in the catalog browser. Matches records where a related record meets these conditions. """ productCategory: ProductCategoryFilterInput """ Product type that classifies this product. Product types are configurable per team space and drive which form, fields and product-line behavior apply. Matches records where a related record meets these conditions. """ productType: ProductTypeFilterInput """ Deprecated pipeline connection. Matches records where a related record meets these conditions. """ productPipelineRelations: ProductPipelineRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessPipelinesEnumFilterInput { """Matches any of the listed values.""" eq: [AccessPipelinesEnum!] """Matches values that do not meet this condition.""" NOT: AccessPipelinesEnumFilterInput } """Which pipelines a product can be added to.""" enum AccessPipelinesEnum { """The product can be added in all pipelines.""" All """The product can be added only in the pipelines it is linked to.""" Selected } """ Filter conditions for ProductCategory records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProductCategoryFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProductCategoryFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProductCategoryFilterInput!] """Matches records that do not meet this filter.""" NOT: ProductCategoryFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the parent category.""" parentId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Parent category in the catalog hierarchy. Empty for top-level categories. Matches records where a related record meets these conditions. """ parent: ProductCategoryFilterInput """ All Products in this category. Matches records where a related record meets these conditions. """ productRelations: ProductFilterInput } """ Filter conditions for ProductType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProductTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProductTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProductTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: ProductTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ True when the product type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the paired opportunity/quote line-item type.""" opptyProductRelationTypeId: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Opportunity / quote line-item type paired with this product type. Drives the form used when adding products of this type as line items. Matches records where a related record meets these conditions. """ opptyProductRelationType: OpptyProductRelationTypeFilterInput } """ Filter conditions for OpptyProductRelationType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyProductRelationTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyProductRelationTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyProductRelationTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyProductRelationTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ True when the line-item type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Product type paired with this line-item type. Matches records where a related record meets these conditions. """ productType: ProductTypeFilterInput } """ Filter conditions for ProductPipelineRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProductPipelineRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProductPipelineRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProductPipelineRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProductPipelineRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the pipeline in which the product can be added as a line item.""" pipelineId: EntityFilterStringField """Id of the product made available in the pipeline.""" productId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Pipeline in which the product can be added as a line item. Matches records where a related record meets these conditions. """ pipeline: PipelineFilterInput """ Product available in the linked pipeline. Matches records where a related record meets these conditions. """ product: ProductFilterInput } """ Filter conditions for QuoteType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """True when the lost form is required on archiving quotes of this type.""" formLostEnabled: Boolean """ True when the quote type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the quote process that quotes of this type follow.""" quoteProcessId: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Quote process (pipeline) this quote type follows. Matches records where a related record meets these conditions. """ quoteProcess: QuoteProcessFilterInput } """ Filter conditions for OpptyProductRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyProductRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyProductRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyProductRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyProductRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Total amount of the line item (price * quantity, with discounts applied). """ amount: EntityFilterNumberField """Free-form note describing this line item.""" comment: EntityFilterStringField """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: EntityFilterStringField """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: EntityFilterStringField """ Id of the online form submission this line item came from, or empty when it was not created through a form. """ onlineFormId: EntityFilterStringField """Id of the opportunity.""" opptyId: EntityFilterStringField """Id of the line-item type.""" opptyProductRelationTypeId: EntityFilterStringField """Id of the paired line item.""" pairedOpptyProductRelationId: EntityFilterStringField """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: EntityFilterNumberField """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: EntityFilterStringField """Number of product units on this line item.""" quantity: EntityFilterNumberField """ Id of the quote this line item belongs to. Mutually exclusive with opptyId. """ quoteId: EntityFilterStringField """ Identifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote). """ sectionId: EntityFilterStringField """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Absolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountValue: Float """ Percentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountPercentage: Float """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Online form field that produced this line item, or empty when not applicable. Matches records where a related record meets these conditions. """ onlineFormField: FieldFilterInput """ Online form this line item came from when the related opportunity was created through a form submission, or empty otherwise. Matches records where a related record meets these conditions. """ onlineForm: OnlineFormFilterInput """ Opportunity this line item belongs to. Set on create; mutually exclusive with quote. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Line-item type that drives the form layout for this product line. Resolved from the product type on create. Matches records where a related record meets these conditions. """ opptyProductRelationType: OpptyProductRelationTypeFilterInput """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. Matches records where a related record meets these conditions. """ pairedOpptyProductRelation: OpptyProductRelationFilterInput """ Product on this line item. Set on create; cannot be changed afterwards. Matches records where a related record meets these conditions. """ product: ProductFilterInput """ Quote this line item belongs to. Set on create; mutually exclusive with opportunity. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. Matches records where a related record meets these conditions. """ revenueSchedule: OpptyProductRelationRevenueScheduleFilterInput } """ Filter conditions for Field records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input FieldFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [FieldFilterInput!] """Matches records that meet all of the listed filters.""" AND: [FieldFilterInput!] """Matches records that do not meet this filter.""" NOT: FieldFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """True when the field is marked as deleted (soft-delete).""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ 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. """ entityName: EntityFilterStringField """Immutable and generated name. This name is used for integrations.""" apiName: EntityFilterStringField """User friendly name for field.""" name: EntityFilterStringField """ When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown. """ useLang: EntityFilterNumberField """ Storage column name for the field; used as the filter key in API queries. """ columnName: EntityFilterStringField """ Storage origin of the field: on the main entity record, on the custom-field data record, or computed. """ columnSource: EntityFilterNumberField """ For relation-typed fields, identifier of the relation kind that connects this entity to the related entity. Empty for non-relation fields. """ relationId: EntityFilterStringField """ For relation-typed fields, the entity the field points to (e.g. Contact, Account). Empty for non-relation fields. """ relationWithEntityId: EntityFilterStringField """ 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. """ sharedWithFieldId: EntityFilterStringField """ Whether the field is System (built-in, immutable), Protected (built-in, limited changes), or Custom (user-created). """ systemType: EntityFilterNumberField """ 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 """ typeId: EntityFilterStringField """ 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. """ compositeFieldId: EntityFilterStringField """Optional custom data set id can be set.""" dataSetId: EntityFilterStringField """ For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. """ parentOptionsFieldId: EntityFilterStringField """Calculated formula used for fields which supports calculation.""" calcFormula: EntityFilterStringField """ 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. """ defaultValue: EntityFilterStringField """ For sequence-typed fields, id grouping the FieldSequence rows that drive auto-numbering for this field. """ sequenceSetId: EntityFilterStringField """ True when the field cannot be made optional (enforced by the platform). """ systemRequired: Boolean """ True when the field configuration is published; false while the field exists only as an unpublished draft. """ isPublished: Boolean """ True when the field cannot be made writable (enforced by the platform). """ systemReadonly: Boolean """If this field is allowed in global search.""" useInGlobalSearch: Boolean """ If true, then there will be an API validation if value of entity is unique. """ isUnique: Boolean """ Deprecated - previously returned sequence pattern used for sequence type of field. """ sequencePattern: EntityFilterStringField } """ Filter conditions for OpptyProductRelationRevenueSchedule records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyProductRelationRevenueScheduleFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyProductRelationRevenueScheduleFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyProductRelationRevenueScheduleFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyProductRelationRevenueScheduleFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity. Must match with OpptyProductRelation id.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Number of periods the line-item amount is split into.""" periodCount: EntityFilterNumberField """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Periods produced by this revenue schedule, ordered by date. Matches records where a related record meets these conditions. """ periods: OpptyProductRelationRevenueSchedulePeriodFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input RevenueSchedulePeriodTypeEnumFilterInput { """Matches any of the listed values.""" eq: [RevenueSchedulePeriodTypeEnum!] """Matches values that do not meet this condition.""" NOT: RevenueSchedulePeriodTypeEnumFilterInput } """ Length of each period an opportunity or product revenue schedule is split into. """ enum RevenueSchedulePeriodTypeEnum { """Revenue is split into monthly periods.""" Month """Revenue is split into quarterly periods.""" Quarter """Revenue is split into yearly periods.""" Year } """ Filter conditions for OpptyProductRelationRevenueSchedulePeriod records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyProductRelationRevenueSchedulePeriodFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyProductRelationRevenueSchedulePeriodFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyProductRelationRevenueSchedulePeriodFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyProductRelationRevenueSchedulePeriodFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the parent revenue schedule.""" opptyProductRelationRevenueScheduleId: EntityFilterStringField """Identifier linking the period to the recognition transaction.""" transactionId: EntityFilterStringField """Amount recognised in this period.""" value: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Parent revenue schedule this period belongs to. Matches records where a related record meets these conditions. """ opptyProductRelationRevenueSchedule: OpptyProductRelationRevenueScheduleFilterInput } """ Filter conditions for QuoteContactRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteContactRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteContactRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteContactRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteContactRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the contact linked to this quote.""" contactId: EntityFilterStringField """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the quote the contact is linked to.""" quoteId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Contact linked to the quote. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Quote the contact is linked to. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Filter conditions for QuoteAccountRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteAccountRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteAccountRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteAccountRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteAccountRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account linked to this quote.""" accountId: EntityFilterStringField """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the quote the account is linked to.""" quoteId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account linked to the quote. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Quote the account is linked to. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Filter conditions for QuoteSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared quote.""" quoteId: EntityFilterStringField """ Access the sharing gives the sales unit on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Quote being shared. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Sales unit the quote is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for QuoteSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the shared quote.""" quoteId: EntityFilterStringField """ Access the sharing gives the user on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the quote is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Quote being shared. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Filter conditions for ProfileRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProfileRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProfileRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProfileRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProfileRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked custom entity record.""" customEntityId: EntityFilterStringField """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: EntityFilterStringField """Id of the screen profile.""" profileId: EntityFilterStringField """Id of the linked project.""" projectId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """ Account this profile is linked to, when applicable. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Contact this profile is linked to, when applicable. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record this profile is linked to, when applicable. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Screen profile this relation links to a specific record. Matches records where a related record meets these conditions. """ profile: ProfileFilterInput """ Project this profile is linked to, when applicable. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote this profile is linked to, when applicable. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Filter conditions for CustomEntity records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CustomEntityFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CustomEntityFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CustomEntityFilterInput!] """Matches records that do not meet this filter.""" NOT: CustomEntityFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the currency exchange rate list applied to this record.""" currencyExchangeRatesListId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the sales user who owns the custom entity record.""" ownerId: EntityFilterStringField """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnumFilterInput """ Discriminator identifying which custom entity type this record belongs to. Read-only; matches CustomEntityType.entityApiName and is used as the entity name in REST and GraphQL queries. """ tableName: EntityFilterStringField """Id of the custom entity type.""" typeId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Sales user who owns this custom entity record. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records. Matches records where a related record meets these conditions. """ type: CustomEntityTypeFilterInput """ Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Sales units that have been granted shared access to this custom entity record. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: CustomEntitySharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this custom entity record. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: CustomEntitySharingClientRelationFilterInput """ Documents linked to this custom entity record. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Saved view profiles this custom entity record currently matches. Matches records where a related record meets these conditions. """ staticProfiles: ProfileRelationFilterInput """ Tag labels applied to this custom entity record. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput } """ Filter conditions for CustomEntityType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CustomEntityTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CustomEntityTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CustomEntityTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: CustomEntityTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ True when the custom entity type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean } """ Filter conditions for CustomEntitySharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CustomEntitySharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CustomEntitySharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CustomEntitySharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: CustomEntitySharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared custom entity record.""" customEntityId: EntityFilterStringField """ Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Custom entity record being shared. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Sales unit the custom entity record is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for CustomEntitySharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CustomEntitySharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CustomEntitySharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CustomEntitySharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: CustomEntitySharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the shared custom entity record.""" customEntityId: EntityFilterStringField """ Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the custom entity record is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Custom entity record being shared. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput } """ Filter conditions for TagRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TagRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TagRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TagRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: TagRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the linked appointment.""" appointmentId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked custom entity record.""" customEntityId: EntityFilterStringField """Id of the linked email.""" emailId: EntityFilterStringField """Id of the linked lead.""" leadId: EntityFilterStringField """Id of the linked opportunity.""" opptyId: EntityFilterStringField """Id of the linked sales process.""" processId: EntityFilterStringField """Id of the linked project.""" projectId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """Id of the linked solution.""" solutionId: EntityFilterStringField """Id of the tag attached to the record.""" tagId: EntityFilterStringField """Id of the linked task.""" taskId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the tag is attached to, or empty when not attached to an account. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Appointment the tag is attached to, or empty when not attached to an appointment. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Contact the tag is attached to, or empty when not attached to a contact. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record the tag is attached to, or empty when not attached to a custom entity record. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Email the tag is attached to, or empty when not attached to an email. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Lead the tag is attached to, or empty when not attached to a lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the tag is attached to, or empty when not attached to an opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Sales process the tag is attached to, or empty when not attached to a process. Matches records where a related record meets these conditions. """ process: ProcessFilterInput """ Project the tag is attached to, or empty when not attached to a project. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote the tag is attached to, or empty when not attached to a quote. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Solution the tag is attached to, or empty when not attached to a solution. Matches records where a related record meets these conditions. """ solution: SolutionFilterInput """ Tag being attached to the record. Matches records where a related record meets these conditions. """ tag: TagFilterInput """ Task the tag is attached to, or empty when not attached to a task. Matches records where a related record meets these conditions. """ task: TaskFilterInput } """ Filter conditions for Process records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProcessFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProcessFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProcessFilterInput!] """Matches records that do not meet this filter.""" NOT: ProcessFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Why the process is disabled: turned off by a user, suspended after repeated failed runs, or suspended because Automatizer was switched off for the space. NoReason while enabled; read-only. """ deactivationReason: ProcessDeactivationReasonEnumFilterInput """Free-text description shown alongside the process.""" description: EntityFilterStringField """ When true, the process actively responds to its trigger; when false, the process is paused. Toggle via enable/disable mutations. """ isEnabled: Boolean """Timestamp of the most recent change to settings.""" lastSchemaChange: EntityFilterDateTimeField """Timestamp of the most recent change to isEnabled.""" lastStatusChange: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """ Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. """ type: ProcessTypeEnumFilterInput """ Timestamp of the most recent execution of this process. Empty when never run. """ lastProcessRun: DateTime """ Overall status of the process, derived from its most recent runs since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are no runs. """ status: ProcessStatusEnum """ For record-triggered processes, the event that starts the process: Create, Update, CreateOrUpdate or Delete, or EmailSent / EmailReceived for email-triggered processes. Empty for other trigger types. """ recordTriggerEvent: ProcessRecordTriggerEventEnum """ What starts the process: a record event (ProcessRecordTrigger), a schedule (ProcessScheduleTrigger), a user on selected records (ProcessManualTrigger) or an online form submission (ProcessOnlineFormTrigger). """ triggerType: ProcessTriggerTypeEnum """ For record-based triggers, the entity whose records fire the process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: EntityNameEnum """ API name of the trigger entity (useful for custom entities where this differs from triggerEntityName). Empty for non-record triggers. """ triggerEntityApiName: String """ User who owns the process. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Activity log runs (one per process execution) recorded for this process. Matches records where a related record meets these conditions. """ activityLogs: ProcessActivityLogFilterInput """ Tags attached to the process for organisation/filtering. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput """ Files attached to the process (e.g. process documentation). Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProcessDeactivationReasonEnumFilterInput { """Matches any of the listed values.""" eq: [ProcessDeactivationReasonEnum!] """Matches values that do not meet this condition.""" NOT: ProcessDeactivationReasonEnumFilterInput } """Why an Automatizer process is currently disabled.""" enum ProcessDeactivationReasonEnum { """The process is enabled.""" NoReason """A user disabled the process.""" Manual """ The process was suspended automatically after its last 20 record-triggered runs failed. """ TooManyErrors """ The process was suspended because Automatizer was switched off for the space. """ DisabledFeature } """What starts an Automatizer process.""" enum ProcessTriggerTypeEnum { """A record event, such as create, update or delete.""" ProcessRecordTrigger """A schedule.""" ProcessScheduleTrigger """A user starting it manually on selected records.""" ProcessManualTrigger """An online form submission.""" ProcessOnlineFormTrigger } """ Filter conditions for ProcessActivityLog records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProcessActivityLogFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProcessActivityLogFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProcessActivityLogFilterInput!] """Matches records that do not meet this filter.""" NOT: ProcessActivityLogFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the user who triggered the run, or empty for runs triggered by automation. """ actorId: EntityFilterStringField """ Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. """ applicationId: EntityFilterStringField """Total CPU time consumed by the run, in seconds.""" cpuRunTime: EntityFilterNumberField """ Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). """ endTime: EntityFilterDateTimeField """ True when the run was triggered as a test (results are not persisted to records). """ isTestRun: Boolean """Id of the Automatizer process whose run this log records.""" processId: EntityFilterStringField """ Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. """ runId: EntityFilterStringField """Timestamp the run started.""" startTime: EntityFilterDateTimeField """ Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. """ status: ProcessStatusEnumFilterInput """ Name of the trigger record (extracted from the first log line) for display in activity log lists. """ recordName: String """ User who triggered the run, or empty for runs triggered by automation. Matches records where a related record meets these conditions. """ actor: ClientFilterInput """ Application context the run was triggered in. Matches records where a related record meets these conditions. """ application: ApplicationFilterInput """ Process whose execution this log records. Matches records where a related record meets these conditions. """ process: ProcessFilterInput """ Activity log lines describing each step taken in this run (visible only). Matches records where a related record meets these conditions. """ lines: ProcessActivityLogLineFilterInput } """ Filter conditions for ProcessActivityLogLine records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProcessActivityLogLineFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProcessActivityLogLineFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProcessActivityLogLineFilterInput!] """Matches records that do not meet this filter.""" NOT: ProcessActivityLogLineFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: EntityFilterDateTimeField """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the process run (activity log) this line belongs to.""" processActivityLogId: EntityFilterStringField """Position of the line within its log run.""" sortOrder: EntityFilterNumberField """ Result of the process step recorded by this line, such as Ok, Warning (for example a scheduled action that was canceled) or Error. """ status: ProcessStatusEnumFilterInput """ Activity log run this line belongs to. Matches records where a related record meets these conditions. """ processActivityLog: ProcessActivityLogFilterInput } """ Filter conditions for Project records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the related account.""" accountId: EntityFilterStringField """Id of the currency exchange rate list applied to this project.""" currencyExchangeRatesListId: EntityFilterStringField """Free-form description of the project.""" description: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the project owner.""" ownerId: EntityFilterStringField """Id of the project type that classifies this project.""" projectTypeId: EntityFilterStringField """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int """ Current status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress. """ status: ProjectStatusEnumFilterInput """ Conditions on custom fields, each identified by its api name. All listed conditions must match. """ withCustom: [CustomField!] """ Account this project is delivered for, or empty for internal projects without an external account. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Currency exchange rate list used to convert monetary fields linked to this project. Empty to inherit the team space default. Matches records where a related record meets these conditions. """ currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput """ Sales user who owns this project. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Project type that classifies this project. Project types are configurable per team space and drive which form, fields and objectives apply. Matches records where a related record meets these conditions. """ projectType: ProjectTypeFilterInput """ Sales unit this project is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput """ Documents linked to this project. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Sales units that have been granted shared access to this project. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions. """ sharingUnits: ProjectSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this project. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions. """ sharingClients: ProjectSharingClientRelationFilterInput """ Primary contact of this project. Set automatically from the contact relation marked as primary. Matches records where a related record meets these conditions. """ primaryContact: ContactFilterInput """ Contacts linked to this project, including the primary-contact flag. Matches records where a related record meets these conditions. """ contactRelations: ProjectContactRelationFilterInput """ Tag labels applied to this project. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput """ Saved view profiles this project currently matches. Matches records where a related record meets these conditions. """ staticProfiles: ProfileRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProjectStatusEnumFilterInput { """Matches any of the listed values.""" eq: [ProjectStatusEnum!] """Matches values that do not meet this condition.""" NOT: ProjectStatusEnumFilterInput } """Status of a project, derived from its dates and completion.""" enum ProjectStatusEnum { """The project's start date is in the future.""" NotStarted """The project is running.""" InProgress """The project is marked completed or its end date has passed.""" Completed } """ Filter conditions for ProjectType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). """ icon: ProjectTypeIconEnumFilterInput """ True when the project type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProjectTypeIconEnumFilterInput { """Matches any of the listed values.""" eq: [ProjectTypeIconEnum!] """Matches values that do not meet this condition.""" NOT: ProjectTypeIconEnumFilterInput } """Icon used to display projects of a project type.""" enum ProjectTypeIconEnum { """General project icon; the default.""" GeneralIcon """Account icon.""" Account } """ Filter conditions for ProjectSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared project.""" projectId: EntityFilterStringField """ Access the sharing gives the sales unit on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Project being shared. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Sales unit the project is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for ProjectSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the shared project.""" projectId: EntityFilterStringField """ Access the sharing gives the user on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the project is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Project being shared. Matches records where a related record meets these conditions. """ project: ProjectFilterInput } """ Filter conditions for ProjectContactRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectContactRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectContactRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectContactRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectContactRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the contact linked to the project.""" contactId: EntityFilterStringField """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the project the contact is linked to.""" projectId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Contact linked to the project. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Project the contact is linked to. Matches records where a related record meets these conditions. """ project: ProjectFilterInput } """ Filter conditions for Solution records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input SolutionFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [SolutionFilterInput!] """Matches records that meet all of the listed filters.""" AND: [SolutionFilterInput!] """Matches records that do not meet this filter.""" NOT: SolutionFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-text description of the solution.""" description: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """Template this solution was created from, if any.""" solutionTemplateId: EntityFilterStringField """Number of nodes on the canvas.""" nodeCount: Int """ Live status derived from the activatable nodes (Automatizer, Email Sequence, Online Form): Active when all are enabled, Inactive when none are, Partial otherwise. """ status: SolutionStatusEnum """ User who owns the solution. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Template this solution was created from, if any. Matches records where a related record meets these conditions. """ solutionTemplate: SolutionTemplateFilterInput """ Tags attached to the solution for organisation/filtering. Matches records where a related record meets these conditions. """ tags: TagRelationFilterInput } """ Filter conditions for SolutionTemplate records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input SolutionTemplateFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [SolutionTemplateFilterInput!] """Matches records that meet all of the listed filters.""" AND: [SolutionTemplateFilterInput!] """Matches records that do not meet this filter.""" NOT: SolutionTemplateFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-text description of what the template sets up.""" description: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """URL of the template preview image shown in the template gallery.""" previewImageUrl: EntityFilterStringField } """ Filter conditions for Tag records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TagFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TagFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TagFilterInput!] """Matches records that do not meet this filter.""" NOT: TagFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """Id of the creating user.""" creatorId: EntityFilterStringField """ For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags. """ entityApiName: EntityFilterStringField """ When false, the tag is hidden in pickers and cannot be assigned to new records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Bit flags of the entities the tag can be attached to, added together: Contact 1, Account 2, Opportunity 4, Lead 8, Project 16, Email 32, Process 64, Appointment 128, Task 256, Quote 512, CustomEntity 1024, Solution 2048. """ supportedEntities: TagSupportedEntitiesEnumFilterInput """ When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who created the tag. Matches records where a related record meets these conditions. """ creator: ClientFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input TagSupportedEntitiesEnumFilterInput { """Matches any of the listed values.""" eq: [TagSupportedEntitiesEnum!] """Matches values that do not meet this condition.""" NOT: TagSupportedEntitiesEnumFilterInput } """ Entity a tag can be attached to; used to filter tags by the entities they support. """ enum TagSupportedEntitiesEnum { """ Person the sales team works with, usually linked to one or more accounts, leads and opportunities. """ Contact """ Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. """ Account """ Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. """ Opportunity """ Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. """ Lead """ Project delivered for an account or run internally, with its objectives, activities and progress. """ Project """ Email message sent or received by users of the space, linked to the contacts, accounts and other records it concerns. """ Email """Automation processes.""" Process """ Meeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns. """ Appointment """ Task (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records. """ Task """ Price offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process. """ Quote """ Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. """ CustomEntity """ Canvas that groups related automation tools (Automatizer processes, email sequences, online forms) and tracks their status and activity. """ Solution } """ Filter conditions for Profile records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProfileFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProfileFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProfileFilterInput!] """Matches records that do not meet this filter.""" NOT: ProfileFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity. """ entity: ScreenTypeEnumFilterInput """ API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty. """ entityApiName: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """ Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users. """ shareMode: ShareModeEnumFilterInput """ When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records. """ syncEnabled: Boolean """Id of the synchronized record.""" syncEntityId: EntityFilterStringField """ Whether the profile lists the records matching its filter (Dynamic) or a fixed list of records added to it explicitly (Static). """ type: ProfileTypeEnumFilterInput """ When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who owns the screen profile. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Specific record this profile is synchronized to. Set only when syncEnabled is true. Matches records where a related record meets these conditions. """ syncEntity: ReportFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ScreenTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ScreenTypeEnum!] """Matches values that do not meet this condition.""" NOT: ScreenTypeEnumFilterInput } """Application screen a saved view (profile) belongs to.""" enum ScreenTypeEnum { """Opportunities screen (pipeline view of open opportunities).""" Pipelinescreen """Legacy value; no longer used.""" Timelinescreen """Archive of closed (won or lost) opportunities.""" Archivescreen """Screen listing open leads.""" Leadscreen """Screen listing accounts.""" Accountscreen """Screen listing contacts.""" Contactscreen """Screen listing tasks and appointments.""" Activityscreen """Legacy value of the original Feed screen; replaced by Feedscreen2.""" Feedscreen """Legacy value; no longer used.""" Hrmscreen """Legacy value; no longer used.""" Auditscreen """Original Navigator screen.""" Navigator """Insights area: overview of sales performance.""" Insightsscreen """Insights area: key sales indicators.""" Indicatorsscreen """Insights area: conversion rates between pipeline steps.""" Conversionsscreen """Insights area: lifecycle of leads and opportunities.""" Lifecyclescreen """ Feed screen showing the stream of activities, emails and other updates. """ Feedscreen2 """Screen listing products.""" ProductScreen """Screen listing projects.""" Projectscreen """Sales forecast screen.""" Forecastscreen """Archive of lost or qualified leads.""" LeadArchivescreen """Sales targets screen.""" TargetScreen """Screen listing open quotes.""" Quotescreen """Archive of closed quotes.""" QuoteArchivescreen """Screen listing approval requests.""" Approvalscreen """ Screen listing records of a custom entity; the profile identifies the custom entity. """ CustomEntityscreen """Archive of archived accounts.""" AccountArchivescreen """Archive of archived contacts.""" ContactArchivescreen """Feed tab on a record's detail screen.""" FeedDetailScreen """Current Navigator screen with configurable widgets.""" BetterNavigatorscreen """Email view of the Feed screen.""" FeedEmailscreen """Email feed tab on a record's detail screen.""" FeedEmailDetailScreen """Screen listing emails.""" EmailScreen } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProfileTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ProfileTypeEnum!] """Matches values that do not meet this condition.""" NOT: ProfileTypeEnumFilterInput } """ Whether a saved view (profile) lists records by filter or holds a fixed set of records. """ enum ProfileTypeEnum { """Records are selected by the profile's filter.""" Dynamic """Static list of records added explicitly.""" Static } """ Filter conditions for Report records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ReportFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ReportFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ReportFilterInput!] """Matches records that do not meet this filter.""" NOT: ReportFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Public access token used in shareable report URLs. Empty when public sharing is not configured for the report. """ accessLink: EntityFilterStringField """Free-text description shown alongside the report.""" description: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """Id of the parent report folder.""" reportsFolderId: EntityFilterStringField """ Who besides the owner can access the report: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit). """ shareMode: ShareModeEnumFilterInput """ Legacy additional sharing options; kept with the record but no longer applied. """ shareModeParams: ShareModeParamsEnumFilterInput """ When true, name and settings are kept in sync with the linked screen profile; when false, the report is detached from profile sync. """ syncEnabled: Boolean """Id of the synchronized record.""" syncEntityId: EntityFilterStringField """ Kind of report: a table or pivot report, a dashboard, an opportunity forecast, or an advanced report built from several linked tables. """ type: ReportTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who owns the report or dashboard. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Report folder this report is filed under (default folder when empty). Matches records where a related record meets these conditions. """ reportsFolder: ReportFolderFilterInput """ Specific record this report is synchronized to. Set only when syncEnabled is true. Matches records where a related record meets these conditions. """ syncEntity: ProfileFilterInput """ The calling user's scheduled email delivery of this report; empty when none is set. Set it with `setScheduleReport` and remove it with `removeScheduleReport`. Matches records where a related record meets these conditions. """ schedule: ReportScheduleFilterInput """ Sales units granted shared access to this report (custom share mode). Matches records where a related record meets these conditions. """ sharingUnits: ReportSharingSalesUnitRelationFilterInput """ Users granted shared access to this report (custom share mode). Matches records where a related record meets these conditions. """ sharingClients: ReportSharingClientRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ShareModeParamsEnumFilterInput { """Matches any of the listed values.""" eq: [ShareModeParamsEnum!] """Matches values that do not meet this condition.""" NOT: ShareModeParamsEnumFilterInput } """ Legacy additional sharing options of reports and forecasts; kept with the record but no longer applied. """ enum ShareModeParamsEnum { """ Legacy option to share with the managers of the selected sales units; no longer applied. """ ShareToUnitManagers """Legacy option to share with the included users; no longer applied.""" ShareToIncludedUsers } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ReportTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ReportTypeEnum!] """Matches values that do not meet this condition.""" NOT: ReportTypeEnumFilterInput } """Kind of report.""" enum ReportTypeEnum { """Table or pivot report of records.""" TableReport """Dashboard made of charts, tiles and other widgets.""" DashboardReport """Opportunity forecast.""" ForecastReport """ Report built from several linked tables or pivots, edited in the advanced report editor. """ AdvancedReport } """ Filter conditions for ReportFolder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ReportFolderFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ReportFolderFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ReportFolderFilterInput!] """Matches records that do not meet this filter.""" NOT: ReportFolderFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the parent folder, or empty for top-level folders.""" parentReportFolderId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Parent report folder, when this folder is nested. Empty for top-level folders. Matches records where a related record meets these conditions. """ parentReportFolder: ReportFolderFilterInput } """ Filter conditions for ReportSchedule records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ReportScheduleFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ReportScheduleFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ReportScheduleFilterInput!] """Matches records that do not meet this filter.""" NOT: ReportScheduleFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the owning user.""" ownerId: EntityFilterStringField """Id of the scheduled report.""" reportId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who owns the schedule. The schedule sends emails on behalf of this user. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Report whose delivery is scheduled. Matches records where a related record meets these conditions. """ report: ReportFilterInput """ Files attached to scheduled emails sent for this report. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput } """ Filter conditions for ReportSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ReportSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ReportSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ReportSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ReportSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared report.""" reportId: EntityFilterStringField """ Access the sharing gives members and managers of the sales unit on the report: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Report being shared. Matches records where a related record meets these conditions. """ report: ReportFilterInput """ Sales unit granted shared access to the report. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for ReportSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ReportSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ReportSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ReportSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ReportSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the shared report.""" reportId: EntityFilterStringField """ Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User granted shared access to the report. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Report being shared. Matches records where a related record meets these conditions. """ report: ReportFilterInput } """ Filter conditions for OpportunityType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpportunityTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpportunityTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpportunityTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: OpportunityTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ True when the opportunity type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the pipeline this opportunity type drives.""" pipelineId: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Pipeline this opportunity type drives. Each opportunity type maps to exactly one pipeline. Matches records where a related record meets these conditions. """ pipeline: PipelineFilterInput } """ Filter conditions for OpptyRecurrence records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyRecurrenceFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyRecurrenceFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyRecurrenceFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyRecurrenceFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: RecurrenceConditionEnumFilterInput """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnumFilterInput "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: DateDayOfWeekEnumFilterInput """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnumFilterInput """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: EntityFilterNumberField """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: EntityFilterNumberField """Id of the parent opportunity.""" opptyId: EntityFilterStringField """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: EntityFilterStringField """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: RecurrenceTypeEnumFilterInput """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Opportunity this recurrence belongs to. Each recurrence is bound to exactly one opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Pipeline step that newly generated opportunities are placed in. Matches records where a related record meets these conditions. """ step: StepFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input RecurrenceConditionEnumFilterInput { """Matches any of the listed values.""" eq: [RecurrenceConditionEnum!] """Matches values that do not meet this condition.""" NOT: RecurrenceConditionEnumFilterInput } """ Opportunity outcomes that trigger creation of the next opportunity in a recurring series; values can be combined. """ enum RecurrenceConditionEnum { """The next opportunity is created when the current one is won.""" Won """The next opportunity is created when the current one is lost.""" Lost } """ Conditions on an enumeration field. Several conditions given together must all match. """ input DateDayEnumFilterInput { """Matches any of the listed values.""" eq: [DateDayEnum!] """Matches values that do not meet this condition.""" NOT: DateDayEnumFilterInput } """ Day of the month (1 to 31) used by task and opportunity recurrence settings. """ enum DateDayEnum { """Day 1 of the month.""" Day1 """Day 2 of the month.""" Day2 """Day 3 of the month.""" Day3 """Day 4 of the month.""" Day4 """Day 5 of the month.""" Day5 """Day 6 of the month.""" Day6 """Day 7 of the month.""" Day7 """Day 8 of the month.""" Day8 """Day 9 of the month.""" Day9 """Day 10 of the month.""" Day10 """Day 11 of the month.""" Day11 """Day 12 of the month.""" Day12 """Day 13 of the month.""" Day13 """Day 14 of the month.""" Day14 """Day 15 of the month.""" Day15 """Day 16 of the month.""" Day16 """Day 17 of the month.""" Day17 """Day 18 of the month.""" Day18 """Day 19 of the month.""" Day19 """Day 20 of the month.""" Day20 """Day 21 of the month.""" Day21 """Day 22 of the month.""" Day22 """Day 23 of the month.""" Day23 """Day 24 of the month.""" Day24 """Day 25 of the month.""" Day25 """Day 26 of the month.""" Day26 """Day 27 of the month.""" Day27 """Day 28 of the month.""" Day28 """Day 29 of the month.""" Day29 """Day 30 of the month.""" Day30 """Day 31 of the month.""" Day31 } """ Conditions on an enumeration field. Several conditions given together must all match. """ input DateDayOfWeekEnumFilterInput { """Matches any of the listed values.""" eq: [DateDayOfWeekEnum!] """Matches values that do not meet this condition.""" NOT: DateDayOfWeekEnumFilterInput } """ Day of the week, used as a bit flag in recurrence settings so several days can be combined. """ enum DateDayOfWeekEnum { """Sunday.""" Sunday """Monday.""" Monday """Tuesday.""" Tuesday """Wednesday.""" Wednesday """Thursday.""" Thursday """Friday.""" Friday """Saturday.""" Saturday } """ Conditions on an enumeration field. Several conditions given together must all match. """ input DateMonthEnumFilterInput { """Matches any of the listed values.""" eq: [DateMonthEnum!] """Matches values that do not meet this condition.""" NOT: DateMonthEnumFilterInput } """ Month of the year (1 = January to 12 = December) used by yearly recurrence settings. """ enum DateMonthEnum { """January.""" Month1 """February.""" Month2 """March.""" Month3 """April.""" Month4 """May.""" Month5 """June.""" Month6 """July.""" Month7 """August.""" Month8 """September.""" Month9 """October.""" Month10 """November.""" Month11 """December.""" Month12 } """ Conditions on an enumeration field. Several conditions given together must all match. """ input RecurrenceTypeEnumFilterInput { """Matches any of the listed values.""" eq: [RecurrenceTypeEnum!] """Matches values that do not meet this condition.""" NOT: RecurrenceTypeEnumFilterInput } """ Schedule by which the next task or opportunity in a recurring series is created. """ enum RecurrenceTypeEnum { """No recurrence; no further items are created.""" NotSet """Repeats every occurEvery days on a fixed schedule.""" Daily """Repeats every occurEvery weeks on the weekdays set in dayOfWeek.""" Weekly """ Repeats every occurEvery months on a fixed day of the month given by day. """ MonthlyRelative """ Repeats every occurEvery months on a given weekday of a given week of the month (week and dayOfWeek), for example the last Friday. """ MonthlyAbsolute """Repeats every year on a fixed date given by month and day.""" YearlyRelative """ Repeats every year on a given weekday of a given week in a given month (month, week and dayOfWeek). """ YearlyAbsolute """ Creates the next item occurEvery days after the current one is completed. """ AfterNDays """ Creates the next item occurEvery weeks after the current one is completed. """ AfterNWeeks """ Creates the next item occurEvery months after the current one is completed. """ AfterNMonths """ Creates the next item occurEvery years after the current one is completed. """ AfterNYears } """ Conditions on an enumeration field. Several conditions given together must all match. """ input DateWeekEnumFilterInput { """Matches any of the listed values.""" eq: [DateWeekEnum!] """Matches values that do not meet this condition.""" NOT: DateWeekEnumFilterInput } """ Week of the month in which a recurrence falls, combined with dayOfWeek (for example the second Tuesday). """ enum DateWeekEnum { """The last occurrence of the selected weekday in the month.""" WeekLast """The first occurrence of the selected weekday in the month.""" Week1 """The second occurrence of the selected weekday in the month.""" Week2 """The third occurrence of the selected weekday in the month.""" Week3 """The fourth occurrence of the selected weekday in the month.""" Week4 } """ Filter conditions for OpptyRevenueSchedule records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyRevenueScheduleFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyRevenueScheduleFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyRevenueScheduleFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyRevenueScheduleFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity. Must match with Opportunity id.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Number of periods the opportunity value is split into.""" periodCount: EntityFilterNumberField """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Periods produced by this revenue schedule, ordered by date. Matches records where a related record meets these conditions. """ periods: OpptyRevenueSchedulePeriodFilterInput } """ Filter conditions for OpptyRevenueSchedulePeriod records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyRevenueSchedulePeriodFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyRevenueSchedulePeriodFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyRevenueSchedulePeriodFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyRevenueSchedulePeriodFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the parent revenue schedule.""" opptyRevenueScheduleId: EntityFilterStringField """Identifier linking the period to the recognition transaction.""" transactionId: EntityFilterStringField """Amount recognised in this period.""" value: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Parent revenue schedule this period belongs to. Matches records where a related record meets these conditions. """ opptyRevenueSchedule: OpptyRevenueScheduleFilterInput } """ Filter conditions for LeadOpptyContactRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyContactRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyContactRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyContactRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyContactRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-form note describing this contact link.""" comment: EntityFilterStringField """Id of the contact linked to the lead or opportunity.""" contactId: EntityFilterStringField """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: EntityFilterStringField """Id of the lead or opportunity this link belongs to.""" leadOpptyId: EntityFilterStringField """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrgRelationshipTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Contact linked to the lead or opportunity. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Matches records where a related record meets these conditions. """ leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationFilterInput """ Lead the contact is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the contact is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Sales roles assigned to the contact for this lead or opportunity. Matches records where a related record meets these conditions. """ salesRoles: LeadOpptyContactSalesRoleRelationFilterInput } """ Filter conditions for LeadOpptyContactGroupRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyContactGroupRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyContactGroupRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyContactGroupRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyContactGroupRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Lead this contact group belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity this contact group belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput } """ Filter conditions for LeadOpptyContactSalesRoleRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyContactSalesRoleRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyContactSalesRoleRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyContactSalesRoleRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyContactSalesRoleRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the lead/opportunity-contact link.""" leadOpptyContactRelationId: EntityFilterStringField """ Id of the sales role assigned to the contact on this lead or opportunity. """ salesRoleId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Lead/opportunity-contact link this sales-role assignment belongs to. Matches records where a related record meets these conditions. """ leadOpptyContactRelation: LeadOpptyContactRelationFilterInput """ Sales role assigned to the contact on this lead or opportunity. Matches records where a related record meets these conditions. """ salesRole: SalesRoleFilterInput } """ Filter conditions for SalesRole records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input SalesRoleFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [SalesRoleFilterInput!] """Matches records that meet all of the listed filters.""" AND: [SalesRoleFilterInput!] """Matches records that do not meet this filter.""" NOT: SalesRoleFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ colorCode: EntityFilterNumberField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for LeadOpptyAccountRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyAccountRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyAccountRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyAccountRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyAccountRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account linked to the lead or opportunity.""" accountId: EntityFilterStringField """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the lead or opportunity this link belongs to.""" leadOpptyId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account linked to the lead or opportunity. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Lead the account is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the account is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput } """ Filter conditions for LeadOpptySharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptySharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptySharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptySharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptySharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the lead or opportunity being shared.""" leadOpptyId: EntityFilterStringField """ Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Sales unit the lead or opportunity is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for LeadOpptySharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptySharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptySharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptySharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptySharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the lead or opportunity being shared.""" leadOpptyId: EntityFilterStringField """ Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the lead or opportunity is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput } """ Filter conditions for EmailTemplate records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailTemplateFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailTemplateFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailTemplateFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailTemplateFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. """ body: EntityFilterStringField """ Id of the folder the template belongs to. Empty for templates at the root level. """ emailTemplateFolderId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the template owner.""" ownerId: EntityFilterStringField """ Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). """ shareMode: ShareModeEnumFilterInput """ When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. """ sharingUrlIsEnabled: Boolean """ Subject line of emails composed from this template. Supports merge-field placeholders. """ subject: EntityFilterStringField """ Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). """ type: EmailTemplateTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Folder in the template hierarchy that the template belongs to. Empty for templates at the root level. Matches records where a related record meets these conditions. """ emailTemplateFolder: EmailTemplateFolderFilterInput """ User who owns the template. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales units granted shared access to this template (custom share mode). Matches records where a related record meets these conditions. """ sharingUnits: EmailTemplateSharingSalesUnitRelationFilterInput """ Users granted shared access to this template (custom share mode). Matches records where a related record meets these conditions. """ sharingClients: EmailTemplateSharingClientRelationFilterInput """ Files attached to the template (used as default attachments). Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailTemplateTypeEnumFilterInput { """Matches any of the listed values.""" eq: [EmailTemplateTypeEnum!] """Matches values that do not meet this condition.""" NOT: EmailTemplateTypeEnumFilterInput } """Format of an email template.""" enum EmailTemplateTypeEnum { """Plain-text template.""" TextTemplate """Template written as raw HTML.""" HtmlTemplate """Template built in the visual (WYSIWYG) editor.""" WysiwygTemplate } """ Filter conditions for EmailTemplateFolder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailTemplateFolderFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailTemplateFolderFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailTemplateFolderFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailTemplateFolderFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Id of the parent folder in the template hierarchy. Empty for top-level folders. """ parentEmailTemplateFolderId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Parent folder in the template hierarchy. Empty for top-level folders. Matches records where a related record meets these conditions. """ parentEmailTemplateFolder: EmailTemplateFolderFilterInput } """ Filter conditions for EmailTemplateSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailTemplateSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailTemplateSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailTemplateSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailTemplateSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the email template shared with the sales unit.""" emailTemplateId: EntityFilterStringField """ Access the sharing gives the sales unit on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Email template being shared. Matches records where a related record meets these conditions. """ emailTemplate: EmailTemplateFilterInput """ Sales unit the template is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for EmailTemplateSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailTemplateSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailTemplateSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailTemplateSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailTemplateSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the email template shared with the user.""" emailTemplateId: EntityFilterStringField """ Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the template is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Email template being shared. Matches records where a related record meets these conditions. """ emailTemplate: EmailTemplateFilterInput } """ Filter conditions for StepChecklistSalesRoleRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input StepChecklistSalesRoleRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [StepChecklistSalesRoleRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [StepChecklistSalesRoleRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: StepChecklistSalesRoleRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the sales role that sees the checklist item.""" salesRoleId: EntityFilterStringField """Id of the checklist item.""" stepChecklistId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Sales role that sees the checklist item. Matches records where a related record meets these conditions. """ salesRole: SalesRoleFilterInput """ Checklist item the role is granted access to. Matches records where a related record meets these conditions. """ stepChecklist: StepChecklistFilterInput } """ Filter conditions for TaskSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TaskSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TaskSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TaskSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: TaskSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Access the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the shared task.""" taskId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Task being shared. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Sales unit the task is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for TaskSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TaskSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TaskSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TaskSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: TaskSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """ Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the shared task.""" taskId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the task is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Task being shared. Matches records where a related record meets these conditions. """ task: TaskFilterInput } """ Filter conditions for TaskReminder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TaskReminderFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TaskReminderFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TaskReminderFilterInput!] """Matches records that do not meet this filter.""" NOT: TaskReminderFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user who set the reminder.""" ownerId: EntityFilterStringField """Timestamp when the reminder should fire.""" setDate: EntityFilterDateTimeField """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnumFilterInput """Id of the task this reminder belongs to.""" taskId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who set this reminder. Reminders are per-user. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Task this reminder belongs to. Matches records where a related record meets these conditions. """ task: TaskFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ReminderStatusEnumFilterInput { """Matches any of the listed values.""" eq: [ReminderStatusEnum!] """Matches values that do not meet this condition.""" NOT: ReminderStatusEnumFilterInput } """State of a task or appointment reminder.""" enum ReminderStatusEnum { """The reminder was postponed and fires again at its snooze date.""" Snoozed """The reminder fires at its set time.""" Scheduled """The reminder was dismissed and does not fire again.""" Dismissed } """ Filter conditions for TaskRecurrence records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TaskRecurrenceFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TaskRecurrenceFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TaskRecurrenceFilterInput!] """Matches records that do not meet this filter.""" NOT: TaskRecurrenceFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnumFilterInput "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: DateDayOfWeekEnumFilterInput """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnumFilterInput """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: EntityFilterNumberField """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: EntityFilterNumberField """Id of the parent task.""" taskId: EntityFilterStringField """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: RecurrenceTypeEnumFilterInput """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Task this recurrence belongs to. Each recurrence is bound to exactly one task. Matches records where a related record meets these conditions. """ task: TaskFilterInput } """ Filter conditions for ActivityComment records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ActivityCommentFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ActivityCommentFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ActivityCommentFilterInput!] """Matches records that do not meet this filter.""" NOT: ActivityCommentFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment or task the comment belongs to.""" activityId: EntityFilterStringField """Free-form text body of the comment.""" comment: EntityFilterStringField """Id of the comment author.""" ownerId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment this comment belongs to. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task this comment belongs to. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ User who authored the comment. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Filter conditions for ProjectObjective records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectObjectiveFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectObjectiveFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectObjectiveFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectObjectiveFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Id of the project this objective belongs to. Set on create; cannot be changed afterwards. """ projectId: EntityFilterStringField """ Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. """ sortOrder: EntityFilterNumberField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Project this objective belongs to. Matches records where a related record meets these conditions. """ project: ProjectFilterInput } """ Filter conditions for AppointmentContactInviteesRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AppointmentContactInviteesRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AppointmentContactInviteesRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AppointmentContactInviteesRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: AppointmentContactInviteesRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment the contact has been invited to.""" appointmentId: EntityFilterStringField """Id of the matched contact.""" contactId: EntityFilterStringField """ Email address of the invitee. Required and used as the natural key for the link. """ email: EntityFilterStringField """Given name of the invitee, when supplied.""" firstName: EntityFilterStringField """ How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled). """ inviteeType: AppointmentInviteeTypeEnumFilterInput """Family name of the invitee, when supplied.""" lastName: EntityFilterStringField """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment the contact has been invited to. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Coevera Contact record matching the invitee email, when one exists. Matches records where a related record meets these conditions. """ contact: ContactFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AppointmentInviteeTypeEnumFilterInput { """Matches any of the listed values.""" eq: [AppointmentInviteeTypeEnum!] """Matches values that do not meet this condition.""" NOT: AppointmentInviteeTypeEnumFilterInput } """How a contact invitee was added to an appointment.""" enum AppointmentInviteeTypeEnum { """Invited directly on the appointment.""" Standard """The person who booked the appointment through an appointment schedule.""" Scheduled } """ Conditions on an enumeration field. Several conditions given together must all match. """ input InviteeResponseEnumFilterInput { """Matches any of the listed values.""" eq: [InviteeResponseEnum!] """Matches values that do not meet this condition.""" NOT: InviteeResponseEnumFilterInput } """Response of an invitee to an appointment invitation.""" enum InviteeResponseEnum { """The invitee has not responded yet.""" NoResponse """The invitee accepted the invitation.""" Accepted """The invitee declined the invitation.""" Rejected } """ Filter conditions for AppointmentClientInviteesRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AppointmentClientInviteesRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AppointmentClientInviteesRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AppointmentClientInviteesRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: AppointmentClientInviteesRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment the user has been invited to.""" appointmentId: EntityFilterStringField """Id of the user.""" clientId: EntityFilterStringField """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment the user has been invited to. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Internal user invited to the appointment. Matches records where a related record meets these conditions. """ client: ClientFilterInput } """ Filter conditions for AppointmentReminder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AppointmentReminderFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AppointmentReminderFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AppointmentReminderFilterInput!] """Matches records that do not meet this filter.""" NOT: AppointmentReminderFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment this reminder belongs to.""" appointmentId: EntityFilterStringField """Seconds before the appointment start when the reminder should fire.""" endDateOffset: EntityFilterNumberField """Id of the user who set the reminder.""" ownerId: EntityFilterStringField """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: EntityFilterDateTimeField """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment this reminder belongs to. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ User who set this reminder. Reminders are per-user. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Filter conditions for ApprovalProcess records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ApprovalProcessFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ApprovalProcessFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ApprovalProcessFilterInput!] """Matches records that do not meet this filter.""" NOT: ApprovalProcessFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-text description shown alongside the approval process.""" description: EntityFilterStringField """ Entity whose records the approval process is raised for, taken from the trigger in settings. Read-only. """ entityType: BaseEntityTypeEnumFilterInput """ When true, the approval process actively raises approvals on matching record events; when false, the process is paused. """ isEnabled: Boolean """Timestamp of the most recent change to settings.""" lastSchemaChange: EntityFilterDateTimeField """Timestamp of the most recent change to isEnabled.""" lastStatusChange: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """ Position of this process among approval processes for the same record-trigger entity type; lower values are evaluated first. Read-only; managed via update_priority. Null for manual-trigger approval processes. """ priority: EntityFilterNumberField """ For record-change triggers, the entity whose records can raise an approval (e.g. "Quote"). Empty for manual triggers. """ triggerEntityName: EntityNameEnum """ Overall status of the approval process, derived from the approvals it raised since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are none. """ status: ProcessStatusEnum """ How approvals are raised: Manual (a user must initiate) or RecordChange (automatically when a record matching the trigger condition is created or updated). """ triggerType: ApprovalProcessTriggerTypeEnum """ User who owns the approval process. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Files attached to the approval process (e.g. process documentation). Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Approvals (one per process run) raised by this approval process. Matches records where a related record meets these conditions. """ activityLogs: ApprovalFilterInput } """How approval requests of an approval process are raised.""" enum ApprovalProcessTriggerTypeEnum { """A user submits the record for approval.""" Manual """ Raised automatically when a record matching the trigger condition is created or updated. """ RecordChange } """ Filter conditions for Approval records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ApprovalFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ApprovalFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ApprovalFilterInput!] """Matches records that do not meet this filter.""" NOT: ApprovalFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the triggering user.""" actorId: EntityFilterStringField """ Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. """ applicationId: EntityFilterStringField """Id of the approval process this approval was raised from.""" approvalProcessId: EntityFilterStringField """ Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. """ approvalStatus: ApprovalStatusEnumFilterInput """Comment the requester attached when raising the approval.""" comment: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """ Timestamp the approval reached a final status (Approved/Rejected/Cancelled). Empty while the approval is still pending. """ endTime: EntityFilterDateTimeField """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """ Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. """ status: ProcessStatusEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Display name of the approval, derived from the underlying record being approved (e.g. the quote name). Empty when the underlying record has been deleted. """ name: String """ Id of the user who owns the record being approved (the record's owner, not the approver). Empty when the underlying record has been deleted. """ ownerId: UUID """ Type identifier (e.g. account type, quote type) of the underlying record being approved. Empty when the underlying record has no type or has been deleted. """ entityType: BaseEntityTypeEnum """Timestamp the approval was raised (alias of created).""" startTime: EntityFilterDateTimeField """ Account the approval is requested on, when the trigger record is an Account. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ User who triggered the approval, or empty when triggered automatically. Matches records where a related record meets these conditions. """ actor: ClientFilterInput """ Application context the approval was triggered in. Matches records where a related record meets these conditions. """ application: ApplicationFilterInput """ Approval process this approval was raised from. Matches records where a related record meets these conditions. """ approvalProcess: ApprovalProcessFilterInput """ Contact the approval is requested on, when the trigger record is a Contact. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Lead the approval is requested on. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the approval is requested on. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Quote the approval is requested on, when the trigger record is a Quote. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Users who must respond to the approval, with their individual responses. Matches records where a related record meets these conditions. """ approvers: ApprovalApproverFilterInput """ Activity log lines describing the steps taken on this approval (visible only). Matches records where a related record meets these conditions. """ lines: ApprovalProcessActivityLogLineFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ApprovalStatusEnumFilterInput { """Matches any of the listed values.""" eq: [ApprovalStatusEnum!] """Matches values that do not meet this condition.""" NOT: ApprovalStatusEnumFilterInput } """Decision state of an approval request for a record.""" enum ApprovalStatusEnum { """Waiting for the approvers' decision.""" Pending """The record was approved.""" Approved """The record was rejected.""" Rejected } """ Filter conditions for ApprovalApprover records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ApprovalApproverFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ApprovalApproverFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ApprovalApproverFilterInput!] """Matches records that do not meet this filter.""" NOT: ApprovalApproverFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the approval this approver is assigned to.""" approvalId: EntityFilterStringField """Id of the assigned user.""" clientId: EntityFilterStringField """Comment the user attached when responding to the approval.""" comment: EntityFilterStringField """ Response of this approver to the approval request: Pending until the user approves or rejects it. """ status: ApprovalStatusEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Approval this approver is assigned to. Matches records where a related record meets these conditions. """ approval: ApprovalFilterInput """ User responsible for approving (or rejecting) the request. Matches records where a related record meets these conditions. """ client: ClientFilterInput } """ Filter conditions for ApprovalProcessActivityLogLine records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ApprovalProcessActivityLogLineFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ApprovalProcessActivityLogLineFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ApprovalProcessActivityLogLineFilterInput!] """Matches records that do not meet this filter.""" NOT: ApprovalProcessActivityLogLineFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the approval this log line belongs to.""" approvalId: EntityFilterStringField """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: EntityFilterDateTimeField """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its approval run.""" sortOrder: EntityFilterNumberField """ Result of the approval step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnumFilterInput """ Approval this log line belongs to. Matches records where a related record meets these conditions. """ approval: ApprovalFilterInput } """ Filter conditions for FieldMapping records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input FieldMappingFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [FieldMappingFilterInput!] """Matches records that meet all of the listed filters.""" AND: [FieldMappingFilterInput!] """Matches records that do not meet this filter.""" NOT: FieldMappingFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ True when the mapping is shipped by the platform and cannot be deleted by the user. """ isSystem: Boolean """ Situation in which the mapping pre-fills a new target record from a source record, such as qualifying a lead into an opportunity or creating a follow-up activity. """ operation: FieldMappingOperationTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Files attached to the mapping (e.g. import source files). Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input FieldMappingOperationTypeEnumFilterInput { """Matches any of the listed values.""" eq: [FieldMappingOperationTypeEnum!] """Matches values that do not meet this condition.""" NOT: FieldMappingOperationTypeEnumFilterInput } """ Situation in which a field mapping pre-fills a new record from a source record. """ enum FieldMappingOperationTypeEnum { """Creating a related record from another record.""" Default """Qualifying a lead into an opportunity.""" Qualification """Creating a follow-up task or appointment from an activity.""" FollowUp """Creating a child account from its parent account.""" Parent """ Creating an account or contact automatically from lead data during qualification. """ QualificationAndAutocreate """Converting a record into a record of another type.""" Conversion } """ Filter conditions for Media records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input MediaFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [MediaFilterInput!] """Matches records that meet all of the listed filters.""" AND: [MediaFilterInput!] """Matches records that do not meet this filter.""" NOT: MediaFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the linked appointment or task, or empty when not linked to an activity. """ activityId: EntityFilterStringField """Id of the linked call, or empty when not linked.""" callId: EntityFilterStringField """Free-text description of the media.""" description: EntityFilterStringField """ Error code reported by the calling/recording provider when processing failed; empty on success. """ errorCode: EntityFilterNumberField """ Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode. """ status: MediaStatusEnumFilterInput """ Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set. """ type: MediaTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment this media is attached to. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task this media is attached to. Set when activityId resolves to a Task. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Call this media belongs to (e.g. a recording or transcription). Matches records where a related record meets these conditions. """ call: CallFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input MediaStatusEnumFilterInput { """Matches any of the listed values.""" eq: [MediaStatusEnum!] """Matches values that do not meet this condition.""" NOT: MediaStatusEnumFilterInput } """Processing status of a media recording and its transcription.""" enum MediaStatusEnum { """No recording is attached yet.""" NoRecording """The recording is being uploaded.""" Uploading """The recording is available and waiting for transcription.""" Uploaded """ The recording is being converted to a format suitable for transcription. """ Transcoding """The recording is being transcribed.""" TranscriptionInProgress """Transcription finished; check errorCode to see whether it failed.""" TranscriptionCompleted } """ Conditions on an enumeration field. Several conditions given together must all match. """ input MediaTypeEnumFilterInput { """Matches any of the listed values.""" eq: [MediaTypeEnum!] """Matches values that do not meet this condition.""" NOT: MediaTypeEnumFilterInput } """Kind of media record.""" enum MediaTypeEnum { """Audio recording.""" Audio """Video recording.""" Video """Recording that is transcribed to text.""" Transcription } """ Filter conditions for Memo records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input MemoFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [MemoFilterInput!] """Matches records that meet all of the listed filters.""" AND: [MemoFilterInput!] """Matches records that do not meet this filter.""" NOT: MemoFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the memo author.""" ownerId: EntityFilterStringField """Short summary line of the memo.""" subject: EntityFilterStringField """ Discriminator identifying the concrete record type — always "memo" for Memo records. Read-only; useful when consuming polymorphic Message results. """ tableName: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who authored the memo. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales units that have been granted shared access to this memo. Matches records where a related record meets these conditions. """ sharingUnits: MessageSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this memo. Matches records where a related record meets these conditions. """ sharingClients: MessageSharingClientRelationFilterInput """ Accounts this memo is linked to. Matches records where a related record meets these conditions. """ accountRelations: MessageRelationFilterInput """ Contacts this memo is linked to. Matches records where a related record meets these conditions. """ contactRelations: MessageRelationFilterInput """ Projects this memo is linked to. Matches records where a related record meets these conditions. """ projectRelations: MessageRelationFilterInput """ Leads this memo is linked to. Matches records where a related record meets these conditions. """ leadRelations: MessageRelationFilterInput """ Quotes this memo is linked to. Matches records where a related record meets these conditions. """ quoteRelations: MessageRelationFilterInput """ Opportunities this memo is linked to. Matches records where a related record meets these conditions. """ opportunityRelations: MessageRelationFilterInput """ Custom entity records this memo is linked to. Matches records where a related record meets these conditions. """ customEntityRelations: MessageRelationFilterInput """ Documents linked to this memo. Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput """ Comments authored on this memo. Matches records where a related record meets these conditions. """ comments: MemoCommentFilterInput } """ Filter conditions for MessageSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input MessageSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [MessageSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [MessageSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: MessageSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the email or memo being shared.""" messageId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Email being shared. Set when messageId resolves to an Email; otherwise empty. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Memo being shared. Set when messageId resolves to a Memo; otherwise empty. Matches records where a related record meets these conditions. """ memo: MemoFilterInput """ Sales unit the message is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for MessageSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input MessageSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [MessageSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [MessageSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: MessageSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the email or memo being shared.""" messageId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the message is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Email being shared. Set when messageId resolves to an Email; otherwise empty. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Memo being shared. Set when messageId resolves to a Memo; otherwise empty. Matches records where a related record meets these conditions. """ memo: MemoFilterInput } """ Filter conditions for MessageRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input MessageRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [MessageRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [MessageRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: MessageRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked custom entity record.""" customEntityId: EntityFilterStringField """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: EntityFilterStringField """Id of the email or memo on this link.""" messageId: EntityFilterStringField """Id of the linked project.""" projectId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the message is linked to, or empty when not linked to an account. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Contact the message is linked to, or empty when not linked to a contact. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record the message is linked to, or empty when not linked. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Lead the message is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the message is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Email side of the link. Set when messageId resolves to an Email; otherwise empty. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Memo side of the link. Set when messageId resolves to a Memo; otherwise empty. Matches records where a related record meets these conditions. """ memo: MemoFilterInput """ Project the message is linked to, or empty when not linked. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote the message is linked to, or empty when not linked. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Filter conditions for MemoComment records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input MemoCommentFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [MemoCommentFilterInput!] """Matches records that meet all of the listed filters.""" AND: [MemoCommentFilterInput!] """Matches records that do not meet this filter.""" NOT: MemoCommentFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-form text body of the comment.""" comment: EntityFilterStringField """Id of the memo this comment belongs to.""" memoId: EntityFilterStringField """Id of the comment author.""" ownerId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Memo this comment belongs to. Matches records where a related record meets these conditions. """ memo: MemoFilterInput """ User who authored the comment. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Filter conditions for ProcessTemplate records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProcessTemplateFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProcessTemplateFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProcessTemplateFilterInput!] """Matches records that do not meet this filter.""" NOT: ProcessTemplateFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-text description of what the template does.""" description: EntityFilterStringField """ True when the platform recommends this template (highlighted in the template gallery). """ isRecommended: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template. """ triggerType: ProcessTriggerTypeEnum """ For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: EntityNameEnum """ Files attached to the template (e.g. reference documents, screenshots). Matches records where a related record meets these conditions. """ documents: CloudObjectRelationFilterInput } """ Filter conditions for TextMessage records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TextMessageFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TextMessageFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TextMessageFilterInput!] """Matches records that do not meet this filter.""" NOT: TextMessageFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: EntityFilterStringField """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: EntityFilterStringField """Timestamp the message was sent.""" datetimeSent: EntityFilterDateTimeField """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnumFilterInput """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: EntityFilterStringField """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnumFilterInput """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ AI assistant chat conversation this message belongs to, when applicable. Matches records where a related record meets these conditions. """ chatConversation: ChatConversationFilterInput """ Conversation this message belongs to. Empty for messages produced by AI chat that do not belong to a thread of customer conversation. Matches records where a related record meets these conditions. """ textMessageConversation: TextMessageConversationFilterInput """ Files attached to the message (e.g. MMS attachments). Matches records where a related record meets these conditions. """ attachments: CloudObjectRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input TextMessageStatusEnumFilterInput { """Matches any of the listed values.""" eq: [TextMessageStatusEnum!] """Matches values that do not meet this condition.""" NOT: TextMessageStatusEnumFilterInput } """Delivery status of a text, WhatsApp or chat message.""" enum TextMessageStatusEnum { """Outgoing message is queued or being sent.""" Sending """Message was sent.""" Sent """Message could not be sent.""" Failed """Message was received from the other party.""" Received """The recipient has seen the sent message.""" Seen } """ Filter conditions for ChatConversation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ChatConversationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ChatConversationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ChatConversationFilterInput!] """Matches records that do not meet this filter.""" NOT: ChatConversationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the owning user.""" ownerId: EntityFilterStringField """ Kind of AI chat: a general conversation with the AI assistant, or one about a specific record identified by context. """ type: ChatConversationTypeEnumFilterInput """ User the conversation belongs to. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Messages exchanged in the conversation, in chronological order. Matches records where a related record meets these conditions. """ messages: TextMessageFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ChatConversationTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ChatConversationTypeEnum!] """Matches values that do not meet this condition.""" NOT: ChatConversationTypeEnumFilterInput } """Kind of AI chat conversation.""" enum ChatConversationTypeEnum { """General conversation with the AI assistant.""" AiChat """Conversation with the AI assistant about a specific record.""" AiRecordDetail } """ Filter conditions for TextMessageConversation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TextMessageConversationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TextMessageConversationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TextMessageConversationFilterInput!] """Matches records that do not meet this filter.""" NOT: TextMessageConversationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the sender phone.""" phoneId: EntityFilterStringField """Id of the matched account.""" recipientAccountId: EntityFilterStringField """Id of the matched contact.""" recipientContactId: EntityFilterStringField """ External phone number of the conversation recipient. Cannot be changed once the conversation has started. """ recipientPhoneNumber: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Coevera phone number used as the sender side of the conversation. Matches records where a related record meets these conditions. """ phone: PhoneFilterInput """ Account record matched to the recipient phone, when one exists. Matches records where a related record meets these conditions. """ recipientAccount: AccountFilterInput """ Contact record matched to the recipient phone, when one exists. Matches records where a related record meets these conditions. """ recipientContact: ContactFilterInput """ Messages exchanged in the conversation, ordered by send time. Matches records where a related record meets these conditions. """ messages: TextMessageFilterInput """ Accounts linked to this conversation. Matches records where a related record meets these conditions. """ accountRelations: TextMessageConversationRelationsFilterInput """ Contacts linked to this conversation. Matches records where a related record meets these conditions. """ contactRelations: TextMessageConversationRelationsFilterInput """ Projects linked to this conversation. Matches records where a related record meets these conditions. """ projectRelations: TextMessageConversationRelationsFilterInput """ Leads linked to this conversation. Matches records where a related record meets these conditions. """ leadRelations: TextMessageConversationRelationsFilterInput """ Opportunities linked to this conversation. Matches records where a related record meets these conditions. """ opportunityRelations: TextMessageConversationRelationsFilterInput """ Quotes linked to this conversation. Matches records where a related record meets these conditions. """ quoteRelations: TextMessageConversationRelationsFilterInput } """ Filter conditions for Phone records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input PhoneFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [PhoneFilterInput!] """Matches records that meet all of the listed filters.""" AND: [PhoneFilterInput!] """Matches records that do not meet this filter.""" NOT: PhoneFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy. """ errorCode: EntityFilterNumberField """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Id of the assigned user, or empty when the phone is a company-level resource. """ ownerId: EntityFilterStringField """Phone number in E.164 format (e.g. "+12025550123").""" phoneNumber: EntityFilterStringField """ External caller identifier from the calling provider (e.g. Twilio caller SID). """ twilioCallerSid: EntityFilterStringField """ Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. """ type: PhoneTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ False when the user has disabled the calling/SMS integration on this phone (errorCode is set to indicate user disablement); true otherwise. """ enabled: Boolean """ User the phone is assigned to, when the phone belongs to a specific user (personal calling/SMS line). Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input PhoneTypeEnumFilterInput { """Matches any of the listed values.""" eq: [PhoneTypeEnum!] """Matches values that do not meet this condition.""" NOT: PhoneTypeEnumFilterInput } """Purpose and assignment of a phone number connected to the space.""" enum PhoneTypeEnum { """Number used for voice calls only.""" Calling """Calling and SMS number not assigned to any user or to the company.""" CallingSmsUnassigned """Calling and SMS number assigned to a single user.""" CallingSmsPersonal """Shared company calling and SMS number.""" CallingSmsCompany """WhatsApp account of a single user.""" WhatsAppPersonal """Shared company WhatsApp account.""" WhatsAppCompany } """ Filter conditions for TextMessageConversationRelations records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TextMessageConversationRelationsFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TextMessageConversationRelationsFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TextMessageConversationRelationsFilterInput!] """Matches records that do not meet this filter.""" NOT: TextMessageConversationRelationsFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: EntityFilterStringField """Id of the linked project, or empty when not linked.""" projectId: EntityFilterStringField """Id of the linked quote, or empty when not linked.""" quoteId: EntityFilterStringField """Id of the text message conversation this link belongs to.""" textMessageConversationId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the conversation is linked to, or empty when not linked. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Contact the conversation is linked to, or empty when not linked. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Lead the conversation is linked to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the conversation is linked to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Project the conversation is linked to. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote the conversation is linked to. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Conversation this link belongs to. Matches records where a related record meets these conditions. """ textMessageConversation: TextMessageConversationFilterInput } """ Filter conditions for EmailContentSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailContentSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailContentSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailContentSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailContentSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the email whose body is shared with the sales unit.""" emailId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Email whose body is being shared. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Sales unit granted access to the email body. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for EmailContentSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailContentSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailContentSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailContentSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailContentSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the email whose body is shared with the user.""" emailId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User granted access to the email body. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Email whose body is being shared. Matches records where a related record meets these conditions. """ email: EmailFilterInput } """ Filter conditions for OnlineFormRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OnlineFormRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OnlineFormRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OnlineFormRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: OnlineFormRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked custom entity record.""" customEntityId: EntityFilterStringField """ True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType. """ isPrimary: Boolean """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: EntityFilterStringField """Id of the submission.""" onlineFormId: EntityFilterStringField """Id of the linked project.""" projectId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the submission is linked to, when applicable. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Contact the submission is linked to, when applicable. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record the submission is linked to, when applicable. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Lead the submission is linked to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the submission is linked to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Online form submission being linked. Matches records where a related record meets these conditions. """ onlineForm: OnlineFormFilterInput """ Project the submission is linked to, when applicable. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote the submission is linked to, when applicable. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Filter conditions for OnlineFormActivityLogLine records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OnlineFormActivityLogLineFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OnlineFormActivityLogLineFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OnlineFormActivityLogLineFilterInput!] """Matches records that do not meet this filter.""" NOT: OnlineFormActivityLogLineFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: EntityFilterDateTimeField """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the submission.""" onlineFormId: EntityFilterStringField """Position of the line within its log run.""" sortOrder: EntityFilterNumberField """ Result of the processing step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnumFilterInput """ Online form submission this log line belongs to. Matches records where a related record meets these conditions. """ onlineForm: OnlineFormFilterInput } """ Filter conditions for MasterRight records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input MasterRightFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [MasterRightFilterInput!] """Matches records that meet all of the listed filters.""" AND: [MasterRightFilterInput!] """Matches records that do not meet this filter.""" NOT: MasterRightFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. """ accessAccountRelationTypes: Boolean """ Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. """ accessAccounts: Boolean """ Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. """ accessAiAutomatizer: Boolean """ Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. """ accessAiOnlineForms: Boolean """ Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. """ accessAiRecordDetail: Boolean """ Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. """ accessAiRecordEnrichment: Boolean """ Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. """ accessAiRelationshipCharts: Boolean """ Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. """ accessAiReports: Boolean """ Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. """ accessAiSmartField: Boolean """ Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. """ accessAppointmentScheduler: Boolean """ Allows users with this role to manage appointment schedules of other users. """ accessAppointmentSchedulerManagement: Boolean """ Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. """ accessApprovalProcesses: Boolean """ Allows users with this role to manage approval processes owned by other users. """ accessApprovalProcessesManagement: Boolean """ Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. """ accessApprovals: Boolean """ Allows users with this role to open the Archive screens listing lost, closed and archived records. """ accessArchive: Boolean """Allows users with this role to open the Audit screen.""" accessAudit: Boolean """ Allows users with this role to view the audit log of changes made in the space. """ accessAuditLog: Boolean """ Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. """ accessBottomMenuCustomization: Boolean """ Allows users with this role to update many records at once with bulk update. """ accessBulkUpdate: Boolean """ Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. """ accessCalling: Boolean """ Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessCallingCompanyPhone: AccessLevelCompanyEmailsEnumFilterInput """ Allows users with this role to purchase and manage company phone numbers for the calling integration. """ accessCallingPurchasePhone: Boolean """ Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). """ accessCompanyEmails: AccessLevelCompanyEmailsEnumFilterInput """ Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. """ accessContacts: Boolean """ Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. """ accessDocumentManagement: Boolean """ Allows users with this role to manage company documents and folders that are not tied to a record. """ accessDocumentManagementCompany: Boolean """ Allows users with this role to create and edit the document folders used for records. """ accessDocumentManagementRecord: Boolean """ Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. """ accessDuplicateChecker: Boolean """ When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. """ accessEmailNotificationEnforcement: Boolean """ Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. """ accessEntityAccount: AccessLevelEntityEnumFilterInput """Allows users with this role to create copies of existing accounts.""" accessEntityAccountCopy: Boolean """Allows users with this role to delete accounts they can edit.""" accessEntityAccountDelete: Boolean """ Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAccountDirection: AccessDirectionEnumFilterInput """ Allows users with this role to own private accounts, which are visible only to their owner. """ accessEntityAccountPrivate: Boolean """Allows users with this role to create new tags for accounts.""" accessEntityAccountTagCreate: Boolean """ Whether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected). """ accessEntityAccountTypes: AccessEntityTypesEnumFilterInput """ Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. """ accessEntityAppointment: AccessLevelEntityEnumFilterInput """Allows users with this role to delete appointments they can edit.""" accessEntityAppointmentDelete: Boolean """ Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAppointmentDirection: AccessDirectionEnumFilterInput """Allows users with this role to create new tags for appointments.""" accessEntityAppointmentTagCreate: Boolean """ Whether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected). """ accessEntityAppointmentTypes: AccessEntityTypesEnumFilterInput """ Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityBetterNavigator: AccessLevelCommonRecordsEnumEnumFilterInput """ Allows users with this role to delete Navigator screen layouts owned by other users. """ accessEntityBetterNavigatorDeleteNotOwned: Boolean """ Allows users with this role to delete Navigator screen layouts they own. """ accessEntityBetterNavigatorDeleteOwned: Boolean """ Allows users with this role to share their Navigator screen layouts with selected users and sales units. """ accessEntityBetterNavigatorSharingCustom: Boolean """ Allows users with this role to share their Navigator screen layouts with all users of the space. """ accessEntityBetterNavigatorSharingPublic: Boolean """ Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. """ accessEntityContact: AccessLevelEntityEnumFilterInput """Allows users with this role to create copies of existing contacts.""" accessEntityContactCopy: Boolean """Allows users with this role to delete contacts they can edit.""" accessEntityContactDelete: Boolean """ Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityContactDirection: AccessDirectionEnumFilterInput """ Allows users with this role to own private contacts, which are visible only to their owner. """ accessEntityContactPrivate: Boolean """Allows users with this role to create new tags for contacts.""" accessEntityContactTagCreate: Boolean """ Whether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected). """ accessEntityContactTypes: AccessEntityTypesEnumFilterInput """ Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. """ accessEntityDashboard: AccessLevelCommonRecordsEnumEnumFilterInput """Allows users with this role to delete dashboards owned by other users.""" accessEntityDashboardDeleteNotOwned: Boolean """Allows users with this role to delete dashboards they own.""" accessEntityDashboardDeleteOwned: Boolean """ Allows users with this role to share their dashboards with selected users and sales units. """ accessEntityDashboardSharingCustom: Boolean """ Allows users with this role to share their dashboards with all users of the space. """ accessEntityDashboardSharingPublic: Boolean """ Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). The Inbox is not affected. """ accessEntityEmailAccessLevel: EmailAccessLevelEnumFilterInput """ How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). """ accessEntityEmailContentShareMode: ContentShareModeConfigEnumFilterInput """ Allows users with this role to delete emails they neither own nor sent. """ accessEntityEmailDeleteNotOwned: Boolean """ Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccounts: TernaryConfigEnumFilterInput """ Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccountsByDomain: TernaryConfigEnumFilterInput """ Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToContacts: TernaryConfigEnumFilterInput """ Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityEmailSequence: AccessLevelEmailSequenceEnumFilterInput """ Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityEmailTemplate: AccessLevelCommonRecordsEnumEnumFilterInput """ Allows users with this role to create and delete email template folders. """ accessEntityEmailTemplateCreateDeleteFolder: Boolean """ Allows users with this role to delete email templates owned by other users. """ accessEntityEmailTemplateDeleteNotOwned: Boolean """Allows users with this role to delete email templates they own.""" accessEntityEmailTemplateDeleteOwned: Boolean """ Allows users with this role to share their email templates with selected users and sales units. """ accessEntityEmailTemplateSharingCustom: Boolean """ Allows users with this role to share their email templates with all users of the space. """ accessEntityEmailTemplateSharingPublic: Boolean """ Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityForecast: AccessLevelCommonRecordsEnumEnumFilterInput """Allows users with this role to delete forecasts owned by other users.""" accessEntityForecastDeleteNotOwned: Boolean """Allows users with this role to delete forecasts they own.""" accessEntityForecastDeleteOwned: Boolean """Allows users with this role to edit forecasts owned by other users.""" accessEntityForecastEditNotOwned: Boolean """ Allows users with this role to share their forecasts with selected users and sales units. """ accessEntityForecastSharingCustom: Boolean """ Allows users with this role to share their forecasts with all users of the space. """ accessEntityForecastSharingPublic: Boolean """ Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityFormView: AccessLevelCommonRecordsEnumEnumFilterInput """Allows users with this role to delete form views owned by other users.""" accessEntityFormViewDeleteNotOwned: Boolean """Allows users with this role to delete form views they own.""" accessEntityFormViewDeleteOwned: Boolean """ Allows users with this role to share their form views with selected users and sales units. """ accessEntityFormViewSharingCustom: Boolean """ Allows users with this role to share their form views with all users of the space. """ accessEntityFormViewSharingPublic: Boolean """ Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. """ accessEntityLead: AccessLevelEntityEnumFilterInput """Allows users with this role to create copies of existing leads.""" accessEntityLeadCopy: Boolean """Allows users with this role to delete leads they can edit.""" accessEntityLeadDelete: Boolean """ Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityLeadDirection: AccessDirectionEnumFilterInput """ Allows users with this role to own private leads, which are visible only to their owner. """ accessEntityLeadPrivate: Boolean """Allows users with this role to create new tags for leads.""" accessEntityLeadTagCreate: Boolean """ Whether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected). """ accessEntityLeadTypes: AccessEntityTypesEnumFilterInput """ Allows users with this role to create new tags for emails, memos and text messages. """ accessEntityMessageTagCreate: Boolean """ Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. """ accessEntityOppty: AccessLevelEntityEnumFilterInput """ Allows users with this role to create copies of existing opportunities. """ accessEntityOpptyCopy: Boolean """Allows users with this role to delete opportunities they can edit.""" accessEntityOpptyDelete: Boolean """ Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityOpptyDirection: AccessDirectionEnumFilterInput """ Allows users with this role to own private opportunities, which are visible only to their owner. """ accessEntityOpptyPrivate: Boolean """Allows users with this role to create new tags for opportunities.""" accessEntityOpptyTagCreate: Boolean """ Which pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). """ accessEntityPipeline: AccessLevelPipelineEnumFilterInput """ Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityProcess: AccessLevelProcessBuilderEnumFilterInput """ Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. """ accessEntityProfile: AccessLevelCommonRecordsEnumEnumFilterInput """ Allows users with this role to delete screen profiles owned by other users. """ accessEntityProfileDeleteNotOwned: Boolean """Allows users with this role to delete screen profiles they own.""" accessEntityProfileDeleteOwned: Boolean """ Allows users with this role to share their screen profiles with selected users and sales units. """ accessEntityProfileSharingCustom: Boolean """ Allows users with this role to share their screen profiles with all users of the space. """ accessEntityProfileSharingPublic: Boolean """ Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. """ accessEntityProject: AccessLevelEntityEnumFilterInput """Allows users with this role to create copies of existing projects.""" accessEntityProjectCopy: Boolean """Allows users with this role to delete projects they can edit.""" accessEntityProjectDelete: Boolean """ Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityProjectDirection: AccessDirectionEnumFilterInput """ Allows users with this role to own private projects, which are visible only to their owner. """ accessEntityProjectPrivate: Boolean """Allows users with this role to create new tags for projects.""" accessEntityProjectTagCreate: Boolean """ Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. """ accessEntityQuote: AccessLevelEntityEnumFilterInput """Allows users with this role to create copies of existing quotes.""" accessEntityQuoteCopy: Boolean """Allows users with this role to delete quotes they can edit.""" accessEntityQuoteDelete: Boolean """ Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityQuoteDirection: AccessDirectionEnumFilterInput """Allows users with this role to create new tags for quotes.""" accessEntityQuoteTagCreate: Boolean """ Whether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected). """ accessEntityQuoteTypes: AccessEntityTypesEnumFilterInput """ Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityReport: AccessLevelCommonRecordsEnumEnumFilterInput """Allows users with this role to create and delete report folders.""" accessEntityReportCreateDeleteFolder: Boolean """Allows users with this role to delete reports owned by other users.""" accessEntityReportDeleteNotOwned: Boolean """Allows users with this role to delete reports they own.""" accessEntityReportDeleteOwned: Boolean """ Allows users with this role to save reports as private, visible only to themselves. """ accessEntityReportPrivate: Boolean """Allows users with this role to schedule reports for regular delivery.""" accessEntityReportScheduleCreate: Boolean """ Allows users with this role to view and manage report schedules of other users. """ accessEntityReportScheduleManagement: Boolean """ Allows users with this role to share their reports with selected users and sales units. """ accessEntityReportSharingCustom: Boolean """ Allows users with this role to share their reports with all users of the space. """ accessEntityReportSharingPublic: Boolean """ Allows users with this role to view and follow solutions, when the feature is enabled for the space. """ accessEntitySolution: Boolean """Allows users with this role to create, edit and delete solutions.""" accessEntitySolutionManagement: Boolean """ Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityTarget: AccessLevelCommonRecordsEnumEnumFilterInput """Allows users with this role to delete targets owned by other users.""" accessEntityTargetDeleteNotOwned: Boolean """Allows users with this role to delete targets they own.""" accessEntityTargetDeleteOwned: Boolean """ Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. """ accessEntityTask: AccessLevelEntityEnumFilterInput """Allows users with this role to delete tasks they can edit.""" accessEntityTaskDelete: Boolean """ Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityTaskDirection: AccessDirectionEnumFilterInput """Allows users with this role to create new tags for tasks.""" accessEntityTaskTagCreate: Boolean """ Whether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected). """ accessEntityTaskTypes: AccessEntityTypesEnumFilterInput """ Allows users with this role to create tasks without an owner (unassigned tasks). """ accessEntityTaskUnassigned: Boolean """Allows users with this role to export records and reports to files.""" accessExport: Boolean """ Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. """ accessFeeds: Boolean """ Allows users with this role to manage currencies and exchange rate lists in Administration. """ accessForeignCurrencies: Boolean """ Allows users with this role to manage fields, forms, record types, tags and translations in Administration. """ accessFormAndFields: Boolean """ Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. """ accessGlobalSettings: Boolean """Allows users with this role to open the Navigator screen.""" accessHomeScreen: Boolean """Allows users with this role to import records from files.""" accessImport: Boolean """ Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. """ accessInsights: Boolean """ Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. """ accessLeads: Boolean """ Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. """ accessOnlineForms: Boolean """ Allows users with this role to edit and delete online forms owned by other users. """ accessOnlineFormsManagement: Boolean """ Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. """ accessOpportunity: Boolean """ Allows users with this role to manage pipelines, lead processes and quote processes in Administration. """ accessPipelineConfiguration: Boolean """Allows users with this role to print records and reports.""" accessPrint: Boolean """ Allows users with this role to manage products, product categories and price lists in Administration. """ accessProductsServices: Boolean """ Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. """ accessProjects: Boolean """ Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. """ accessQuotes: Boolean """Allows users with this role to manage sales roles in Administration.""" accessSalesRoles: Boolean """ Allows users with this role to manage the security settings of the space in Administration. """ accessSecurity: Boolean """Allows users with this role to manage sales units in Administration.""" accessUnits: Boolean """ Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. """ accessUserAndRoles: Boolean """ Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessWhatsAppCompanyPhone: AccessLevelCompanyEmailsEnumFilterInput """Name of the entity and its default text representation.""" name: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted. Matches records where a related record meets these conditions. """ allowedPipelines: AllowedPipelineFilterInput """ Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected. Matches records where a related record meets these conditions. """ allowedLeadTypes: AllowedLeadTypeFilterInput """ Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected. Matches records where a related record meets these conditions. """ allowedQuoteTypes: AllowedQuoteTypeFilterInput """ Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected. Matches records where a related record meets these conditions. """ allowedAccountTypes: AllowedAccountTypeFilterInput """ Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected. Matches records where a related record meets these conditions. """ allowedContactTypes: AllowedContactTypeFilterInput """ Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected. Matches records where a related record meets these conditions. """ allowedTaskTypes: AllowedTaskTypeFilterInput """ Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. Matches records where a related record meets these conditions. """ allowedAppointmentTypes: AllowedAppointmentTypeFilterInput """ Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected. Matches records where a related record meets these conditions. """ allowedCompanyEmails: AllowedCompanyEmailFilterInput """ Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected. Matches records where a related record meets these conditions. """ allowedCompanyPhones: AllowedCompanyPhoneFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessLevelCompanyEmailsEnumFilterInput { """Matches any of the listed values.""" eq: [AccessLevelCompanyEmailsEnum!] """Matches values that do not meet this condition.""" NOT: AccessLevelCompanyEmailsEnumFilterInput } """ Which shared company email accounts or company phone numbers a user role can use. """ enum AccessLevelCompanyEmailsEnum { """None can be used.""" NoAccess """ Only those listed in the role's allowedCompanyEmails or allowedCompanyPhones. """ Selected """All company email accounts or phone numbers can be used.""" All } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessLevelEntityEnumFilterInput { """Matches any of the listed values.""" eq: [AccessLevelEntityEnum!] """Matches values that do not meet this condition.""" NOT: AccessLevelEntityEnumFilterInput } """ Level of access a user role grants to a record type, applied to the records the role can see. """ enum AccessLevelEntityEnum { """The record type is not available to the user.""" NoAccess """The user can view records but cannot create or edit them.""" Readonly """ The user can create records and edit records they own or that are shared with them for editing. """ Editor """ Same as Editor, and the user can also edit records of the sales units they manage. """ EditorOrUnitManger """The user can edit all records they can see.""" All } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessDirectionEnumFilterInput { """Matches any of the listed values.""" eq: [AccessDirectionEnum!] """Matches values that do not meet this condition.""" NOT: AccessDirectionEnumFilterInput } """ Which sales units' records a user role can see, in addition to the records the user owns or that are shared with them. """ enum AccessDirectionEnum { """Only records the user owns or that are shared with them.""" Owned """Also records of the sales units the user is a member of.""" Current """Also records of the user's sales units and their parent units.""" CurrentAndParent """Also records of the user's sales units and their subunits.""" CurrentAndSubunit """ Also records of the user's sales units, their parent units and their subunits. """ CurrentAndParentAndSubunit """Records of all sales units.""" All } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessEntityTypesEnumFilterInput { """Matches any of the listed values.""" eq: [AccessEntityTypesEnum!] """Matches values that do not meet this condition.""" NOT: AccessEntityTypesEnumFilterInput } """Which record types of an entity a user role can work with.""" enum AccessEntityTypesEnum { """The role can work with records of every type of the entity.""" All """ The role can work only with records of the types explicitly allowed for it; with none allowed, no type is available. """ Selected } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessLevelCommonRecordsEnumEnumFilterInput { """Matches any of the listed values.""" eq: [AccessLevelCommonRecordsEnumEnum!] """Matches values that do not meet this condition.""" NOT: AccessLevelCommonRecordsEnumEnumFilterInput } """ Level of access a user role grants to shared items such as reports, dashboards, forecasts, targets, screen profiles, form views and email templates. """ enum AccessLevelCommonRecordsEnumEnum { """The feature is not available to the user.""" NoAccess """The user can use items shared with them but cannot create their own.""" Readonly """ The user can create and manage their own items and use items shared with them. """ All } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailAccessLevelEnumFilterInput { """Matches any of the listed values.""" eq: [EmailAccessLevelEnum!] """Matches values that do not meet this condition.""" NOT: EmailAccessLevelEnumFilterInput } """ Which emails a user role lets users see on records, reports, feeds and automation. """ enum EmailAccessLevelEnum { """Every email linked to a record the user can see.""" Default """ Only emails owned or shared by the users and sales unit members in accessEntityEmailAllowed, plus the user's own emails and emails shared with them. """ UsersAndSalesUnits } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ContentShareModeConfigEnumFilterInput { """Matches any of the listed values.""" eq: [ContentShareModeConfigEnum!] """Matches values that do not meet this condition.""" NOT: ContentShareModeConfigEnumFilterInput } """How a user role lets users share the body of their emails.""" enum ContentShareModeConfigEnum { """Email bodies are always private.""" PrivateOnly """ Users choose per email, starting from their default in emailDefaultContentSharingMode. """ Custom """Email bodies are always public.""" PublicOnly } """ Conditions on an enumeration field. Several conditions given together must all match. """ input TernaryConfigEnumFilterInput { """Matches any of the listed values.""" eq: [TernaryConfigEnum!] """Matches values that do not meet this condition.""" NOT: TernaryConfigEnumFilterInput } """Whether a user role enforces a setting or leaves it to each user.""" enum TernaryConfigEnum { """Each user's own setting applies.""" Custom """The setting is on for every user with the role.""" On """The setting is off for every user with the role.""" Off } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessLevelEmailSequenceEnumFilterInput { """Matches any of the listed values.""" eq: [AccessLevelEmailSequenceEnum!] """Matches values that do not meet this condition.""" NOT: AccessLevelEmailSequenceEnumFilterInput } """Level of access a user role grants to email sequences.""" enum AccessLevelEmailSequenceEnum { """The user can view and manage all email sequences.""" FullAccess """The user can view and manage only their own personal email sequences.""" Personal """Email sequences are not available to the user.""" NoAccess } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessLevelPipelineEnumFilterInput { """Matches any of the listed values.""" eq: [AccessLevelPipelineEnum!] """Matches values that do not meet this condition.""" NOT: AccessLevelPipelineEnumFilterInput } """Which pipelines a user role can work with.""" enum AccessLevelPipelineEnum { """No pipelines are available to the user.""" NoPipeline """ Only the pipelines listed in the role's allowedPipelines, each with its own step document access. """ Selected """All pipelines, without access to documents attached to pipeline steps.""" AllNoDocuments """All pipelines, including documents attached to pipeline steps.""" AllWithDocuments } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessLevelProcessBuilderEnumFilterInput { """Matches any of the listed values.""" eq: [AccessLevelProcessBuilderEnum!] """Matches values that do not meet this condition.""" NOT: AccessLevelProcessBuilderEnumFilterInput } """Level of access a user role grants to automation processes.""" enum AccessLevelProcessBuilderEnum { """The user can view and manage all processes.""" FullAccess """ The user can view and manage only their own personal processes; space processes cannot be changed. """ Personal """Processes are not available to the user.""" NoAccess } """ Filter conditions for AllowedPipeline records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedPipelineFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedPipelineFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedPipelineFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedPipelineFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ When true, the user role can access documents attached to steps of this pipeline. """ accessStepDocuments: Boolean """Id of the user role.""" masterRightId: EntityFilterStringField """Id of the pipeline the user role can use.""" pipelineId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User role granted access to the pipeline. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput """ Pipeline the user role can use. Matches records where a related record meets these conditions. """ pipeline: PipelineFilterInput } """ Filter conditions for AllowedLeadType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedLeadTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedLeadTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedLeadTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedLeadTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the lead type the user role can use.""" leadTypeId: EntityFilterStringField """Id of the user role.""" masterRightId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Lead type the user role can use. Matches records where a related record meets these conditions. """ leadType: LeadTypeFilterInput """ User role granted access to the lead type. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput } """ Filter conditions for AllowedQuoteType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedQuoteTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedQuoteTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedQuoteTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedQuoteTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user role.""" masterRightId: EntityFilterStringField """Id of the quote type the user role can use.""" quoteTypeId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User role granted access to the quote type. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput """ Quote type the user role can use. Matches records where a related record meets these conditions. """ quoteType: QuoteTypeFilterInput } """ Filter conditions for AllowedAccountType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedAccountTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedAccountTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedAccountTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedAccountTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account type the user role can use.""" accountTypeId: EntityFilterStringField """Id of the user role.""" masterRightId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account type the user role can use. Matches records where a related record meets these conditions. """ accountType: AccountTypeFilterInput """ User role granted access to the account type. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput } """ Filter conditions for AllowedContactType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedContactTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedContactTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedContactTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedContactTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the contact type the user role can use.""" contactTypeId: EntityFilterStringField """Id of the user role.""" masterRightId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Contact type the user role can use. Matches records where a related record meets these conditions. """ contactType: ContactTypeFilterInput """ User role granted access to the contact type. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput } """ Filter conditions for AllowedTaskType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedTaskTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedTaskTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedTaskTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedTaskTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user role.""" masterRightId: EntityFilterStringField """Id of the task type the user role can use.""" taskTypeId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User role granted access to the task type. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput """ Task type the user role can use. Matches records where a related record meets these conditions. """ taskType: TaskTypeFilterInput } """ Filter conditions for AllowedAppointmentType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedAppointmentTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedAppointmentTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedAppointmentTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedAppointmentTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment type the user role can use.""" appointmentTypeId: EntityFilterStringField """Id of the user role.""" masterRightId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment type the user role can use. Matches records where a related record meets these conditions. """ appointmentType: AppointmentTypeFilterInput """ User role granted access to the appointment type. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput } """ Filter conditions for AllowedCompanyEmail records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedCompanyEmailFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedCompanyEmailFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedCompanyEmailFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedCompanyEmailFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the company email address.""" companyEmailId: EntityFilterStringField """Id of the user role.""" masterRightId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Company email address the user role can send from. Matches records where a related record meets these conditions. """ companyEmail: CompanyEmailFilterInput """ User role granted access to the company email address. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput } """ Filter conditions for AllowedCompanyPhone records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AllowedCompanyPhoneFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AllowedCompanyPhoneFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AllowedCompanyPhoneFilterInput!] """Matches records that do not meet this filter.""" NOT: AllowedCompanyPhoneFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user role.""" masterRightId: EntityFilterStringField """Id of the company phone.""" phoneId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User role granted access to the company phone. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput """ Company phone the user role can use for calling/SMS. Matches records where a related record meets these conditions. """ phone: PhoneFilterInput } """ Filter conditions for SalesUnitClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input SalesUnitClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [SalesUnitClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [SalesUnitClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: SalesUnitClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """ Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit. """ unitRole: UnitRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User belonging to the sales unit. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Sales unit the user belongs to. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input UnitRoleEnumFilterInput { """Matches any of the listed values.""" eq: [UnitRoleEnum!] """Matches values that do not meet this condition.""" NOT: UnitRoleEnumFilterInput } """Role of a user within a sales unit.""" enum UnitRoleEnum { """Regular member of the sales unit.""" Member """Manager of the sales unit.""" Manager } """ Filter conditions for ClientFavorite records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ClientFavoriteFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ClientFavoriteFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ClientFavoriteFilterInput!] """Matches records that do not meet this filter.""" NOT: ClientFavoriteFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the favorite account.""" accountId: EntityFilterStringField """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: EntityFilterStringField """Id of the favorite contact.""" contactId: EntityFilterStringField """Id of the favorite custom entity record.""" customEntityId: EntityFilterStringField """Id of the favorite email.""" emailId: EntityFilterStringField """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """Id of the favorite screen profile.""" profileId: EntityFilterStringField """Id of the favorite project.""" projectId: EntityFilterStringField """Id of the favorite quote.""" quoteId: EntityFilterStringField """Id of the favorite report.""" reportId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account marked as favorite, when this favorite points to an account. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Appointment marked as favorite. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task marked as favorite. Set when activityId resolves to a Task. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Contact marked as favorite, when this favorite points to a contact. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record marked as favorite, when this favorite points to a custom entity. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Email marked as favorite, when this favorite points to an email. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Lead marked as favorite. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity marked as favorite. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ User who marked the record as favorite. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Screen profile marked as favorite, when this favorite points to a profile. Matches records where a related record meets these conditions. """ profile: ProfileFilterInput """ Project marked as favorite, when this favorite points to a project. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote marked as favorite, when this favorite points to a quote. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Report marked as favorite, when this favorite points to a report. Matches records where a related record meets these conditions. """ report: ReportFilterInput } """ Filter conditions for ParentAccountRelationType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ParentAccountRelationTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ParentAccountRelationTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ParentAccountRelationTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: ParentAccountRelationTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). """ childLabel: EntityFilterStringField """ Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). """ parentLabel: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for AccountSocialRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountSocialRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountSocialRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountSocialRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountSocialRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity. Must match with Account id.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """AngelList profile URL of the account.""" angellistUrl: EntityFilterStringField """Crunchbase profile URL of the account.""" crunchbaseUrl: EntityFilterStringField """Disqus profile URL of the account.""" disqusUrl: EntityFilterStringField """Facebook page or profile id of the account.""" facebookId: EntityFilterStringField """Facebook profile URL of the account.""" facebookUrl: EntityFilterStringField """Flickr profile URL of the account.""" flickrUrl: EntityFilterStringField """Foursquare profile URL of the account.""" foursquareUrl: EntityFilterStringField """Google business or profile id of the account.""" googleId: EntityFilterStringField """Google+ profile URL of the account.""" googlePlusUrl: EntityFilterStringField """Gravatar profile URL of the account.""" gravatarUrl: EntityFilterStringField """Klout profile URL of the account.""" kloutUrl: EntityFilterStringField """LinkedIn company or profile id of the account.""" linkedinId: EntityFilterStringField """LinkedIn profile URL of the account.""" linkedinUrl: EntityFilterStringField """Pinterest profile URL of the account.""" pinterestUrl: EntityFilterStringField """Quora profile URL of the account.""" quoraUrl: EntityFilterStringField """Reddit profile URL of the account.""" redditUrl: EntityFilterStringField """Skype contact URL or username of the account.""" skypeUrl: EntityFilterStringField """SlideShare profile URL of the account.""" slideshareUrl: EntityFilterStringField """Twitter (X) user id of the account.""" twitterId: EntityFilterStringField """Twitter (X) profile URL of the account.""" twitterUrl: EntityFilterStringField """Vimeo profile URL of the account.""" vimeoUrl: EntityFilterStringField """WordPress site URL of the account.""" wordpressUrl: EntityFilterStringField """XING profile URL of the account.""" xingUrl: EntityFilterStringField """Yahoo profile URL of the account.""" yahooUrl: EntityFilterStringField """Yelp business URL of the account.""" yelpUrl: EntityFilterStringField """YouTube channel URL of the account.""" youtubeUrl: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Filter conditions for AccountSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared account.""" accountId: EntityFilterStringField """ Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account being shared. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Sales unit the account is shared with. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for AccountSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared account.""" accountId: EntityFilterStringField """Id of the user.""" clientId: EntityFilterStringField """ Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account being shared. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ User the account is shared with. Matches records where a related record meets these conditions. """ client: ClientFilterInput } """ Sorting of Account records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. Sorts by fields of the related record, listed in order of priority. """ accountType: [AccountTypeOrderByNestedInput!] """ Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. Sorts by fields of the related record, listed in order of priority. """ customerType: [DataOrderByNestedInput!] """ Industry the account operates in. Configurable per team space. Sorts by fields of the related record, listed in order of priority. """ industry: [DataOrderByNestedInput!] """ Sales user who owns this account. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Parent account in a corporate hierarchy. Empty for top-level accounts. Sorts by fields of the related record, listed in order of priority. """ parentAccount: [AccountOrderByNestedInput!] """ Type of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set. Sorts by fields of the related record, listed in order of priority. """ parentAccountRelationType: [ParentAccountRelationTypeOrderByNestedInput!] """ Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """ Manual classification grade assigned to the account. Used in segmentation and reporting. """ accountClass: OrderByEnum """Id of the account type assigned to this account.""" accountTypeId: OrderByEnum """Street address of the account.""" address: OrderByEnum """City of the account address.""" city: OrderByEnum """Free-form notes describing the account.""" comments: OrderByEnum """Country of the account address.""" country: OrderByEnum """Id of the currency exchange rate list applied to this account.""" currencyExchangeRatesListId: OrderByEnum """ Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. """ customerTypeId: OrderByEnum """ Primary email address of the account. Used as default recipient for emails sent from Coevera. """ email1: OrderByEnum """Additional email address.""" email2: OrderByEnum """Additional email address.""" email3: OrderByEnum """Additional email address.""" email4: OrderByEnum """Additional email address.""" email5: OrderByEnum """ Coarser bucket of healthStatus used for grouping and reporting. Read-only. """ healthCategory: OrderByEnum """ Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. """ healthStatus: OrderByEnum """ Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. """ homePage: OrderByEnum """Id of the industry classification.""" industryId: OrderByEnum """ True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the account owner.""" ownerId: OrderByEnum """ Id of the parent account in the corporate hierarchy. Empty for top-level accounts. """ parentAccountId: OrderByEnum """Id of the parent-account relationship type.""" parentAccountRelationTypeId: OrderByEnum """ Primary phone number of the account. Used as default target for click-to-call. """ phone1: OrderByEnum """Additional phone number.""" phone2: OrderByEnum """Additional phone number.""" phone3: OrderByEnum """Additional phone number.""" phone4: OrderByEnum """Additional phone number.""" phone5: OrderByEnum """ Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. """ quickParentAccountName: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """State or province of the account address.""" stateProvince: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ZIP or postal code of the account address.""" zipCode: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """ Social network profiles linked to this account (e.g. LinkedIn, Facebook). Sorts by fields of the related record, listed in order of priority. """ socialMedia: [AccountSocialRelationOrderByNestedInput!] """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related AccountType record. Set exactly one field in each item. """ input AccountTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the account type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related CurrencyExchangeRatesList record. Set exactly one field in each item. """ input CurrencyExchangeRatesListOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set. """ validFrom: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Data record. Set exactly one field in each item. """ input DataOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option). """ calcValue: OrderByEnum """Name of the entity and its default text representation.""" optionName: OrderByEnum """Position of the option within its data set; lower values appear first.""" sortOrder: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Client record. Set exactly one field in each item. """ input ClientOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the default sales unit.""" defaultUnitId: OrderByEnum """Email. Readonly information from UserProfile.""" email: OrderByEnum """First name. Readonly information from UserProfile.""" firstName: OrderByEnum """Timestamp of the user's most recent login or API request.""" lastActive: OrderByEnum """Last name. Readonly information from UserProfile.""" lastName: OrderByEnum """Id of the assigned user role.""" masterRightId: OrderByEnum """Middle name. Readonly information from UserProfile.""" middleName: OrderByEnum """Phone number. Readonly information from UserProfile.""" phone: OrderByEnum """Picture name. Readonly information from UserProfile.""" pictureUrl: OrderByEnum """Job title or position of the user.""" position: OrderByEnum """Region. Readonly information from UserProfile.""" region: OrderByEnum """ Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead. """ timezone: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Display name of the user, formatted according to the user's name format preference. """ name: OrderByEnum } """ Sorting by a field of the related Account record. Set exactly one field in each item. """ input AccountOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Manual classification grade assigned to the account. Used in segmentation and reporting. """ accountClass: OrderByEnum """Id of the account type assigned to this account.""" accountTypeId: OrderByEnum """Street address of the account.""" address: OrderByEnum """City of the account address.""" city: OrderByEnum """Free-form notes describing the account.""" comments: OrderByEnum """Country of the account address.""" country: OrderByEnum """Id of the currency exchange rate list applied to this account.""" currencyExchangeRatesListId: OrderByEnum """ Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. """ customerTypeId: OrderByEnum """ Primary email address of the account. Used as default recipient for emails sent from Coevera. """ email1: OrderByEnum """Additional email address.""" email2: OrderByEnum """Additional email address.""" email3: OrderByEnum """Additional email address.""" email4: OrderByEnum """Additional email address.""" email5: OrderByEnum """ Coarser bucket of healthStatus used for grouping and reporting. Read-only. """ healthCategory: OrderByEnum """ Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. """ healthStatus: OrderByEnum """ Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. """ homePage: OrderByEnum """Id of the industry classification.""" industryId: OrderByEnum """ True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the account owner.""" ownerId: OrderByEnum """ Id of the parent account in the corporate hierarchy. Empty for top-level accounts. """ parentAccountId: OrderByEnum """Id of the parent-account relationship type.""" parentAccountRelationTypeId: OrderByEnum """ Primary phone number of the account. Used as default target for click-to-call. """ phone1: OrderByEnum """Additional phone number.""" phone2: OrderByEnum """Additional phone number.""" phone3: OrderByEnum """Additional phone number.""" phone4: OrderByEnum """Additional phone number.""" phone5: OrderByEnum """ Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. """ quickParentAccountName: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """State or province of the account address.""" stateProvince: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ZIP or postal code of the account address.""" zipCode: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """Sorting by relation to a set of other records.""" input CommonEntityRepositoryOrderByEntityRelationField { """Records the sorted records may be related to.""" relatedEntities: [EntityFilterRelatedField] """Sort direction.""" way: OrderByEnum } """Sorting by a single custom field.""" input CommonEntityRepositoryOrderByCustomField { """Api name of the custom field to sort by.""" field: String """Sort direction.""" way: OrderByEnum } """ Sorting by a field of the related ParentAccountRelationType record. Set exactly one field in each item. """ input ParentAccountRelationTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). """ childLabel: OrderByEnum """ Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). """ parentLabel: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related SalesUnit record. Set exactly one field in each item. """ input SalesUnitOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the parent unit, or empty for the root unit.""" parentId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related AccountSocialRelation record. Set exactly one field in each item. """ input AccountSocialRelationOrderByNestedInput { """Unique identifier of entity. Must match with Account id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """AngelList profile URL of the account.""" angellistUrl: OrderByEnum """Crunchbase profile URL of the account.""" crunchbaseUrl: OrderByEnum """Disqus profile URL of the account.""" disqusUrl: OrderByEnum """Facebook profile URL of the account.""" facebookUrl: OrderByEnum """Flickr profile URL of the account.""" flickrUrl: OrderByEnum """Foursquare profile URL of the account.""" foursquareUrl: OrderByEnum """Google+ profile URL of the account.""" googlePlusUrl: OrderByEnum """Gravatar profile URL of the account.""" gravatarUrl: OrderByEnum """Klout profile URL of the account.""" kloutUrl: OrderByEnum """LinkedIn profile URL of the account.""" linkedinUrl: OrderByEnum """Pinterest profile URL of the account.""" pinterestUrl: OrderByEnum """Quora profile URL of the account.""" quoraUrl: OrderByEnum """Reddit profile URL of the account.""" redditUrl: OrderByEnum """Skype contact URL or username of the account.""" skypeUrl: OrderByEnum """SlideShare profile URL of the account.""" slideshareUrl: OrderByEnum """Twitter (X) profile URL of the account.""" twitterUrl: OrderByEnum """Vimeo profile URL of the account.""" vimeoUrl: OrderByEnum """WordPress site URL of the account.""" wordpressUrl: OrderByEnum """XING profile URL of the account.""" xingUrl: OrderByEnum """Yahoo profile URL of the account.""" yahooUrl: OrderByEnum """Yelp business URL of the account.""" yelpUrl: OrderByEnum """YouTube channel URL of the account.""" youtubeUrl: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ContactSharingSalesUnitRelation records.""" type ContactSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ContactSharingSalesUnitRelationEntity` and its cursor. """ type ContactSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: ContactSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Sharing of a contact with a sales unit, as a watcher or an editor.""" type ContactSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact being shared.""" contact: ContactEntity """Sales unit the contact is shared with.""" unit: SalesUnitEntity """Id of the shared contact.""" contactId: ID! """ Access the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of SalesUnit records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input SalesUnitOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Parent sales unit, when this unit is nested. Empty for the root unit. Sorts by fields of the related record, listed in order of priority. """ parent: [SalesUnitOrderByNestedInput!] """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the parent unit, or empty for the root unit.""" parentId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ContactSharingClientRelation records.""" type ContactSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ContactSharingClientRelationEntity` and its cursor. """ type ContactSharingClientRelationEntityEdge { """The item at the end of the edge""" node: ContactSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """Sharing of a contact with a user, as a watcher or an editor.""" type ContactSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the contact is shared with.""" client: ClientEntity """Contact being shared.""" contact: ContactEntity """Id of the user.""" clientId: ID! """Id of the shared contact.""" contactId: ID! """ Access the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of Client records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ClientOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Default sales unit for the user. New records the user creates are assigned to this unit by default. Sorts by fields of the related record, listed in order of priority. """ defaultUnit: [SalesUnitOrderByNestedInput!] """ User role assigned to the user. Determines what features and entities the user can access. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """Id of the default sales unit.""" defaultUnitId: OrderByEnum """Email. Readonly information from UserProfile.""" email: OrderByEnum """First name. Readonly information from UserProfile.""" firstName: OrderByEnum """Timestamp of the user's most recent login or API request.""" lastActive: OrderByEnum """Last name. Readonly information from UserProfile.""" lastName: OrderByEnum """Id of the assigned user role.""" masterRightId: OrderByEnum """Middle name. Readonly information from UserProfile.""" middleName: OrderByEnum """Phone number. Readonly information from UserProfile.""" phone: OrderByEnum """Picture name. Readonly information from UserProfile.""" pictureUrl: OrderByEnum """Job title or position of the user.""" position: OrderByEnum """Region. Readonly information from UserProfile.""" region: OrderByEnum """ Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead. """ timezone: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Display name of the user, formatted according to the user's name format preference. """ name: OrderByEnum } """ Sorting by a field of the related MasterRight record. Set exactly one field in each item. """ input MasterRightOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. """ accessAccountRelationTypes: OrderByEnum """ Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. """ accessAccounts: OrderByEnum """ Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. """ accessAiAutomatizer: OrderByEnum """ Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. """ accessAiOnlineForms: OrderByEnum """ Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. """ accessAiRecordDetail: OrderByEnum """ Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. """ accessAiRecordEnrichment: OrderByEnum """ Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. """ accessAiRelationshipCharts: OrderByEnum """ Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. """ accessAiReports: OrderByEnum """ Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. """ accessAiSmartField: OrderByEnum """ Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. """ accessAppointmentScheduler: OrderByEnum """ Allows users with this role to manage appointment schedules of other users. """ accessAppointmentSchedulerManagement: OrderByEnum """ Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. """ accessApprovalProcesses: OrderByEnum """ Allows users with this role to manage approval processes owned by other users. """ accessApprovalProcessesManagement: OrderByEnum """ Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. """ accessApprovals: OrderByEnum """ Allows users with this role to open the Archive screens listing lost, closed and archived records. """ accessArchive: OrderByEnum """Allows users with this role to open the Audit screen.""" accessAudit: OrderByEnum """ Allows users with this role to view the audit log of changes made in the space. """ accessAuditLog: OrderByEnum """ Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. """ accessBottomMenuCustomization: OrderByEnum """ Allows users with this role to update many records at once with bulk update. """ accessBulkUpdate: OrderByEnum """ Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. """ accessCalling: OrderByEnum """ Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessCallingCompanyPhone: OrderByEnum """ Allows users with this role to purchase and manage company phone numbers for the calling integration. """ accessCallingPurchasePhone: OrderByEnum """ Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). """ accessCompanyEmails: OrderByEnum """ Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. """ accessContacts: OrderByEnum """ Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. """ accessDocumentManagement: OrderByEnum """ Allows users with this role to manage company documents and folders that are not tied to a record. """ accessDocumentManagementCompany: OrderByEnum """ Allows users with this role to create and edit the document folders used for records. """ accessDocumentManagementRecord: OrderByEnum """ Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. """ accessDuplicateChecker: OrderByEnum """ When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. """ accessEmailNotificationEnforcement: OrderByEnum """ Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. """ accessEntityAccount: OrderByEnum """Allows users with this role to create copies of existing accounts.""" accessEntityAccountCopy: OrderByEnum """Allows users with this role to delete accounts they can edit.""" accessEntityAccountDelete: OrderByEnum """ Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAccountDirection: OrderByEnum """ Allows users with this role to own private accounts, which are visible only to their owner. """ accessEntityAccountPrivate: OrderByEnum """Allows users with this role to create new tags for accounts.""" accessEntityAccountTagCreate: OrderByEnum """ Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. """ accessEntityAppointment: OrderByEnum """Allows users with this role to delete appointments they can edit.""" accessEntityAppointmentDelete: OrderByEnum """ Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAppointmentDirection: OrderByEnum """Allows users with this role to create new tags for appointments.""" accessEntityAppointmentTagCreate: OrderByEnum """ Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityBetterNavigator: OrderByEnum """ Allows users with this role to delete Navigator screen layouts owned by other users. """ accessEntityBetterNavigatorDeleteNotOwned: OrderByEnum """ Allows users with this role to delete Navigator screen layouts they own. """ accessEntityBetterNavigatorDeleteOwned: OrderByEnum """ Allows users with this role to share their Navigator screen layouts with selected users and sales units. """ accessEntityBetterNavigatorSharingCustom: OrderByEnum """ Allows users with this role to share their Navigator screen layouts with all users of the space. """ accessEntityBetterNavigatorSharingPublic: OrderByEnum """ Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. """ accessEntityContact: OrderByEnum """Allows users with this role to create copies of existing contacts.""" accessEntityContactCopy: OrderByEnum """Allows users with this role to delete contacts they can edit.""" accessEntityContactDelete: OrderByEnum """ Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityContactDirection: OrderByEnum """ Allows users with this role to own private contacts, which are visible only to their owner. """ accessEntityContactPrivate: OrderByEnum """Allows users with this role to create new tags for contacts.""" accessEntityContactTagCreate: OrderByEnum """ Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. """ accessEntityDashboard: OrderByEnum """Allows users with this role to delete dashboards owned by other users.""" accessEntityDashboardDeleteNotOwned: OrderByEnum """Allows users with this role to delete dashboards they own.""" accessEntityDashboardDeleteOwned: OrderByEnum """ Allows users with this role to share their dashboards with selected users and sales units. """ accessEntityDashboardSharingCustom: OrderByEnum """ Allows users with this role to share their dashboards with all users of the space. """ accessEntityDashboardSharingPublic: OrderByEnum """ Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). The Inbox is not affected. """ accessEntityEmailAccessLevel: OrderByEnum """ How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). """ accessEntityEmailContentShareMode: OrderByEnum """ Allows users with this role to delete emails they neither own nor sent. """ accessEntityEmailDeleteNotOwned: OrderByEnum """ Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccounts: OrderByEnum """ Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccountsByDomain: OrderByEnum """ Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToContacts: OrderByEnum """ Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityEmailSequence: OrderByEnum """ Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityEmailTemplate: OrderByEnum """ Allows users with this role to create and delete email template folders. """ accessEntityEmailTemplateCreateDeleteFolder: OrderByEnum """ Allows users with this role to delete email templates owned by other users. """ accessEntityEmailTemplateDeleteNotOwned: OrderByEnum """Allows users with this role to delete email templates they own.""" accessEntityEmailTemplateDeleteOwned: OrderByEnum """ Allows users with this role to share their email templates with selected users and sales units. """ accessEntityEmailTemplateSharingCustom: OrderByEnum """ Allows users with this role to share their email templates with all users of the space. """ accessEntityEmailTemplateSharingPublic: OrderByEnum """ Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityForecast: OrderByEnum """Allows users with this role to delete forecasts owned by other users.""" accessEntityForecastDeleteNotOwned: OrderByEnum """Allows users with this role to delete forecasts they own.""" accessEntityForecastDeleteOwned: OrderByEnum """Allows users with this role to edit forecasts owned by other users.""" accessEntityForecastEditNotOwned: OrderByEnum """ Allows users with this role to share their forecasts with selected users and sales units. """ accessEntityForecastSharingCustom: OrderByEnum """ Allows users with this role to share their forecasts with all users of the space. """ accessEntityForecastSharingPublic: OrderByEnum """ Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityFormView: OrderByEnum """Allows users with this role to delete form views owned by other users.""" accessEntityFormViewDeleteNotOwned: OrderByEnum """Allows users with this role to delete form views they own.""" accessEntityFormViewDeleteOwned: OrderByEnum """ Allows users with this role to share their form views with selected users and sales units. """ accessEntityFormViewSharingCustom: OrderByEnum """ Allows users with this role to share their form views with all users of the space. """ accessEntityFormViewSharingPublic: OrderByEnum """ Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. """ accessEntityLead: OrderByEnum """Allows users with this role to create copies of existing leads.""" accessEntityLeadCopy: OrderByEnum """Allows users with this role to delete leads they can edit.""" accessEntityLeadDelete: OrderByEnum """ Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityLeadDirection: OrderByEnum """ Allows users with this role to own private leads, which are visible only to their owner. """ accessEntityLeadPrivate: OrderByEnum """Allows users with this role to create new tags for leads.""" accessEntityLeadTagCreate: OrderByEnum """ Allows users with this role to create new tags for emails, memos and text messages. """ accessEntityMessageTagCreate: OrderByEnum """ Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. """ accessEntityOppty: OrderByEnum """ Allows users with this role to create copies of existing opportunities. """ accessEntityOpptyCopy: OrderByEnum """Allows users with this role to delete opportunities they can edit.""" accessEntityOpptyDelete: OrderByEnum """ Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityOpptyDirection: OrderByEnum """ Allows users with this role to own private opportunities, which are visible only to their owner. """ accessEntityOpptyPrivate: OrderByEnum """Allows users with this role to create new tags for opportunities.""" accessEntityOpptyTagCreate: OrderByEnum """ Which pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). """ accessEntityPipeline: OrderByEnum """ Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityProcess: OrderByEnum """ Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. """ accessEntityProfile: OrderByEnum """ Allows users with this role to delete screen profiles owned by other users. """ accessEntityProfileDeleteNotOwned: OrderByEnum """Allows users with this role to delete screen profiles they own.""" accessEntityProfileDeleteOwned: OrderByEnum """ Allows users with this role to share their screen profiles with selected users and sales units. """ accessEntityProfileSharingCustom: OrderByEnum """ Allows users with this role to share their screen profiles with all users of the space. """ accessEntityProfileSharingPublic: OrderByEnum """ Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. """ accessEntityProject: OrderByEnum """Allows users with this role to create copies of existing projects.""" accessEntityProjectCopy: OrderByEnum """Allows users with this role to delete projects they can edit.""" accessEntityProjectDelete: OrderByEnum """ Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityProjectDirection: OrderByEnum """ Allows users with this role to own private projects, which are visible only to their owner. """ accessEntityProjectPrivate: OrderByEnum """Allows users with this role to create new tags for projects.""" accessEntityProjectTagCreate: OrderByEnum """ Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. """ accessEntityQuote: OrderByEnum """Allows users with this role to create copies of existing quotes.""" accessEntityQuoteCopy: OrderByEnum """Allows users with this role to delete quotes they can edit.""" accessEntityQuoteDelete: OrderByEnum """ Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityQuoteDirection: OrderByEnum """Allows users with this role to create new tags for quotes.""" accessEntityQuoteTagCreate: OrderByEnum """ Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityReport: OrderByEnum """Allows users with this role to create and delete report folders.""" accessEntityReportCreateDeleteFolder: OrderByEnum """Allows users with this role to delete reports owned by other users.""" accessEntityReportDeleteNotOwned: OrderByEnum """Allows users with this role to delete reports they own.""" accessEntityReportDeleteOwned: OrderByEnum """ Allows users with this role to save reports as private, visible only to themselves. """ accessEntityReportPrivate: OrderByEnum """Allows users with this role to schedule reports for regular delivery.""" accessEntityReportScheduleCreate: OrderByEnum """ Allows users with this role to view and manage report schedules of other users. """ accessEntityReportScheduleManagement: OrderByEnum """ Allows users with this role to share their reports with selected users and sales units. """ accessEntityReportSharingCustom: OrderByEnum """ Allows users with this role to share their reports with all users of the space. """ accessEntityReportSharingPublic: OrderByEnum """ Allows users with this role to view and follow solutions, when the feature is enabled for the space. """ accessEntitySolution: OrderByEnum """Allows users with this role to create, edit and delete solutions.""" accessEntitySolutionManagement: OrderByEnum """ Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityTarget: OrderByEnum """Allows users with this role to delete targets owned by other users.""" accessEntityTargetDeleteNotOwned: OrderByEnum """Allows users with this role to delete targets they own.""" accessEntityTargetDeleteOwned: OrderByEnum """ Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. """ accessEntityTask: OrderByEnum """Allows users with this role to delete tasks they can edit.""" accessEntityTaskDelete: OrderByEnum """ Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityTaskDirection: OrderByEnum """Allows users with this role to create new tags for tasks.""" accessEntityTaskTagCreate: OrderByEnum """ Allows users with this role to create tasks without an owner (unassigned tasks). """ accessEntityTaskUnassigned: OrderByEnum """Allows users with this role to export records and reports to files.""" accessExport: OrderByEnum """ Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. """ accessFeeds: OrderByEnum """ Allows users with this role to manage currencies and exchange rate lists in Administration. """ accessForeignCurrencies: OrderByEnum """ Allows users with this role to manage fields, forms, record types, tags and translations in Administration. """ accessFormAndFields: OrderByEnum """ Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. """ accessGlobalSettings: OrderByEnum """Allows users with this role to open the Navigator screen.""" accessHomeScreen: OrderByEnum """Allows users with this role to import records from files.""" accessImport: OrderByEnum """ Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. """ accessInsights: OrderByEnum """ Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. """ accessLeads: OrderByEnum """ Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. """ accessOnlineForms: OrderByEnum """ Allows users with this role to edit and delete online forms owned by other users. """ accessOnlineFormsManagement: OrderByEnum """ Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. """ accessOpportunity: OrderByEnum """ Allows users with this role to manage pipelines, lead processes and quote processes in Administration. """ accessPipelineConfiguration: OrderByEnum """Allows users with this role to print records and reports.""" accessPrint: OrderByEnum """ Allows users with this role to manage products, product categories and price lists in Administration. """ accessProductsServices: OrderByEnum """ Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. """ accessProjects: OrderByEnum """ Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. """ accessQuotes: OrderByEnum """Allows users with this role to manage sales roles in Administration.""" accessSalesRoles: OrderByEnum """ Allows users with this role to manage the security settings of the space in Administration. """ accessSecurity: OrderByEnum """Allows users with this role to manage sales units in Administration.""" accessUnits: OrderByEnum """ Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. """ accessUserAndRoles: OrderByEnum """ Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessWhatsAppCompanyPhone: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of CloudObjectRelation records.""" type CloudObjectRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CloudObjectRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CloudObjectRelationEntity` and its cursor.""" type CloudObjectRelationEntityEdge { """The item at the end of the edge""" node: CloudObjectRelationEntity """A cursor for use in pagination""" cursor: String! } """ Attachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record. """ type CloudObjectRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account the file is attached to, or empty when not attached to an account. """ account: AccountEntity """ Appointment the file is attached to. Set when activityId resolves to an Appointment. """ appointment: AppointmentEntity """Task the file is attached to. Set when activityId resolves to a Task.""" task: TaskEntity """Approval process the file is attached to.""" approvalProcess: ApprovalProcessEntity """Call the file is attached to (e.g. a call recording).""" call: CallEntity """ Folder the file is filed under within the parent record, or empty when stored at the record root. """ cloudObjectFolder: CloudObjectFolderEntity """Cloud object (file) being linked.""" cloudObject: CloudObjectEntity """ Contact the file is attached to, or empty when not attached to a contact. """ contact: ContactEntity """Custom entity record the file is attached to.""" customEntity: CustomEntityEntity """Email sequence the file is attached to.""" emailSequence: EmailSequenceEntity """Email template the file is attached to as a template attachment.""" emailTemplate: EmailTemplateEntity """Field mapping the file is attached to (e.g. an import file).""" fieldMapping: FieldMappingEntity """Lead the file is attached to. Set when leadOpptyId resolves to a Lead.""" lead: LeadEntity """ Opportunity the file is attached to. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """Media record the file is attached to.""" media: MediaEntity """ Email the file is attached to (e.g. an email attachment). Set when messageId resolves to an Email. """ email: EmailEntity """Memo the file is attached to. Set when messageId resolves to a Memo.""" memo: MemoEntity """Online form field the file was uploaded into.""" onlineFormField: FieldEntity """Online form submission the file was uploaded with.""" onlineForm: OnlineFormEntity """Sales process the file is attached to.""" process: ProcessEntity """Sales process template the file is attached to.""" processTemplate: ProcessTemplateEntity """Project the file is attached to.""" project: ProjectEntity """Quote the file is attached to.""" quote: QuoteEntity """Report schedule the file is attached to (e.g. an exported report).""" reportSchedule: ReportScheduleEntity """Text message (SMS/MMS) the file is attached to.""" textMessage: TextMessageEntity """Id of the linked account.""" accountId: ID """Id of the linked appointment or task, or empty when not linked.""" activityId: ID """Id of the linked approval process.""" approvalProcessId: ID """Id of the linked call.""" callId: ID """ Id of the folder within the parent record, or empty when stored at the record root. """ cloudObjectFolderId: ID """Id of the linked file.""" cloudObjectId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email sequence.""" emailSequenceId: ID """Id of the linked email template.""" emailTemplateId: ID """Id of the linked field mapping.""" fieldMappingId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked media record.""" mediaId: ID """Id of the linked email or memo, or empty when not linked.""" messageId: ID """Id of the online form field the file was uploaded into.""" onlineFormFieldId: ID """Id of the linked online form submission.""" onlineFormId: ID """Id of the linked sales process.""" processId: ID """Id of the linked sales process template.""" processTemplateId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked report schedule.""" reportScheduleId: ID """Id of the linked text message.""" textMessageId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Approval rule that raises approval requests for records of an entity when its trigger conditions are met, and defines who approves them. """ type ApprovalProcessEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns the approval process.""" owner: ClientEntity """Free-text description shown alongside the approval process.""" description: String """ Entity whose records the approval process is raised for, taken from the trigger in settings. Read-only. """ entityType: BaseEntityTypeEnum """ When true, the approval process actively raises approvals on matching record events; when false, the process is paused. """ isEnabled: Boolean! """Timestamp of the most recent change to settings.""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ Position of this process among approval processes for the same record-trigger entity type; lower values are evaluated first. Read-only; managed via update_priority. Null for manual-trigger approval processes. """ priority: Int """ Approval process schema as a JSON object conforming to the ApprovalProcessSchema type — trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/a/#ApprovalProcessSchema This payload conforms to the `ApprovalProcessSchema` JSON Schema: GET /api/v100/rest/schemas/ApprovalProcessSchema.json on your region's API host """ settings: ApprovalProcessSchema """Files attached to the approval process (e.g. process documentation).""" documents: [CloudObjectRelationEntity!] """Approvals (one per process run) raised by this approval process.""" activityLogs( """Filter Approval relations by target Approval attributes.""" filter: ApprovalFilterInput """Order Approval relations by target Approval attributes.""" orderBy: [ApprovalOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalEntityConnection """ For record-change triggers, the entity whose records can raise an approval (e.g. "Quote"). Empty for manual triggers. """ triggerEntityName: EntityNameEnum """ Overall status of the approval process, derived from the approvals it raised since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are none. """ status: ProcessStatusEnum """ How approvals are raised: Manual (a user must initiate) or RecordChange (automatically when a record matching the trigger condition is created or updated). """ triggerType: ApprovalProcessTriggerTypeEnum """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of Approval records.""" type ApprovalEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ApprovalEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ApprovalEntity` and its cursor.""" type ApprovalEntityEdge { """The item at the end of the edge""" node: ApprovalEntity """A cursor for use in pagination""" cursor: String! } """ Approval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers. """ type ApprovalEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account the approval is requested on, when the trigger record is an Account. """ account: AccountEntity """ User who triggered the approval, or empty when triggered automatically. """ actor: ClientEntity """Application context the approval was triggered in.""" application: ApplicationEntity """Approval process this approval was raised from.""" approvalProcess: ApprovalProcessEntity """ Contact the approval is requested on, when the trigger record is a Contact. """ contact: ContactEntity """ Lead the approval is requested on. Set when leadOpptyId resolves to a Lead. """ lead: LeadEntity """ Opportunity the approval is requested on. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """ Quote the approval is requested on, when the trigger record is a Quote. """ quote: QuoteEntity """Id of the linked account.""" accountId: ID """Id of the triggering user.""" actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. """ applicationId: ID! """Id of the approval process this approval was raised from.""" approvalProcessId: ID! """ Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. """ approvalStatus: ApprovalStatusEnum """Comment the requester attached when raising the approval.""" comment: String """Id of the linked contact.""" contactId: ID """ Timestamp the approval reached a final status (Approved/Rejected/Cancelled). Empty while the approval is still pending. """ endTime: DateTime """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked quote.""" quoteId: ID """ Snapshot of the approval process schema at the time the approval was raised. Frozen so subsequent changes to the parent approval process do not affect this run. """ settings: JSONString! """ Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. """ status: ProcessStatusEnum """Revision when entity was lastly changed.""" revision: Int """ Users who must respond to the approval, with their individual responses. """ approvers( """ Filter ApprovalApprover relations by target ApprovalApprover attributes. """ filter: ApprovalApproverFilterInput """ Order ApprovalApprover relations by target ApprovalApprover attributes. """ orderBy: [ApprovalApproverOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalApproverEntityConnection """ Activity log lines describing the steps taken on this approval (visible only). """ lines( """ Filter ApprovalProcessActivityLogLine relations by target ApprovalProcessActivityLogLine attributes. """ filter: ApprovalProcessActivityLogLineFilterInput """ Order ApprovalProcessActivityLogLine relations by target ApprovalProcessActivityLogLine attributes. """ orderBy: [ApprovalProcessActivityLogLineOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalProcessActivityLogLineEntityConnection """ Display name of the approval, derived from the underlying record being approved (e.g. the quote name). Empty when the underlying record has been deleted. """ name: String """ Id of the user who owns the record being approved (the record's owner, not the approver). Empty when the underlying record has been deleted. """ ownerId: UUID """ Type identifier (e.g. account type, quote type) of the underlying record being approved. Empty when the underlying record has no type or has been deleted. """ entityType: BaseEntityTypeEnum """Timestamp the approval was raised (alias of created).""" startTime: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. """ type LeadEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space. """ leadSource: DataEntity """ Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply. """ leadType: LeadTypeEntity """ Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over. """ owner: ClientEntity """ Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it. """ reasonOfClose: DataEntity """Step in the lead process the lead is currently in.""" step: StepEntity """ Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """Id of the currency exchange rate list applied to this lead.""" currencyExchangeRatesListId: ID """Free-form description of the lead.""" description: String """ True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """User-set colored flag used to highlight the lead in lists and reports.""" labelFlag: Int """Time when an AI-suggested buying center was last applied to this lead.""" lastAiBuyingCenterApplied: DateTime """ Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). """ leadSourceId: ID """ Id of the lead type that classifies the lead and drives which form, fields and lead process apply. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String! """Id of the lead owner.""" ownerId: ID """ Free-text company email captured at lead creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at lead creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at lead creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at lead creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at lead creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at lead creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. """ ranking: Int """ Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. """ reasonOfCloseDescription: String """ Id of the reason recorded when the lead is archived (lost), or empty when none was given. """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the lead process step.""" stepId: ID """ Discriminator identifying the concrete record type — always "lead" for Lead records. Read-only; useful when consuming polymorphic LeadOppty results. """ tableName: String! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Primary contact of this lead. Set automatically from the contact relation marked as primary. """ primaryContact: ContactEntity """ Primary account of this lead. Set automatically from the account relation marked as primary. """ primaryAccount: AccountEntity """ Contacts linked to this lead, including their roles and org-chart positions. """ contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter LeadOpptyContactRelation relations by edge (relation) LeadOpptyContactRelation attributes. """ filterEdge: LeadOpptyContactRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyContactRelationEntityConnection """Accounts linked to this lead, including the primary-account flag.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter LeadOpptyAccountRelation relations by edge (relation) LeadOpptyAccountRelation attributes. """ filterEdge: LeadOpptyAccountRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyAccountRelationEntityConnection """ Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events. """ status: LeadStatusEnum! """ Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter LeadOpptySharingSalesUnitRelation relations by edge (relation) LeadOpptySharingSalesUnitRelation attributes. """ filterEdge: LeadOpptySharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptySharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter LeadOpptySharingClientRelation relations by edge (relation) LeadOpptySharingClientRelation attributes. """ filterEdge: LeadOpptySharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptySharingClientRelationEntityConnection """Documents linked to this lead.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int! """Tag labels applied to this lead.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Saved view profiles this lead currently matches.""" staticProfiles( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ProfileRelation relations by edge (relation) ProfileRelation attributes. """ filterEdge: ProfileRelationFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """ Timestamp of when the lead was qualified, taken from the matching KPI event. Empty for leads that have not been qualified. Read-only. """ qualifyDate: DateTime """ Number of days the lead has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event. """ daysInStep: Int! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ fitness: WarningLevelEnum """ Filled only when a single record is read by its id; otherwise null or an empty list. """ fitnessDescription: FitnessDescription """ True when the current authenticated user has marked this lead as favorite. Per-user. """ isFavorite: Boolean! """ Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. """ lostDate: DateTime """Display version of the lead name, used in lists and references.""" formattedName: String! """ Lead scoring summary, combining the percentile and current scoring state. Read-only; computed by Coevera. """ scoring: EntityScoringResult """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """ Checklist items of the steps of the record's lead process, with the completion state of each item for this record. """ stepChecklists( """ Ids of the step checklist items to return. When not set, the items of all steps of the record's lead process are returned. """ stepChecklistIds: [UUID] ): [StepChecklistActivityItem]! """ Approval request of this record that is pending or was rejected; null when there is none or it was approved. """ approval: ApprovalEntity } """ Lead type that classifies leads and defines their forms and the lead process they follow. """ type LeadTypeEntity { """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Lead process (pipeline) this lead type follows.""" leadProcess: LeadProcessEntity """ JSON definition of the form layout used by the UI when creating or editing leads of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formLost: JSONString! """True when the lost form is required on archiving leads of this type.""" formLostEnabled: Boolean! """ True when the lead type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Id of the lead process that leads of this type follow.""" leadProcessId: ID! """Name of the entity and its default text representation.""" name: String! """ Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. This payload conforms to the `EntityTypeSettings` JSON Schema: GET /api/v100/rest/schemas/EntityTypeSettings.json on your region's API host """ settings: EntityTypeSettings! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formLostApi: Form """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Lead process: the ordered steps that leads of its lead types move through. """ type LeadProcessEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """Steps that make up this lead process, in evaluation order.""" steps: [StepEntity!]! """Lead types that follow this lead process.""" leadTypes: [LeadTypeEntity!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Step of an opportunity pipeline, lead process or quote process that records move through. """ type StepEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Lead process this step belongs to. Set when the step is part of a lead process. """ leadProcess: LeadProcessEntity """ Opportunity pipeline this step belongs to. Set when the step is part of an opportunity pipeline. """ pipeline: PipelineEntity """ Quote process this step belongs to. Set when the step is part of a quote process. """ quoteProcess: QuoteProcessEntity """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String! """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """Id of the opportunity pipeline.""" pipelineId: ID """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectStepRelation relations by edge (relation) CloudObjectStepRelation attributes. """ filterEdge: CloudObjectStepRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectStepRelationEntityConnection """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists( """Filter StepChecklist relations by target StepChecklist attributes.""" filter: StepChecklistFilterInput """Order StepChecklist relations by target StepChecklist attributes.""" orderBy: [StepChecklistOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): StepChecklistEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sales pipeline: the ordered steps that opportunities of its opportunity types move through. """ type PipelineEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int! """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """ Steps that make up this pipeline, in the order opportunities move through them. """ steps: [StepEntity!]! """Opportunity types that follow this pipeline.""" opportunityTypes: [OpportunityTypeEntity!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Opportunity type that classifies opportunities and defines their forms (edit, qualify, won and lost). """ type OpportunityTypeEntity { """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Pipeline this opportunity type drives. Each opportunity type maps to exactly one pipeline. """ pipeline: PipelineEntity """ JSON definition of the form layout used by the UI when creating or editing opportunities of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formLost: JSONString! """ JSON definition of the form shown when qualifying a lead into an opportunity of this type. """ formQualify: JSONString! """ JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields. """ formWon: JSONString! """ True when the opportunity type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """Id of the pipeline this opportunity type drives.""" pipelineId: ID! """ Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. This payload conforms to the `EntityTypeSettings` JSON Schema: GET /api/v100/rest/schemas/EntityTypeSettings.json on your region's API host """ settings: EntityTypeSettings! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formLostApi: Form """ Ids of the fields shown on the form when a lead is qualified into an opportunity of this type. Read-only view of `formQualify`. """ formQualifyApi: [UUID] """ Ids of the fields shown on the form when an opportunity of this type is won. Read-only view of `formWon`. """ formWonApi: [UUID] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Quote process: the ordered steps that quotes of its quote types move through. """ type QuoteProcessEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """Steps that make up this quote process, in evaluation order.""" steps: [StepEntity!]! """Quote types that follow this quote process.""" quoteTypes: [QuoteTypeEntity!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Quote type that classifies quotes and defines their forms and the quote process they follow. """ type QuoteTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Quote process (pipeline) this quote type follows.""" quoteProcess: QuoteProcessEntity """ JSON definition of the form layout used by the UI when creating or editing quotes of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ JSON definition of the form shown when archiving (losing) a quote of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formLost: JSONString! """True when the lost form is required on archiving quotes of this type.""" formLostEnabled: Boolean! """ True when the quote type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """Id of the quote process that quotes of this type follow.""" quoteProcessId: ID! """ Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. This payload conforms to the `EntityTypeSettings` JSON Schema: GET /api/v100/rest/schemas/EntityTypeSettings.json on your region's API host """ settings: EntityTypeSettings! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formLostApi: Form """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of CloudObjectStepRelation records.""" type CloudObjectStepRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CloudObjectStepRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `CloudObjectStepRelationEntity` and its cursor. """ type CloudObjectStepRelationEntityEdge { """The item at the end of the edge""" node: CloudObjectStepRelationEntity """A cursor for use in pagination""" cursor: String! } """ File attached to a pipeline step, such as a document the sales team uses in that step. """ type CloudObjectStepRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """File attached to the step.""" cloudObject: CloudObjectEntity """Pipeline step the file is attached to.""" step: StepEntity """Id of the attached file.""" cloudObjectId: ID """Position of the file within the step's document list.""" sortOrder: Int """Id of the pipeline step.""" stepId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of CloudObject records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CloudObjectOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Application that produced the object (e.g. Online Forms). Sorts by fields of the related record, listed in order of priority. """ application: [ApplicationOrderByNestedInput!] """ Company-level folder that contains the object, when stored in the company document tree. Sorts by fields of the related record, listed in order of priority. """ companyCloudObjectFolder: [CloudObjectFolderOrderByNestedInput!] """ User who uploaded the object. Sorts by fields of the related record, listed in order of priority. """ creator: [ClientOrderByNestedInput!] """Id of the producing application.""" applicationId: OrderByEnum """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: OrderByEnum """Id of the uploading user.""" creatorId: OrderByEnum """File name (with extension) used when downloading the object.""" filename: OrderByEnum """When true, the object can be served via a public URL (see publicUrl).""" isPublic: OrderByEnum """Mime-type of the cloud object Is detected from content.""" mimeType: OrderByEnum """Size of the object in bytes.""" size: OrderByEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Application record. Set exactly one field in each item. """ input ApplicationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Identifier of the matching Automation Hub item, or empty for user-defined applications. Set automatically by Coevera when the application is registered through the Automation Hub. """ automationHubId: OrderByEnum """ True when this application can register webhooks. Set when the application is created and cannot be changed afterwards. """ isTrigger: OrderByEnum """ True when this application is shown in the Automation Hub UI. Hidden applications are still functional but excluded from end-user discovery. """ isVisible: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when this application can act on behalf of individual users (personal triggers). Set when the application is created and cannot be changed afterwards. """ usesImpersonation: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related CloudObjectFolder record. Set exactly one field in each item. """ input CloudObjectFolderOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. """ entityApiName: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the online form template, or empty when not associated with a form. """ onlineFormTypeId: OrderByEnum """Id of the parent folder, or empty for top-level folders.""" parentCloudObjectFolderId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Folder kind: Company for shared company folders, Record for folders attached to a specific record. """ type: OrderByEnum } """Paginated list of StepChecklist records.""" type StepChecklistEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [StepChecklistEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `StepChecklistEntity` and its cursor.""" type StepChecklistEntityEdge { """The item at the end of the edge""" node: StepChecklistEntity """A cursor for use in pagination""" cursor: String! } """ Checklist item of a pipeline step, such as logging an activity, filling a field or attaching a document. """ type StepChecklistEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment type that satisfies this checklist item. Set when activityTypeId resolves to an AppointmentType. """ appointmentType: AppointmentTypeEntity """ Task type that satisfies this checklist item. Set when activityTypeId resolves to a TaskType. """ taskType: TaskTypeEntity """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplate: CloudObjectTemplateEntity """Email sequence the item should enroll the record into.""" emailSequence: EmailSequenceEntity """ Field whose value satisfies this checklist item. Set when itemType is FieldType. """ field: FieldEntity """ Automatizer process that completes the item once it has run for the record. Set when itemType is RunProcess. """ process: ProcessEntity """ Field that supplies the recipient email address when the checklist item triggers sending an email. """ sendEmailField: FieldEntity """ Contact or Account lookup field whose primary record supplies the recipient. When set, sendEmailField is read from that record instead of the Primary Contact or Primary Account. Only lookup fields with a primary record are valid. """ sendEmailLookupField: FieldEntity """ Email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail. """ sendEmailTemplate: EmailTemplateEntity """Pipeline or process step this checklist item belongs to.""" step: StepEntity """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: ID """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: StepChecklistDocumentFormatEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: ID """Free-text description shown alongside the checklist item.""" description: String """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: ID """Id of the related field.""" fieldId: ID """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: StepChecklistTypeEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: StepChecklistValidationEnum """Display label of the checklist item.""" label: String """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: Boolean """Id of the related process.""" processId: ID """Id of the recipient field.""" sendEmailFieldId: ID """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: ID """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: ID """ Position of the checklist item within its step; lower values appear first. """ sortOrder: Int! """Id of the pipeline or process step this checklist item belongs to.""" stepId: ID! """ Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. This payload conforms to the `StepChecklistVisibilityFilter` JSON Schema: GET /api/v100/rest/schemas/StepChecklistVisibilityFilter.json on your region's API host """ visibilityCondition: StepChecklistVisibilityFilter! """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: StepChecklistVisibilityEnum """Revision when entity was lastly changed.""" revision: Int """ Sales roles the checklist item is shown to. Empty means the item is shown to all roles. """ salesRoles( """Filter SalesRole relations by target SalesRole attributes.""" filter: SalesRoleFilterInput """ Filter StepChecklistSalesRoleRelation relations by edge (relation) StepChecklistSalesRoleRelation attributes. """ filterEdge: StepChecklistSalesRoleRelationFilterInput """Order SalesRole relations by target SalesRole attributes.""" orderBy: [SalesRoleOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): StepChecklistSalesRoleRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Document template, such as a Word or Excel file with placeholders, used to generate documents filled with record data. """ type CloudObjectTemplateEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Application that produced the object (e.g. Online Forms).""" application: ApplicationEntity """ Company-level folder that contains the object, when stored in the company document tree. """ companyCloudObjectFolder: CloudObjectFolderEntity """User who uploaded the object.""" creator: ClientEntity """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String! """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """Mime-type of the cloud object Is detected from content.""" mimeType: String """Size of the object in bytes.""" size: Int! """ Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. """ status: CloudObjectTemplateStatusEnum """ Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. """ templateEntityName: EntityNameEnum! """ Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. Set on create only. """ type: CloudObjectTypeEnum! """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: String """Revision when entity was lastly changed.""" revision: Int """ API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. """ templateEntityApiName: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Automated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop. """ type EmailSequenceEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns this email sequence.""" owner: ClientEntity """ Reason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only. """ deactivationReason: EmailSequenceDeactivationReasonEnum """Free-form description of the sequence.""" description: String """ Master switch for the sequence. Read-only on this surface — change it via the enable / disable mutations. """ isEnabled: Boolean """Timestamp of the most recent change to settings. Read-only.""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled. Read-only.""" lastStatusChange: DateTime """Display name of the email sequence.""" name: String! """Id of the email sequence owner.""" ownerId: ID! """ JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe). This payload conforms to the `EmailSequenceSchema` JSON Schema: GET /api/v100/rest/schemas/EmailSequenceSchema.json on your region's API host """ settings: EmailSequenceSchema """ Process category of the sequence (e.g. EmailSequence vs other process types). """ type: ProcessTypeEnum! """Run history of the sequence — one log per scheduled execution.""" activityLogs( """ Filter EmailSequenceActivityLog relations by target EmailSequenceActivityLog attributes. """ filter: EmailSequenceActivityLogFilterInput """ Order EmailSequenceActivityLog relations by target EmailSequenceActivityLog attributes. """ orderBy: [EmailSequenceActivityLogOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceActivityLogEntityConnection """Attachments and other documents linked to this sequence.""" documents: [CloudObjectRelationEntity!] """ Enrolment records (recipients currently or previously running through the sequence). """ enrolled( """ Filter EmailSequenceEnrolled relations by target EmailSequenceEnrolled attributes. """ filter: EmailSequenceEnrolledFilterInput """ Order EmailSequenceEnrolled relations by target EmailSequenceEnrolled attributes. """ orderBy: [EmailSequenceEnrolledOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceEnrolledEntityConnection """ Effective status of the sequence (e.g. Scheduled, Running, Expired, Error). Read-only; derived from the active-from / active-to settings and the most recent activity log status. """ status: ProcessStatusEnum """ Timestamp the sequence last produced a run (delivered or attempted a step). """ lastEmailSequenceRun: DateTime """ Fraction of delivered emails (0–1) where at least one tracked link was clicked. """ clickRate: Float """ Fraction of sent emails (0–1) that bounced (the recipient mailserver rejected them). """ bounceRate: Float """ Fraction of delivered emails (0–1) that recorded at least one open event. """ openRate: Float """Fraction of delivered emails (0–1) where the recipient replied.""" replyRate: Float """Fraction of delivered emails (0–1) where the recipient unsubscribed.""" unsubscribeRate: Float """ Total number of emails produced (queued) by the sequence across all steps. """ createdCount: Int! """ Total number of emails actually delivered by the sequence across all steps. """ sentCount: Int! """ Number of records (Accounts/Contacts/Leads/Opportunities) currently enrolled in this sequence. """ enrollCount: Int! """ Solutions whose canvas contains this record. Deleted solutions are not included. """ solutions( """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionEntityConnection """ Entity name whose records trigger automatic enrollment into this sequence (e.g. "Lead", "Contact"). Empty when the sequence is manually enrolled only. """ triggerEntityName: EntityNameEnum """ Id of the field on the trigger entity whose value change drives enrollment (e.g. a step field on a Lead). Empty when no field-based trigger is configured. """ triggerFieldId: UUID """Number of steps configured in the sequence.""" stepCount: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Statistics of the sequence for the selected period: enrollments, sent emails, opens, clicks, replies and records created by its steps. """ stats( """Time window of the enrollments the statistics cover.""" period: EmailSequenceStatsPeriodEnum! ): EmailSequenceStats! } """Paginated list of EmailSequenceActivityLog records.""" type EmailSequenceActivityLogEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailSequenceActivityLogEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EmailSequenceActivityLogEntity` and its cursor. """ type EmailSequenceActivityLogEntityEdge { """The item at the end of the edge""" node: EmailSequenceActivityLogEntity """A cursor for use in pagination""" cursor: String! } """ Log of one run of an email sequence, with when it started and finished and who triggered it. """ type EmailSequenceActivityLogEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who initiated the run, or empty for runs triggered by automation.""" actor: ClientEntity """ Application context the run was triggered in (e.g. browser, automation, third-party integration). """ application: ApplicationEntity """Email sequence this activity log belongs to.""" emailSequence: EmailSequenceEntity """ Id of the user who initiated the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. """ applicationId: ID! """Id of the email sequence this activity log belongs to.""" emailSequenceId: ID! """Timestamp when the run finished. Empty for runs still in progress.""" endTime: DateTime """ True when the run was a dry-run / test execution and did not produce real-side effects. """ isTestRun: Boolean """Timestamp when the run started.""" startTime: DateTime! """Outcome of the run (e.g. Ok, Error, Cancelled).""" status: ProcessStatusEnum! """Step-by-step log lines produced during the run.""" lines( """ Filter EmailSequenceActivityLogLine relations by target EmailSequenceActivityLogLine attributes. """ filter: EmailSequenceActivityLogLineFilterInput """ Order EmailSequenceActivityLogLine relations by target EmailSequenceActivityLogLine attributes. """ orderBy: [EmailSequenceActivityLogLineOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceActivityLogLineEntityConnection """ Display name of the record this run enrolled (e.g. contact name). Read-only; computed by Coevera. """ recordName: String """ Email address of the record this run enrolled. Read-only; computed by Coevera. """ recordEmail: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of EmailSequenceActivityLogLine records.""" type EmailSequenceActivityLogLineEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailSequenceActivityLogLineEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EmailSequenceActivityLogLineEntity` and its cursor. """ type EmailSequenceActivityLogLineEntityEdge { """The item at the end of the edge""" node: EmailSequenceActivityLogLineEntity """A cursor for use in pagination""" cursor: String! } """ Entry in the log of an email sequence run, recording one step and its outcome. """ type EmailSequenceActivityLogLineEntity { """ Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id. """ formattedText: String! """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Activity log this line belongs to.""" emailSequenceActivityLog: EmailSequenceActivityLogEntity """Id of the activity log this line belongs to.""" emailSequenceActivityLogId: ID! """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its log run.""" sortOrder: Int! """Outcome of the step the line represents (e.g. Ok, Error, Skipped).""" status: ProcessStatusEnum """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of EmailSequenceActivityLogLine records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailSequenceActivityLogLineOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Activity log this line belongs to. Sorts by fields of the related record, listed in order of priority. """ emailSequenceActivityLog: [EmailSequenceActivityLogOrderByNestedInput!] """Id of the activity log this line belongs to.""" emailSequenceActivityLogId: OrderByEnum """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: OrderByEnum """Position of the line within its log run.""" sortOrder: OrderByEnum """Outcome of the step the line represents (e.g. Ok, Error, Skipped).""" status: OrderByEnum } """ Sorting by a field of the related EmailSequenceActivityLog record. Set exactly one field in each item. """ input EmailSequenceActivityLogOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the user who initiated the run, or empty for runs triggered by automation. """ actorId: OrderByEnum """ Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. """ applicationId: OrderByEnum """Id of the email sequence this activity log belongs to.""" emailSequenceId: OrderByEnum """Timestamp when the run finished. Empty for runs still in progress.""" endTime: OrderByEnum """ True when the run was a dry-run / test execution and did not produce real-side effects. """ isTestRun: OrderByEnum """Timestamp when the run started.""" startTime: OrderByEnum """Outcome of the run (e.g. Ok, Error, Cancelled).""" status: OrderByEnum """ Display name of the record this run enrolled (e.g. contact name). Read-only; computed by Coevera. """ recordName: OrderByEnum """ Email address of the record this run enrolled. Read-only; computed by Coevera. """ recordEmail: OrderByEnum } """ Sorting of EmailSequenceActivityLog records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailSequenceActivityLogOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who initiated the run, or empty for runs triggered by automation. Sorts by fields of the related record, listed in order of priority. """ actor: [ClientOrderByNestedInput!] """ Application context the run was triggered in (e.g. browser, automation, third-party integration). Sorts by fields of the related record, listed in order of priority. """ application: [ApplicationOrderByNestedInput!] """ Email sequence this activity log belongs to. Sorts by fields of the related record, listed in order of priority. """ emailSequence: [EmailSequenceOrderByNestedInput!] """ Id of the user who initiated the run, or empty for runs triggered by automation. """ actorId: OrderByEnum """ Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. """ applicationId: OrderByEnum """Id of the email sequence this activity log belongs to.""" emailSequenceId: OrderByEnum """Timestamp when the run finished. Empty for runs still in progress.""" endTime: OrderByEnum """ True when the run was a dry-run / test execution and did not produce real-side effects. """ isTestRun: OrderByEnum """Timestamp when the run started.""" startTime: OrderByEnum """Outcome of the run (e.g. Ok, Error, Cancelled).""" status: OrderByEnum """ Display name of the record this run enrolled (e.g. contact name). Read-only; computed by Coevera. """ recordName: OrderByEnum """ Email address of the record this run enrolled. Read-only; computed by Coevera. """ recordEmail: OrderByEnum } """ Sorting by a field of the related EmailSequence record. Set exactly one field in each item. """ input EmailSequenceOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Reason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only. """ deactivationReason: OrderByEnum """Free-form description of the sequence.""" description: OrderByEnum """ Master switch for the sequence. Read-only on this surface — change it via the enable / disable mutations. """ isEnabled: OrderByEnum """Timestamp of the most recent change to settings. Read-only.""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled. Read-only.""" lastStatusChange: OrderByEnum """Display name of the email sequence.""" name: OrderByEnum """Id of the email sequence owner.""" ownerId: OrderByEnum """ Process category of the sequence (e.g. EmailSequence vs other process types). """ type: OrderByEnum """ Effective status of the sequence (e.g. Scheduled, Running, Expired, Error). Read-only; derived from the active-from / active-to settings and the most recent activity log status. """ status: OrderByEnum """ Timestamp the sequence last produced a run (delivered or attempted a step). """ lastEmailSequenceRun: OrderByEnum """ Fraction of delivered emails (0–1) where at least one tracked link was clicked. """ clickRate: OrderByEnum """ Fraction of sent emails (0–1) that bounced (the recipient mailserver rejected them). """ bounceRate: OrderByEnum """ Fraction of delivered emails (0–1) that recorded at least one open event. """ openRate: OrderByEnum """Fraction of delivered emails (0–1) where the recipient replied.""" replyRate: OrderByEnum """Fraction of delivered emails (0–1) where the recipient unsubscribed.""" unsubscribeRate: OrderByEnum """ Total number of emails produced (queued) by the sequence across all steps. """ createdCount: OrderByEnum """ Total number of emails actually delivered by the sequence across all steps. """ sentCount: OrderByEnum """ Number of records (Accounts/Contacts/Leads/Opportunities) currently enrolled in this sequence. """ enrollCount: OrderByEnum """ Names of the solutions whose canvas contains this sequence, in name order. Empty when the sequence is on no solution canvas. """ solutions: OrderByEnum """ Entity name whose records trigger automatic enrollment into this sequence (e.g. "Lead", "Contact"). Empty when the sequence is manually enrolled only. """ triggerEntityName: OrderByEnum """ Id of the field on the trigger entity whose value change drives enrollment (e.g. a step field on a Lead). Empty when no field-based trigger is configured. """ triggerFieldId: OrderByEnum """Number of steps configured in the sequence.""" stepCount: OrderByEnum } """Paginated list of EmailSequenceEnrolled records.""" type EmailSequenceEnrolledEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailSequenceEnrolledEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EmailSequenceEnrolledEntity` and its cursor. """ type EmailSequenceEnrolledEntityEdge { """The item at the end of the edge""" node: EmailSequenceEnrolledEntity """A cursor for use in pagination""" cursor: String! } """ Record enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it. """ type EmailSequenceEnrolledEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account that was enrolled, when the trigger entity is an Account; otherwise empty. """ account: AccountEntity """ User who triggered the enrolment, or empty for runs triggered by automation. """ actor: ClientEntity """Application context the enrolment was triggered in.""" application: ApplicationEntity """ Contact that was enrolled, when the trigger entity is a Contact; otherwise empty. """ contact: ContactEntity """Activity log run that produced this enrolment.""" emailSequenceActivityLog: EmailSequenceActivityLogEntity """Email sequence this enrolment belongs to.""" emailSequence: EmailSequenceEntity """ Lead that was enrolled, when the trigger entity is a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty. """ oppty: OpportunityEntity """ Project that was enrolled, when the trigger entity is a Project; otherwise empty. """ project: ProjectEntity """Id of the enrolled account.""" accountId: ID """ Id of the user who triggered the enrolment, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in. """ applicationId: ID! """Id of the enrolled contact.""" contactId: ID """Id of the activity log run that produced this enrolment.""" emailSequenceActivityLogId: ID! """Id of the email sequence this enrolment belongs to.""" emailSequenceId: ID! """ Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active. """ endReason: EmailSequenceEndReasonEnum """ Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active. """ endTime: DateTime """ Id of the enrolled record: the account, contact, lead, opportunity or project that is set. Read-only. """ entityId: ID! """Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only.""" entityType: BaseEntityTypeEnum! """ True when this enrolment is excluded from sequence statistics (e.g. after a stats reset). """ excludedFromStats: Boolean """Id of the enrolled lead.""" leadId: ID """Id of the enrolled opportunity.""" opptyId: ID """Id of the enrolled project.""" projectId: ID """Timestamp when the enrolment started.""" startTime: DateTime! """Number of steps the enrolment has reached. Read-only.""" stepCount: Int! """ Display name of the enrolled record, formatted according to the calling user's preferred name format. Empty when the underlying record has been deleted. """ name: String """Email address used for delivery of this enrolment.""" address: String """ Zero-based index of the next step the enrolment will execute (i.e. one past the highest stepIndex recorded in EmailSequenceEnrolledStatus). Empty before the first step runs. """ stepIndex: Int """ Status of the enrolment's most recent sequence run (e.g. Ok, Warning, Error). Empty before the first run. """ status: ProcessStatusEnum """ Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entityType. """ entityName: EntityNameEnum! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. """ type OpportunityEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Quote currently used to drive the opportunity (e.g. for synchronisation of monetary fields). Empty when no quote is active. """ activeQuote: QuoteEntity """ Currency exchange rate list used to convert monetary fields linked to this opportunity. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ How the opportunity originated (e.g. Website, Referral, Trade Show). Configurable per team space. """ leadSource: DataEntity """ Opportunity type that classifies this opportunity. Each type maps to one pipeline and drives which form, fields and stages apply. """ opptyType: OpportunityTypeEntity """Sales user who owns this opportunity.""" owner: ClientEntity """Currency used for product line-item prices on this opportunity.""" productCurrency: CurrencyEntity """ Product price list used to populate prices for product line items added to this opportunity. Empty to use catalog defaults. """ productPriceList: ProductPriceListEntity """ Configurable reason recorded when the opportunity is archived (lost). Required when the lost form mandates it. """ reasonOfClose: DataEntity """ Pipeline step the opportunity is currently sitting in. Reaching the last step in the pipeline marks the opportunity as won; archiving sets it to lost. """ step: StepEntity """ Sales unit this opportunity is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """ Id of the quote currently synchronized with this opportunity, or empty when no quote is active. A quote can be active on only one opportunity at a time. """ activeQuoteId: ID """Expected or actual closing date of the opportunity.""" closingDate: Date! """Id of the currency exchange rate list applied to this opportunity.""" currencyExchangeRatesListId: ID """Free-form description of the opportunity.""" description: String """ True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. """ isValueAutoCalculate: Boolean """ User-set colored flag used to highlight the opportunity in lists and reports. """ labelFlag: Int """ Time when an AI-suggested buying center was last applied to this opportunity. """ lastAiBuyingCenterApplied: DateTime """Id of the lead source the opportunity originated from.""" leadSourceId: ID """Name of the entity and its default text representation.""" name: String! """Id of the opportunity type.""" opptyTypeId: ID """Id of the opportunity owner.""" ownerId: ID! """ Id of the currency used for product line-item prices on this opportunity. """ productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: [ProductSection!] """ Free-text company email captured at opportunity creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at opportunity creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at opportunity creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at opportunity creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at opportunity creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. """ ranking: Int """Free-form note explaining why the opportunity was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the opportunity was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the pipeline step.""" stepId: ID! """ Discriminator identifying the concrete record type — always "opportunity" for Opportunity records. Read-only; useful when consuming polymorphic LeadOppty results. """ tableName: String! """Id of the sales unit.""" unitId: ID """ True when the opportunity has gone through the qualification step at least once. """ wasQualified: Boolean """Revision when entity was lastly changed.""" revision: Int """ Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. """ value: CurrencyForeignField """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int! """ Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. """ opptyRecurrence: OpptyRecurrenceEntity """ Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. """ revenueSchedule: OpptyRevenueScheduleEntity """ Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when isValueAutoCalculate is true. """ productRelations( """Filter Product relations by target Product attributes.""" filter: ProductFilterInput """ Filter OpptyProductRelation relations by edge (relation) OpptyProductRelation attributes. """ filterEdge: OpptyProductRelationFilterInput """Order Product relations by target Product attributes.""" orderBy: [ProductOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationEntityConnection """ Primary contact of this opportunity. Set automatically from the contact relation marked as primary. """ primaryContact: ContactEntity """ Primary account of this opportunity. Set automatically from the account relation marked as primary. """ primaryAccount: AccountEntity """ Contacts linked to this opportunity, including their roles and org-chart positions. """ contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter LeadOpptyContactRelation relations by edge (relation) LeadOpptyContactRelation attributes. """ filterEdge: LeadOpptyContactRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyContactRelationEntityConnection """ Accounts linked to this opportunity, including the primary-account flag. """ accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter LeadOpptyAccountRelation relations by edge (relation) LeadOpptyAccountRelation attributes. """ filterEdge: LeadOpptyAccountRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyAccountRelationEntityConnection """Documents linked to this opportunity.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """Quotes prepared for this opportunity.""" quoteRelations( """Filter Quote relations by target Quote attributes.""" filter: QuoteFilterInput """Order Quote relations by target Quote attributes.""" orderBy: [QuoteOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteEntityConnection """ Current status of the opportunity (Open, Won, Lost). Read-only; derived from the current pipeline step and the archived flag. """ status: OpptyStatusEnum! """ Timestamp of when the opportunity was qualified, taken from the matching KPI event. Empty for opportunities that have not been qualified. Read-only. """ qualifyDate: DateTime """ Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. """ wonDate: DateTime """ Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. """ lostDate: DateTime """ Number of days the opportunity has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event and per-step timeframe history. """ daysInStep: Int! """ True when the current authenticated user has marked this opportunity as favorite. Per-user. """ isFavorite: Boolean! """ Sales units that have been granted shared access to this opportunity. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter LeadOpptySharingSalesUnitRelation relations by edge (relation) LeadOpptySharingSalesUnitRelation attributes. """ filterEdge: LeadOpptySharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptySharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this opportunity. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter LeadOpptySharingClientRelation relations by edge (relation) LeadOpptySharingClientRelation attributes. """ filterEdge: LeadOpptySharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptySharingClientRelationEntityConnection """Tag labels applied to this opportunity.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Saved view profiles this opportunity currently matches.""" staticProfiles( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ProfileRelation relations by edge (relation) ProfileRelation attributes. """ filterEdge: ProfileRelationFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """ Filled only when a single record is read by its id; otherwise null or an empty list. """ fitness: WarningLevelEnum """ Filled only when a single record is read by its id; otherwise null or an empty list. """ fitnessDescription: FitnessDescription """Display version of the opportunity name, used in lists and references.""" formattedName: String! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """ Checklist items of the steps of the record's pipeline, with the completion state of each item for this record. """ stepChecklists( """ Ids of the step checklist items to return. When not set, the items of all steps of the record's pipeline are returned. """ stepChecklistIds: [UUID] ): [StepChecklistActivityItem]! """ Approval request of this record that is pending or was rejected; null when there is none or it was approved. """ approval: ApprovalEntity } """ Price offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process. """ type QuoteEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Currency exchange rate list used to convert monetary fields linked to this quote. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """Opportunity this quote was prepared for. Empty for standalone quotes.""" oppty: OpportunityEntity """Sales user who owns this quote.""" owner: ClientEntity """Currency used for product line-item prices on this quote.""" productCurrency: CurrencyEntity """ Product price list used to populate prices for product line items added to this quote. Empty to use catalog defaults. """ productPriceList: ProductPriceListEntity """ Quote type that classifies this quote. Each type maps to one quote process and drives which form, fields and stages apply. """ quoteType: QuoteTypeEntity """ Configurable reason recorded when the quote is archived (lost). Required when the lost form mandates it. """ reasonOfClose: DataEntity """ Quote-process step the quote is currently sitting in. Reaching the last step in the process marks the quote as accepted. """ step: StepEntity """ Sales unit this quote is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: ID """Free-form description of the quote.""" description: String """Date after which the quote is no longer considered valid.""" expirationDate: Date """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Name of the entity and its default text representation.""" name: String! """Id of the opportunity.""" opptyId: ID """Id of the quote owner.""" ownerId: ID! """Id of the currency used for product line-item prices on this quote.""" productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: [ProductSection!] """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: String """ Auto-generated sequential identifier of the quote, used for human-readable reference. """ quoteNumber: String """Id of the quote type that classifies this quote.""" quoteTypeId: ID """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the quote-process step.""" stepId: ID! """Id of the sales unit.""" unitId: ID """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: Int """Revision when entity was lastly changed.""" revision: Int """ Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. """ totalAmount: CurrencyForeignField """ Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to totalAmount. """ productRelations( """Filter Product relations by target Product attributes.""" filter: ProductFilterInput """ Filter OpptyProductRelation relations by edge (relation) OpptyProductRelation attributes. """ filterEdge: OpptyProductRelationFilterInput """Order Product relations by target Product attributes.""" orderBy: [ProductOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationEntityConnection """ Primary contact of this quote. Set automatically from the contact relation marked as primary. """ primaryContact: ContactEntity """ Primary account of this quote. Set automatically from the account relation marked as primary. """ primaryAccount: AccountEntity """Contacts linked to this quote.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter QuoteContactRelation relations by edge (relation) QuoteContactRelation attributes. """ filterEdge: QuoteContactRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteContactRelationEntityConnection """Accounts linked to this quote, including the primary-account flag.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter QuoteAccountRelation relations by edge (relation) QuoteAccountRelation attributes. """ filterEdge: QuoteAccountRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteAccountRelationEntityConnection """Documents linked to this quote.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ Sales units that have been granted shared access to this quote. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter QuoteSharingSalesUnitRelation relations by edge (relation) QuoteSharingSalesUnitRelation attributes. """ filterEdge: QuoteSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteSharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this quote. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter QuoteSharingClientRelation relations by edge (relation) QuoteSharingClientRelation attributes. """ filterEdge: QuoteSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteSharingClientRelationEntityConnection """ Current status of the quote (Open, Lost, Accepted). Read-only; derived from the current step and the archived flag. """ status: QuoteStatusEnum! """Display version of the quote name, used in lists and references.""" formattedName: String! """ True when the current authenticated user has marked this quote as favorite. Per-user. """ isFavorite: Boolean! """If quote is set as active in opportunity.""" isActiveInOpportunity: Boolean """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """Saved view profiles this quote currently matches.""" staticProfiles( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ProfileRelation relations by edge (relation) ProfileRelation attributes. """ filterEdge: ProfileRelationFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """Tag labels applied to this quote.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """Activities of this project linked to the given project objective.""" projectObjectiveActivitiesDrilldown( """Project objective whose activities are returned.""" projectObjectiveId: UUID ): CompactViewDrilldownModel! """ Checklist items of the steps of the record's quote process, with the completion state of each item for this record. """ stepChecklists( """ Ids of the step checklist items to return. When not set, the items of all steps of the record's quote process are returned. """ stepChecklistIds: [UUID] ): [StepChecklistActivityItem]! """ Approval request of this record that is pending or was rejected; null when there is none or it was approved. """ approval: ApprovalEntity } """ Price list with product prices per currency, applied to opportunities and quotes while it is active. """ type ProductPriceListEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form description of the price list.""" description: String """Date when the price list expires. Empty means open-ended.""" endDate: Date """ Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates. """ isActive: Boolean """Name of the entity and its default text representation.""" name: String! """ Conditions that determine which opportunities or quotes the price list applies to (for example by sales unit, account or custom field). """ rules: FieldFilter """Date when the price list becomes active. Empty means immediately.""" startDate: Date """ Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled). """ type: ProductPriceListTypeEnum """Revision when entity was lastly changed.""" revision: Int """ True for the team space default price list, which cannot be deleted. Read-only. """ isDefault: Boolean! """ Effective status of the price list (Active, Inactive, Scheduled, Expired). Read-only; derived from isActive and the start/end dates. """ status: ProductPriceListStatusEnum! """Per-product, per-currency prices configured in the price list.""" productPriceListPrices( """Filter Product relations by target Product attributes.""" filter: ProductFilterInput """ Filter ProductPriceListPrice relations by edge (relation) ProductPriceListPrice attributes. """ filterEdge: ProductPriceListPriceFilterInput """Order Product relations by target Product attributes.""" orderBy: [ProductOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductPriceListPriceEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProductPriceListPrice records.""" type ProductPriceListPriceEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProductPriceListPriceEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProductPriceListPriceEntity` and its cursor. """ type ProductPriceListPriceEntityEdge { """The item at the end of the edge""" node: ProductPriceListPriceEntity """A cursor for use in pagination""" cursor: String! } """Price of a product in one currency within a price list.""" type ProductPriceListPriceEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Currency the price value is denominated in.""" currency: CurrencyEntity """Product the price applies to.""" product: ProductEntity """Price list the price belongs to.""" productPriceList: ProductPriceListEntity """Id of the currency the price is denominated in.""" currencyId: ID! """ Price amount stored at 6-decimal precision; values set via the API are rounded. """ price: Float """Id of the product the price applies to.""" productId: ID! """Id of the price list this price belongs to.""" productPriceListId: ID! """ Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object. """ settings: ProductPriceListPriceSettings! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Product or service in the catalog that can be added as a line item to opportunities and quotes. """ type ProductEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Currency exchange rate list used to convert monetary fields linked to this product. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """Product picture.""" picture: CloudObjectEntity """ Product category this product belongs to. Categories form a hierarchy used in the catalog browser. """ productCategory: ProductCategoryEntity """ Product type that classifies this product. Product types are configurable per team space and drive which form, fields and product-line behavior apply. """ productType: ProductTypeEntity """ Whether this product can be added to all pipelines or only the explicitly linked subset (see productPipelineRelations). """ allowedPipelines: AccessPipelinesEnum """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: ID """Free-form description of the product.""" description: String """Name of the product, shown in catalogues and pickers.""" name: String! """Id of the product picture document.""" pictureId: ID """ Id of the product category this product belongs to, or empty when it is not categorized. """ productCategoryId: ID """Id of the product type that classifies this product.""" productTypeId: ID """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: String """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: String """Revision when entity was lastly changed.""" revision: Int """Deprecated pipeline connection.""" productPipelineRelations( """Filter Pipeline relations by target Pipeline attributes.""" filter: PipelineFilterInput """ Filter ProductPipelineRelation relations by edge (relation) ProductPipelineRelation attributes. """ filterEdge: ProductPipelineRelationFilterInput """Order Pipeline relations by target Pipeline attributes.""" orderBy: [PipelineOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductPipelineRelationEntityConnection """Configuration of Pipelines where the Product can be used.""" productPipelines: ProductPipelinesObject """Display version of the product name, used in lists and references.""" formattedName: String! """ Id of the product line-item type derived from productType. Used as a filter when listing relations on opportunities and quotes. Read-only. """ opptyProductRelationTypeId: UUID! """ Active price lists this product is priced in, ordered by name. Read-only; computed by Coevera. """ priceLists: [ProductPriceListReference!] """ Active price schedules this product is priced in, ordered by name. Read-only; computed by Coevera. """ priceSchedules: [ProductPriceListReference!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Price of the product in the given price list and currency. Returns 0 when either is not given or the product has no price for that combination. """ priceListPrice( """Price list to read the price from.""" priceListId: ID """Currency of the price.""" currencyId: ID ): Float } """Category in the hierarchy of the product catalog.""" type ProductCategoryEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Parent category in the catalog hierarchy. Empty for top-level categories. """ parent: ProductCategoryEntity """Name of the entity and its default text representation.""" name: String! """Id of the parent category.""" parentId: ID """Revision when entity was lastly changed.""" revision: Int """All Products in this category.""" productRelations( """Filter Product relations by target Product attributes.""" filter: ProductFilterInput """Order Product relations by target Product attributes.""" orderBy: [ProductOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of Product records.""" type ProductEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProductEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProductEntity` and its cursor.""" type ProductEntityEdge { """The item at the end of the edge""" node: ProductEntity """A cursor for use in pagination""" cursor: String! } """ Sorting of Product records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProductOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Currency exchange rate list used to convert monetary fields linked to this product. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Product category this product belongs to. Categories form a hierarchy used in the catalog browser. Sorts by fields of the related record, listed in order of priority. """ productCategory: [ProductCategoryOrderByNestedInput!] """ Product type that classifies this product. Product types are configurable per team space and drive which form, fields and product-line behavior apply. Sorts by fields of the related record, listed in order of priority. """ productType: [ProductTypeOrderByNestedInput!] """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the product.""" description: OrderByEnum """Name of the product, shown in catalogues and pickers.""" name: OrderByEnum """ Id of the product category this product belongs to, or empty when it is not categorized. """ productCategoryId: OrderByEnum """Id of the product type that classifies this product.""" productTypeId: OrderByEnum """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: OrderByEnum """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related ProductCategory record. Set exactly one field in each item. """ input ProductCategoryOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the parent category.""" parentId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ProductType record. Set exactly one field in each item. """ input ProductTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the product type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the paired opportunity/quote line-item type.""" opptyProductRelationTypeId: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Product type that classifies products and defines their form.""" type ProductTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Opportunity / quote line-item type paired with this product type. Drives the form used when adding products of this type as line items. """ opptyProductRelationType: OpptyProductRelationTypeEntity """ JSON definition of the form layout used by the UI when creating or editing products of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ True when the product type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """Id of the paired opportunity/quote line-item type.""" opptyProductRelationTypeId: ID! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Line-item type that defines the form of product line items on opportunities and quotes; paired with a product type. """ type OpptyProductRelationTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ True when the line-item type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """Product type paired with this line-item type.""" productType: ProductTypeEntity """Id of the paired product type. Read-only.""" productTypeId: UUID! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProductPipelineRelation records.""" type ProductPipelineRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProductPipelineRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProductPipelineRelationEntity` and its cursor. """ type ProductPipelineRelationEntityEdge { """The item at the end of the edge""" node: ProductPipelineRelationEntity """A cursor for use in pagination""" cursor: String! } """Pipeline in which a product can be added as a line item.""" type ProductPipelineRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Pipeline in which the product can be added as a line item.""" pipeline: PipelineEntity """Product available in the linked pipeline.""" product: ProductEntity """Id of the pipeline in which the product can be added as a line item.""" pipelineId: ID! """Id of the product made available in the pipeline.""" productId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of Pipeline records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input PipelineOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Pipelines in which a product can be added to opportunities.""" type ProductPipelinesObject { """ Ids of the pipelines the product can be added in. Effective only when allowedPipelines is Selected. """ pipelines: [ID!]! """ Whether the product can be added in all pipelines (All) or only in those listed in pipelines (Selected). """ allowedPipelines: AccessPipelinesEnum! } """Id and name of one price list a product is priced in.""" type ProductPriceListReference { """Id of the price list.""" id: ID! """Name of the price list.""" name: String! } """ Who can change a price list price of a product on the product lines of opportunities and quotes. """ type ProductPriceListPriceSettings { """ Who can change this price on a product line of an opportunity or quote: nobody (NoAccess), all users (All) or only users with a role in accessRoles (Role). """ access: ProductPriceListPriceAccessEnum! """ Ids of the user roles allowed to change the price. Effective only when access is Role. """ accessRoles: [UUID!] } """ Who can change the price taken from a price list when the product is added to a record. """ enum ProductPriceListPriceAccessEnum { """Nobody can change the price.""" NoAccess """All users can change the price.""" All """Only users whose role is listed in accessRoles can change the price.""" Role } """ Amount in a foreign currency together with its value in the base currency of the space. """ type CurrencyForeignField { """ Value in the base currency of the space. If empty, it is calculated from valueForeign at the current exchange rate. """ baseValue: Float """Id of the currency of valueForeign.""" currencyId: ID! """ Value in the currency set by currencyId. If empty, it is calculated from baseValue at the current exchange rate. """ valueForeign: Float """ Value converted into the current user's currency. Not filled on records; always null. """ convertedValue: Float """ Id of the currency of convertedValue. Not filled on records; always null. """ convertedValueCurrencyId: UUID } """Paginated list of OpptyProductRelation records.""" type OpptyProductRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyProductRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OpptyProductRelationEntity` and its cursor.""" type OpptyProductRelationEntityEdge { """The item at the end of the edge""" node: OpptyProductRelationEntity """A cursor for use in pagination""" cursor: String! } """ Product line item on an opportunity or quote, with its quantity, price and discount. """ type OpptyProductRelationEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ Online form field that produced this line item, or empty when not applicable. """ onlineFormField: FieldEntity """ Online form this line item came from when the related opportunity was created through a form submission, or empty otherwise. """ onlineForm: OnlineFormEntity """ Opportunity this line item belongs to. Set on create; mutually exclusive with quote. """ oppty: OpportunityEntity """ Line-item type that drives the form layout for this product line. Resolved from the product type on create. """ opptyProductRelationType: OpptyProductRelationTypeEntity """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. """ pairedOpptyProductRelation: OpptyProductRelationEntity """ Product on this line item. Set on create; cannot be changed afterwards. """ product: ProductEntity """ Quote this line item belongs to. Set on create; mutually exclusive with opportunity. """ quote: QuoteEntity """ Total amount of the line item (price * quantity, with discounts applied). """ amount: Float """Free-form note describing this line item.""" comment: String """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: ID """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: ID """ Id of the online form submission this line item came from, or empty when it was not created through a form. """ onlineFormId: ID """Id of the opportunity.""" opptyId: ID """Id of the line-item type.""" opptyProductRelationTypeId: ID """Id of the paired line item.""" pairedOpptyProductRelationId: ID """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: Float """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: ID! """Number of product units on this line item.""" quantity: Float """ Id of the quote this line item belongs to. Mutually exclusive with opptyId. """ quoteId: ID """ Identifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote). """ sectionId: ID """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. """ revenueSchedule: OpptyProductRelationRevenueScheduleEntity """ Absolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountValue: Float """ Percentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountPercentage: Float """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Field of an entity, built-in or custom, with its name, type and configuration. """ type FieldEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """True when the field is marked as deleted (soft-delete).""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ 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. """ entityName: String! """Immutable and generated name. This name is used for integrations.""" apiName: String """User friendly name for field.""" name: String! """ When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown. """ useLang: Int """ Storage column name for the field; used as the filter key in API queries. """ columnName: String """ Storage origin of the field: on the main entity record, on the custom-field data record, or computed. """ columnSource: Int """ For relation-typed fields, identifier of the relation kind that connects this entity to the related entity. Empty for non-relation fields. """ relationId: String """ For relation-typed fields, the entity the field points to (e.g. Contact, Account). Empty for non-relation fields. """ relationWithEntityId: String """ 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. """ sharedWithFieldId: ID """ Whether the field is System (built-in, immutable), Protected (built-in, limited changes), or Custom (user-created). """ systemType: Int """ 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 """ typeId: String! """ 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. """ compositeFieldId: ID """Optional custom data set id can be set.""" dataSetId: ID """ For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. """ parentOptionsFieldId: ID """Calculated formula used for fields which supports calculation.""" calcFormula: String """ 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. """ defaultValue: String """ For sequence-typed fields, id grouping the FieldSequence rows that drive auto-numbering for this field. """ sequenceSetId: ID """ Deprecated; always returns null. Use sequenceSetId and FieldSequence instead. """ sequenceId: UUID """ True when the field cannot be made optional (enforced by the platform). """ systemRequired: Boolean """ True when the field configuration is published; false while the field exists only as an unpublished draft. """ isPublished: Boolean """ True when the field cannot be made writable (enforced by the platform). """ systemReadonly: Boolean """If this field is allowed in global search.""" useInGlobalSearch: Boolean """ Type-specific configuration for the field (e.g. rollup definition, calculated formula, AI options). Shape depends on type_id; null for fields that need no extra configuration. This payload conforms to the `FieldOptionsProperty` JSON Schema: GET /api/v100/rest/schemas/FieldOptionsProperty.json on your region's API host """ settings: JSONString """ If true, then there will be an API validation if value of entity is unique. """ isUnique: Boolean """ For dropdown, radio, and multiselect-checkbox fields, the set of available options. Empty for other field types. """ dataSet( """When true, deleted options are returned too.""" includeDeleted: Boolean = false ): [FieldDataSetRelation!] """Lookup field definition.""" lookup: LookupProperty """ Deprecated - previously returned sequence pattern used for sequence type of field. """ sequencePattern: String """Sequence field definition.""" sequence: SequenceProperty """Rollup field definition.""" rollup: RollupProperty """ Type-specific settings of the field, such as the decimal places of a number or the display of a record card; the shape depends on typeId. Empty for types without settings. """ options: FieldOptionsProperty """ AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency. """ aiOptions: FieldAiOptions """ Formula of a calculated formula field - the expression, its result type and display - as a JSON object conforming to the `AdvancedFormulaProperty` type; empty for other field types. """ advancedFormula: AdvancedFormulaProperty """ For derived fields, id of the underlying source field that drives this field's value (e.g. the value side of a composite currency field). """ sourceFieldId: String! """ Underlying primitive type id of the field, after resolving composite/rollup/lookup wrappers. """ sourceTypeId: String! """True when the field can be used in the record interface preview pane.""" useInInterfacePreview: Boolean! """ Field name resolved into the current user's language. When useLang is true, the name is looked up via the translation system; otherwise name is returned as-is. """ translatedName: String! """ Per-user-role access overrides for this field. Empty when the field uses default access (full access for all roles). """ fieldPermissions( """When true, deleted permission overrides are returned too.""" includeDeleted: Boolean = false ): [FieldPermissionEntity!] """ When multiple dropdown/radio fields share a data set, id of the field that originally defined the data set. Null when this field is the originator or has no data set. """ originalDatasetFieldId: UUID """ Map of locale codes to translated field names (e.g. {"en-US": "First name", "de-DE": "Vorname"}). Empty when no translations are defined. """ nameTranslations: JSONString! """ Field name in the current user's language, taken from nameTranslations. Empty when no translation is available for that language. """ nameTranslated: String """ Primitive value type of the field (e.g. STRING, INT, BOOL, DATE, ENUM), derived from sourceTypeId. """ primitiveType: String! """ True when the field cannot be edited on individual occurrences of a recurring appointment (changes must be made on the recurrence master). """ isReadonlyOnRecurrentAppointment: Boolean! """True when the field can be referenced from a Webresource URL template.""" isAvailableForWebresource: Boolean! """ True when the field can be used as an input in an advanced calculated formula expression on this entity. """ isAvailableForAdvancedFormula: Boolean! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Option of a dropdown, radio or multiselect field, with the parent field values it is available for. """ type FieldDataSetRelation { """Option of the data set.""" entity: DataEntity! """ For dependent fields, the values of the parent field this option is available for; null when the field has no parent options field. """ allowedBy: [ID!] } """ Definition of a lookup field: the entity it links to, which records can be selected and the tab that shows the linked records. """ type LookupProperty { """ Entity the lookup field links to; CustomEntity for a custom entity (see entityApiName). """ entityType: LookupEntityTypeEnum """Name of the tab that shows the records linked through this field.""" tabName: String! """Condition limiting which records can be selected in the field.""" filter: FieldFilter """ When true, the field offers only records related to the record being edited (e.g. the contacts of its account). Allowed only from Account (to Account, Contact, Opportunity, Task, Appointment), Contact, Project (to Opportunity, Task, Appointment), Lead / Opportunity (to Task, Appointment), Quote (to Opportunity, Account, Contact, Task, Appointment) and a custom entity (to Account, Contact, Task, Appointment, Project, Quote); any entity may target a custom entity. Elsewhere it must be false. """ showRelated: Boolean! """ API name of the linked custom entity when entityType is CustomEntity; null otherwise. """ entityApiName: String """ Id of the matching lookup field on the linked entity, which shows the same links from the other side. Set by the server; ignored on input. """ oppositeLookupFieldId: UUID """ When true, one of the linked records can be marked as primary. Cannot be switched back to false once enabled. """ hasPrimaryRelation: Boolean } """Entity that a lookup field links to.""" enum LookupEntityTypeEnum { """ Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. """ Account """ Person the sales team works with, usually linked to one or more accounts, leads and opportunities. """ Contact """ Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. """ Lead """ Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. """ Opportunity """ Task (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records. """ Task """ Meeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns. """ Appointment """ Product or service in the catalog that can be added as a line item to opportunities and quotes. """ Product """Product line of an opportunity.""" OpptyProductRelation """Users of the space.""" Client """ Project delivered for an account or run internally, with its objectives, activities and progress. """ Project """ Price offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process. """ Quote """ Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. """ CustomEntity } """ Automatic numbering of a sequence field: a default numbering sequence and conditional ones chosen by record filters. """ type SequenceProperty { """Sequence used for records that match none of the `items`.""" defaultItem: SequenceItemProperty! """ Conditional sequences, checked in order; a record is numbered by the first one whose filter it matches. """ items: [SequenceItemProperty!]! } """ One numbering sequence of a sequence field: its number pattern, the records it numbers and the last number it issued. """ type SequenceItemProperty { """Id of the sequence; empty for a new sequence.""" id: ID """ Pattern template used to generate auto-numbered values (e.g. "{prefix}{year}-{####}"). """ pattern: String! """ Conditions a record must meet to be numbered by this sequence; empty matches every record. """ filter: FieldFilter """Last number issued by the sequence and its period. Read-only.""" lastParticle: SequenceParticleProperty } """ Last number issued by a numbering sequence of a sequence field, with the year and month of its numbering period. """ type SequenceParticleProperty { """Year of the numbering period; 0 when the pattern has no year.""" year: Int! """Month of the numbering period; 0 when the pattern has no month.""" month: Int! """Last number issued in the period.""" sequenceNumber: Int! } """ Type-specific settings of a field; which member type is returned depends on the field type. """ union FieldOptionsProperty = RollupProperty | TextAreaProperty | CurrencyProperty | CurrencyForeignProperty | ProductPriceProperty | MultiSelectProperty | FloatProperty | IntegerProperty | ClosingDateProperty | DueDateProperty | LookupSettingsProperty | AdvancedFormulaProperty | FileUploadProperty | OnlineFormProductServicesProperty | AccountCardProperty | ContactCardProperty | OpptyCardProperty | ParentAccountCardProperty | ProjectAccountCardProperty | ContactAccountCardProperty | ProjectContactCardProperty | LinkedItemsProperty | GenderProperty | CountryProperty | LastContactedDateProperty """ AI Smart Field settings of a field: whether AI generates its value, from which data and when. """ type FieldAiOptions { """ When true, the field is an AI Smart Field whose value is generated by AI. """ isEnabled: Boolean! """ What the AI uses to generate the value: the prompt and the data sources. """ general: FieldAiGeneralOptions! """When the AI value is generated or updated.""" valueUpdate: FieldAiValueUpdateOptions! } """ What the AI uses to generate the value of an AI Smart Field: the prompt and the enabled data sources. """ type FieldAiGeneralOptions { """ Instruction the AI follows to generate the field value; it can contain placeholders for values of the record. """ prompt: String! """ When true, the AI can use the data sources enabled below (web search, record data, related records and documents); when false, it uses none of them. """ dataSourcesEnabled: Boolean! """When true (and dataSourcesEnabled), the AI can search the web.""" webSearchEnabled: Boolean! """ When true (and dataSourcesEnabled), the AI receives the field values of the record. """ recordDataEnabled: Boolean! """ When true (and dataSourcesEnabled), the AI receives the related records listed in relatedRecords. """ relatedRecordsEnabled: Boolean! """Kinds of related records the AI receives, one item per kind.""" relatedRecords: [FieldAiOptionsRelatedRecord!]! """ When true (and dataSourcesEnabled), the AI receives the documents attached to the record. """ recordDocumentsEnabled: Boolean! """ Condition selecting which attached documents the AI receives; all when not set. """ recordDocumentsFilter: FieldFilter } """ Kind of related records the AI receives when it generates the value of an AI Smart Field. """ type FieldAiOptionsRelatedRecord { """ Entity of the related records; CustomEntity for a custom entity (see targetEntityApiName). """ targetEntity: EntityNameEnum! """ API name of the custom entity when targetEntity is CustomEntity; null otherwise. """ targetEntityApiName: String """ Id of the relation that links the record to these related records: a system entity relation or a lookup field. """ entityRelationId: ID """ Condition selecting which related records the AI receives; all when not set. """ filter: FieldFilter } """When the value of an AI Smart Field is generated or updated.""" type FieldAiValueUpdateOptions { """When true, users can request a new AI value for a record manually.""" manualEnabled: Boolean! """When true, the AI value is generated when a record is created.""" autoUpdateOnRecordCreate: Boolean! """ When true, the AI value is generated again whenever a record is updated. """ autoUpdateOnRecordUpdate: Boolean! """ When true, the AI values are generated again on the schedule in autoUpdateSchedule. """ autoUpdateScheduled: Boolean! """ Schedule of the periodic update; used when autoUpdateScheduled is true. """ autoUpdateSchedule: FieldAiValueUpdateSchedule """ Condition limiting which records the scheduled update processes; all records of the entity when not set. Each generated value consumes AI credits. """ autoUpdateScheduledFilter: FieldFilter } """Schedule of the periodic update of AI Smart Field values.""" type FieldAiValueUpdateSchedule implements ScheduleInterface { """ Date and time the schedule runs once. Set for a one-time schedule; left empty for recurring schedules that use the time-of-day and day fields instead. """ date: DateTime """ Time of day a recurring schedule runs, in minutes after midnight (0 to 1439). """ timeOfDay: Int """Weekdays a weekly schedule runs on, from 1 (Monday) to 7 (Sunday).""" dayOfWeek: [Int!] """Days of the month a monthly schedule runs on, from 1 to 31.""" dayOfMonth: [Int!] } """ Access a user role has to a custom field: full access, read-only or hidden. """ type FieldPermissionEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Custom field this permission applies to.""" field: FieldEntity """User role granted (or restricted) on the field.""" masterRight: MasterRightEntity """Id of the custom field.""" fieldId: ID! """Id of the user role.""" masterRightId: ID! """ Access the user role gets to the custom field: full access (view and edit), read-only, or hidden. """ permissionLevel: AccessLevelFieldEnum """ True when the permission override is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ User role in the space that defines which features, records and pipelines its users can access. """ type MasterRightEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. """ accessAccountRelationTypes: Boolean """ Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. """ accessAccounts: Boolean """ Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. """ accessAiAutomatizer: Boolean """ Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. """ accessAiOnlineForms: Boolean """ Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. """ accessAiRecordDetail: Boolean """ Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. """ accessAiRecordEnrichment: Boolean """ Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. """ accessAiRelationshipCharts: Boolean """ Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. """ accessAiReports: Boolean """ Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. """ accessAiSmartField: Boolean """ Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. """ accessAppointmentScheduler: Boolean """ Allows users with this role to manage appointment schedules of other users. """ accessAppointmentSchedulerManagement: Boolean """ Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. """ accessApprovalProcesses: Boolean """ Allows users with this role to manage approval processes owned by other users. """ accessApprovalProcessesManagement: Boolean """ Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. """ accessApprovals: Boolean """ Allows users with this role to open the Archive screens listing lost, closed and archived records. """ accessArchive: Boolean """Allows users with this role to open the Audit screen.""" accessAudit: Boolean """ Allows users with this role to view the audit log of changes made in the space. """ accessAuditLog: Boolean """ Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. """ accessBottomMenuCustomization: Boolean """ Allows users with this role to update many records at once with bulk update. """ accessBulkUpdate: Boolean """ Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. """ accessCalling: Boolean """ Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessCallingCompanyPhone: AccessLevelCompanyEmailsEnum """ Allows users with this role to purchase and manage company phone numbers for the calling integration. """ accessCallingPurchasePhone: Boolean """ Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). """ accessCompanyEmails: AccessLevelCompanyEmailsEnum """ Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. """ accessContacts: Boolean """ Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. """ accessDocumentManagement: Boolean """ Allows users with this role to manage company documents and folders that are not tied to a record. """ accessDocumentManagementCompany: Boolean """ Allows users with this role to create and edit the document folders used for records. """ accessDocumentManagementRecord: Boolean """ Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. """ accessDuplicateChecker: Boolean """ When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. """ accessEmailNotificationEnforcement: Boolean """ Default email notification preferences applied to users with this role (which events trigger an email and through which channel). """ accessEmailNotificationSettings: NotificationSettings """ Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. """ accessEntityAccount: AccessLevelEntityEnum """Allows users with this role to create copies of existing accounts.""" accessEntityAccountCopy: Boolean """Allows users with this role to delete accounts they can edit.""" accessEntityAccountDelete: Boolean """ Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAccountDirection: AccessDirectionEnum """ Allows users with this role to own private accounts, which are visible only to their owner. """ accessEntityAccountPrivate: Boolean """Allows users with this role to create new tags for accounts.""" accessEntityAccountTagCreate: Boolean """ Whether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected). """ accessEntityAccountTypes: AccessEntityTypesEnum """ Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. """ accessEntityAppointment: AccessLevelEntityEnum """Allows users with this role to delete appointments they can edit.""" accessEntityAppointmentDelete: Boolean """ Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAppointmentDirection: AccessDirectionEnum """Allows users with this role to create new tags for appointments.""" accessEntityAppointmentTagCreate: Boolean """ Whether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected). """ accessEntityAppointmentTypes: AccessEntityTypesEnum """ Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityBetterNavigator: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to delete Navigator screen layouts owned by other users. """ accessEntityBetterNavigatorDeleteNotOwned: Boolean """ Allows users with this role to delete Navigator screen layouts they own. """ accessEntityBetterNavigatorDeleteOwned: Boolean """ Allows users with this role to share their Navigator screen layouts with selected users and sales units. """ accessEntityBetterNavigatorSharingCustom: Boolean """ Allows users with this role to share their Navigator screen layouts with all users of the space. """ accessEntityBetterNavigatorSharingPublic: Boolean """ Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. """ accessEntityContact: AccessLevelEntityEnum """Allows users with this role to create copies of existing contacts.""" accessEntityContactCopy: Boolean """Allows users with this role to delete contacts they can edit.""" accessEntityContactDelete: Boolean """ Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityContactDirection: AccessDirectionEnum """ Allows users with this role to own private contacts, which are visible only to their owner. """ accessEntityContactPrivate: Boolean """Allows users with this role to create new tags for contacts.""" accessEntityContactTagCreate: Boolean """ Whether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected). """ accessEntityContactTypes: AccessEntityTypesEnum """ Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. """ accessEntityDashboard: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete dashboards owned by other users.""" accessEntityDashboardDeleteNotOwned: Boolean """Allows users with this role to delete dashboards they own.""" accessEntityDashboardDeleteOwned: Boolean """ Allows users with this role to share their dashboards with selected users and sales units. """ accessEntityDashboardSharingCustom: Boolean """ Allows users with this role to share their dashboards with all users of the space. """ accessEntityDashboardSharingPublic: Boolean """ Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). The Inbox is not affected. """ accessEntityEmailAccessLevel: EmailAccessLevelEnum """ Allow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default. """ accessEntityEmailAllowed: EmailAccessAllowList """ How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). """ accessEntityEmailContentShareMode: ContentShareModeConfigEnum """ Allows users with this role to delete emails they neither own nor sent. """ accessEntityEmailDeleteNotOwned: Boolean """ Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccounts: TernaryConfigEnum """ Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccountsByDomain: TernaryConfigEnum """ Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToContacts: TernaryConfigEnum """ Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityEmailSequence: AccessLevelEmailSequenceEnum """ Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityEmailTemplate: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to create and delete email template folders. """ accessEntityEmailTemplateCreateDeleteFolder: Boolean """ Allows users with this role to delete email templates owned by other users. """ accessEntityEmailTemplateDeleteNotOwned: Boolean """Allows users with this role to delete email templates they own.""" accessEntityEmailTemplateDeleteOwned: Boolean """ Allows users with this role to share their email templates with selected users and sales units. """ accessEntityEmailTemplateSharingCustom: Boolean """ Allows users with this role to share their email templates with all users of the space. """ accessEntityEmailTemplateSharingPublic: Boolean """ Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityForecast: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete forecasts owned by other users.""" accessEntityForecastDeleteNotOwned: Boolean """Allows users with this role to delete forecasts they own.""" accessEntityForecastDeleteOwned: Boolean """Allows users with this role to edit forecasts owned by other users.""" accessEntityForecastEditNotOwned: Boolean """ Allows users with this role to share their forecasts with selected users and sales units. """ accessEntityForecastSharingCustom: Boolean """ Allows users with this role to share their forecasts with all users of the space. """ accessEntityForecastSharingPublic: Boolean """ Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityFormView: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete form views owned by other users.""" accessEntityFormViewDeleteNotOwned: Boolean """Allows users with this role to delete form views they own.""" accessEntityFormViewDeleteOwned: Boolean """ Allows users with this role to share their form views with selected users and sales units. """ accessEntityFormViewSharingCustom: Boolean """ Allows users with this role to share their form views with all users of the space. """ accessEntityFormViewSharingPublic: Boolean """ Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. """ accessEntityLead: AccessLevelEntityEnum """Allows users with this role to create copies of existing leads.""" accessEntityLeadCopy: Boolean """Allows users with this role to delete leads they can edit.""" accessEntityLeadDelete: Boolean """ Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityLeadDirection: AccessDirectionEnum """ Allows users with this role to own private leads, which are visible only to their owner. """ accessEntityLeadPrivate: Boolean """Allows users with this role to create new tags for leads.""" accessEntityLeadTagCreate: Boolean """ Whether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected). """ accessEntityLeadTypes: AccessEntityTypesEnum """ Allows users with this role to create new tags for emails, memos and text messages. """ accessEntityMessageTagCreate: Boolean """ Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. """ accessEntityOppty: AccessLevelEntityEnum """ Allows users with this role to create copies of existing opportunities. """ accessEntityOpptyCopy: Boolean """Allows users with this role to delete opportunities they can edit.""" accessEntityOpptyDelete: Boolean """ Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityOpptyDirection: AccessDirectionEnum """ Allows users with this role to own private opportunities, which are visible only to their owner. """ accessEntityOpptyPrivate: Boolean """Allows users with this role to create new tags for opportunities.""" accessEntityOpptyTagCreate: Boolean """ Which pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). """ accessEntityPipeline: AccessLevelPipelineEnum """ Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityProcess: AccessLevelProcessBuilderEnum """ Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. """ accessEntityProfile: AccessLevelCommonRecordsEnumEnum """ Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.). """ accessEntityProfileDefaultScreenProfiles: ScreensDefaultProfilesParams """ Allows users with this role to delete screen profiles owned by other users. """ accessEntityProfileDeleteNotOwned: Boolean """Allows users with this role to delete screen profiles they own.""" accessEntityProfileDeleteOwned: Boolean """ Allows users with this role to share their screen profiles with selected users and sales units. """ accessEntityProfileSharingCustom: Boolean """ Allows users with this role to share their screen profiles with all users of the space. """ accessEntityProfileSharingPublic: Boolean """ Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. """ accessEntityProject: AccessLevelEntityEnum """Allows users with this role to create copies of existing projects.""" accessEntityProjectCopy: Boolean """Allows users with this role to delete projects they can edit.""" accessEntityProjectDelete: Boolean """ Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityProjectDirection: AccessDirectionEnum """ Allows users with this role to own private projects, which are visible only to their owner. """ accessEntityProjectPrivate: Boolean """Allows users with this role to create new tags for projects.""" accessEntityProjectTagCreate: Boolean """ Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. """ accessEntityQuote: AccessLevelEntityEnum """Allows users with this role to create copies of existing quotes.""" accessEntityQuoteCopy: Boolean """Allows users with this role to delete quotes they can edit.""" accessEntityQuoteDelete: Boolean """ Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityQuoteDirection: AccessDirectionEnum """Allows users with this role to create new tags for quotes.""" accessEntityQuoteTagCreate: Boolean """ Whether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected). """ accessEntityQuoteTypes: AccessEntityTypesEnum """ Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityReport: AccessLevelCommonRecordsEnumEnum """Allows users with this role to create and delete report folders.""" accessEntityReportCreateDeleteFolder: Boolean """Allows users with this role to delete reports owned by other users.""" accessEntityReportDeleteNotOwned: Boolean """Allows users with this role to delete reports they own.""" accessEntityReportDeleteOwned: Boolean """ Allows users with this role to save reports as private, visible only to themselves. """ accessEntityReportPrivate: Boolean """Allows users with this role to schedule reports for regular delivery.""" accessEntityReportScheduleCreate: Boolean """ Allows users with this role to view and manage report schedules of other users. """ accessEntityReportScheduleManagement: Boolean """ Allows users with this role to share their reports with selected users and sales units. """ accessEntityReportSharingCustom: Boolean """ Allows users with this role to share their reports with all users of the space. """ accessEntityReportSharingPublic: Boolean """ Allows users with this role to view and follow solutions, when the feature is enabled for the space. """ accessEntitySolution: Boolean """Allows users with this role to create, edit and delete solutions.""" accessEntitySolutionManagement: Boolean """ Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityTarget: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete targets owned by other users.""" accessEntityTargetDeleteNotOwned: Boolean """Allows users with this role to delete targets they own.""" accessEntityTargetDeleteOwned: Boolean """ Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. """ accessEntityTask: AccessLevelEntityEnum """Allows users with this role to delete tasks they can edit.""" accessEntityTaskDelete: Boolean """ Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityTaskDirection: AccessDirectionEnum """Allows users with this role to create new tags for tasks.""" accessEntityTaskTagCreate: Boolean """ Whether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected). """ accessEntityTaskTypes: AccessEntityTypesEnum """ Allows users with this role to create tasks without an owner (unassigned tasks). """ accessEntityTaskUnassigned: Boolean """Allows users with this role to export records and reports to files.""" accessExport: Boolean """ Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. """ accessFeeds: Boolean """ Allows users with this role to manage currencies and exchange rate lists in Administration. """ accessForeignCurrencies: Boolean """ Allows users with this role to manage fields, forms, record types, tags and translations in Administration. """ accessFormAndFields: Boolean """ Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. """ accessGlobalSettings: Boolean """Allows users with this role to open the Navigator screen.""" accessHomeScreen: Boolean """Allows users with this role to import records from files.""" accessImport: Boolean """ Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. """ accessInsights: Boolean """ Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. """ accessLeads: Boolean """ Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. """ accessOnlineForms: Boolean """ Allows users with this role to edit and delete online forms owned by other users. """ accessOnlineFormsManagement: Boolean """ Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. """ accessOpportunity: Boolean """ Allows users with this role to manage pipelines, lead processes and quote processes in Administration. """ accessPipelineConfiguration: Boolean """Allows users with this role to print records and reports.""" accessPrint: Boolean """ Allows users with this role to manage products, product categories and price lists in Administration. """ accessProductsServices: Boolean """ Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. """ accessProjects: Boolean """ Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. """ accessQuotes: Boolean """Allows users with this role to manage sales roles in Administration.""" accessSalesRoles: Boolean """ Allows users with this role to manage the security settings of the space in Administration. """ accessSecurity: Boolean """Allows users with this role to manage sales units in Administration.""" accessUnits: Boolean """ Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. """ accessUserAndRoles: Boolean """ Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessWhatsAppCompanyPhone: AccessLevelCompanyEmailsEnum """ The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items. Stored as the client sent it; until it is saved once the default list is returned, everything enabled and pinned. The access_* flags of the role are not touched by it: the client sends both. """ bottomMenuLayout: [InterfaceBottomMenuRow!] """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """ Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted. """ allowedPipelines( """Filter Pipeline relations by target Pipeline attributes.""" filter: PipelineFilterInput """ Filter AllowedPipeline relations by edge (relation) AllowedPipeline attributes. """ filterEdge: AllowedPipelineFilterInput """Order Pipeline relations by target Pipeline attributes.""" orderBy: [PipelineOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedPipelineEntityConnection """ Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected. """ allowedLeadTypes( """Filter LeadType relations by target LeadType attributes.""" filter: LeadTypeFilterInput """ Filter AllowedLeadType relations by edge (relation) AllowedLeadType attributes. """ filterEdge: AllowedLeadTypeFilterInput """Order LeadType relations by target LeadType attributes.""" orderBy: [LeadTypeOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedLeadTypeEntityConnection """ Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected. """ allowedQuoteTypes( """Filter QuoteType relations by target QuoteType attributes.""" filter: QuoteTypeFilterInput """ Filter AllowedQuoteType relations by edge (relation) AllowedQuoteType attributes. """ filterEdge: AllowedQuoteTypeFilterInput """Order QuoteType relations by target QuoteType attributes.""" orderBy: [QuoteTypeOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedQuoteTypeEntityConnection """ Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected. """ allowedAccountTypes( """Filter AccountType relations by target AccountType attributes.""" filter: AccountTypeFilterInput """ Filter AllowedAccountType relations by edge (relation) AllowedAccountType attributes. """ filterEdge: AllowedAccountTypeFilterInput """Order AccountType relations by target AccountType attributes.""" orderBy: [AccountTypeOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedAccountTypeEntityConnection """ Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected. """ allowedContactTypes( """Filter ContactType relations by target ContactType attributes.""" filter: ContactTypeFilterInput """ Filter AllowedContactType relations by edge (relation) AllowedContactType attributes. """ filterEdge: AllowedContactTypeFilterInput """Order ContactType relations by target ContactType attributes.""" orderBy: [ContactTypeOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedContactTypeEntityConnection """ Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected. """ allowedTaskTypes( """Filter TaskType relations by target TaskType attributes.""" filter: TaskTypeFilterInput """ Filter AllowedTaskType relations by edge (relation) AllowedTaskType attributes. """ filterEdge: AllowedTaskTypeFilterInput """Order TaskType relations by target TaskType attributes.""" orderBy: [TaskTypeOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedTaskTypeEntityConnection """ Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. """ allowedAppointmentTypes( """Filter AppointmentType relations by target AppointmentType attributes.""" filter: AppointmentTypeFilterInput """ Filter AllowedAppointmentType relations by edge (relation) AllowedAppointmentType attributes. """ filterEdge: AllowedAppointmentTypeFilterInput """Order AppointmentType relations by target AppointmentType attributes.""" orderBy: [AppointmentTypeOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedAppointmentTypeEntityConnection """ Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected. """ allowedCompanyEmails( """Filter CompanyEmail relations by target CompanyEmail attributes.""" filter: CompanyEmailFilterInput """ Filter AllowedCompanyEmail relations by edge (relation) AllowedCompanyEmail attributes. """ filterEdge: AllowedCompanyEmailFilterInput """Order CompanyEmail relations by target CompanyEmail attributes.""" orderBy: [CompanyEmailOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedCompanyEmailEntityConnection """ Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected. """ allowedCompanyPhones( """Filter Phone relations by target Phone attributes.""" filter: PhoneFilterInput """ Filter AllowedCompanyPhone relations by edge (relation) AllowedCompanyPhone attributes. """ filterEdge: AllowedCompanyPhoneFilterInput """Order Phone relations by target Phone attributes.""" orderBy: [PhoneOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedCompanyPhoneEntityConnection """ Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space. """ customEntities: [CustomEntityMasterRight!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Which events a user is notified about, grouped by area such as emails, activities or automations. """ type NotificationSettings { """Notification options for emails.""" Emails: EmailNotificationSettings! """Notification options for accounts and contacts.""" AccountsAndContacts: AccountsAndContactsNotificationSettings! """Notification options for leads and opportunities.""" LeadsAndOpportunities: LeadsAndOpportunitiesNotificationSettings! """Notification options for feed posts.""" Feeds: FeedsNotificationSettings! """Notification options for tasks and appointments.""" Activities: ActivitiesNotificationSettings! """Notification options for WhatsApp messages.""" WhatsApp: TextMessageNotificationSettings """Notification options for calling and text messaging.""" CallingAndMessaging: TextMessageNotificationSettings """Notification options for automations.""" ProcessBuilder: ProcessBuilderNotificationSettings """Notification options for projects.""" Projects: ProjectsNotificationSettings """Notification options for quotes.""" Quotes: QuotesNotificationSettings """Notification options for email sequences.""" EmailSequences: EmailSequencesNotificationSettings """Notification options for approval processes.""" ApprovalProcesses: ApprovalProcessesNotificationSettings """Notification options for online forms.""" OnlineForms: OnlineFormsNotificationSettings """ Notification options per custom entity type. Custom entity types not listed notify about all their events. """ CustomEntities: [CustomEntitiesNotificationSetting!]! """ True when an administrator enforces these options for the user, so the user's own choices do not apply. Computed by the server; ignored on input. """ isSettingsEnforced: Boolean! } """ Which notifications a user receives about emails: sent and received emails, opens and bounces. """ type EmailNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about emails sent and received.""" LinkedItem: Boolean """Notifies when a sent email is opened.""" Tracking: Boolean """Notifies when a sent email bounces.""" Bounced: Boolean } """Which notifications a user receives about accounts and contacts.""" type AccountsAndContactsNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about owner changes of accounts and contacts and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when an item is linked to an account or contact.""" LinkedItem: Boolean! } """Which notifications a user receives about leads and opportunities.""" type LeadsAndOpportunitiesNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies when an item is linked to a lead or opportunity.""" LinkedItem: Boolean! """ Notifies when a lead or opportunity moves to another step or an opportunity is turned back into a lead. """ Move: Boolean! """ Notifies about owner changes of leads and opportunities and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when a lead is qualified to an opportunity.""" Qualification: Boolean! """Notifies when a lead or opportunity is won, lost or reactivated.""" StatusChange: Boolean! } """ Which notifications a user receives about feed posts and their comments. """ type FeedsNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about new feed posts.""" Create: Boolean! """Notifies about comments on feed posts.""" Comment: Boolean! } """Which notifications a user receives about tasks and appointments.""" type ActivitiesNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about owner changes of tasks and appointments and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """ Notifies when the status of a task or appointment changes or it is canceled. """ StatusChange: Boolean! """Notifies about appointment invitations received, accepted or rejected.""" Invitation: Boolean! """Notifies about comments on tasks and appointments.""" Comment: Boolean! } """ Which notifications a user receives about new text or WhatsApp messages. """ type TextMessageNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about new messages.""" LinkedItem: Boolean } """ Which notifications a user receives about warnings and errors of automations. """ type ProcessBuilderNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about warnings raised while the automation or sequence runs.""" Warnings: Boolean! """Notifies about errors raised while the automation or sequence runs.""" Errors: Boolean! } """Which notifications a user receives about projects.""" type ProjectsNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about owner changes of projects and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when the status of a project changes.""" StatusChange: Boolean! """Notifies when an item is linked to a project.""" LinkedItem: Boolean! } """Which notifications a user receives about quotes.""" type QuotesNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies when an item is linked to a quote.""" LinkedItem: Boolean! """Notifies when a quote moves to another step.""" Move: Boolean! """ Notifies about owner changes of quotes and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when a quote is won, lost or reactivated.""" StatusChange: Boolean! } """ Which notifications a user receives about warnings and errors of email sequences. """ type EmailSequencesNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about warnings raised while the automation or sequence runs.""" Warnings: Boolean! """Notifies about errors raised while the automation or sequence runs.""" Errors: Boolean! } """ Which notifications a user receives about approval requests, their responses, and approval process warnings and errors. """ type ApprovalProcessesNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about approval requests, including delegated requests and requests that found no approver. """ ApprovalRequest: Boolean! """Notifies when an approval request is approved or rejected.""" ApprovalResponse: Boolean! """Notifies about warnings raised while an approval process runs.""" ApprovalProcessWarning: Boolean """Notifies about errors raised while an approval process runs.""" ApprovalProcessError: Boolean } """ Which notifications a user receives about online form responses and the warnings and errors raised while they are processed. """ type OnlineFormsNotificationSettings { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about responses submitted through online forms.""" Responses: Boolean! """ Notifies about warnings raised while an online form response is processed. """ Warnings: Boolean! """ Notifies about errors raised while an online form response is processed. """ Errors: Boolean! } """ Which notifications a user receives about the records of one custom entity type. """ type CustomEntitiesNotificationSetting { """API name of the custom entity type these options apply to.""" entityApiName: String! """ Turns all notifications of this custom entity type on or off; when false, the other options are ignored. """ IsActive: Boolean! """ Notifies about owner changes of records of this type and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when an item is linked to a record of this type.""" LinkedItem: Boolean! } """ Users and sales units whose emails stay visible to users with the role. """ type EmailAccessAllowList { """Ids of users whose emails stay visible.""" clientIds: [UUID!]! """Ids of sales units whose Member users' emails stay visible.""" unitIds: [UUID!]! } """ Default profiles (saved views) of the main screens for users with a given role. """ type ScreensDefaultProfilesParams { """ Id of the default profile (saved view) of the original Navigator screen for users with this role. """ Navigator: UUID! """ Id of the default profile (saved view) of the Opportunities screen for users with this role. """ Pipelinescreen: UUID! """ Id of the default profile (saved view) of the Leads screen for users with this role. """ Leadscreen: UUID! """ Id of the default profile (saved view) of the Accounts screen for users with this role. """ Accountscreen: UUID! """ Id of the default profile (saved view) of the Contacts screen for users with this role. """ Contactscreen: UUID! """ Id of the default profile (saved view) of the Activities screen for users with this role. """ Activityscreen: UUID! """ Id of the default profile (saved view) of the Feed screen for users with this role. """ Feedscreen2: UUID! """ Id of the default profile (saved view) of the opportunity archive for users with this role. """ Archivescreen: UUID! """ Id of the default profile (saved view) of the lead archive for users with this role. """ LeadArchivescreen: UUID! """ Id of the default profile (saved view) of the Insights overview screen for users with this role. """ Insightsscreen: UUID! """ Id of the default profile (saved view) of the Insights indicators screen for users with this role. """ Indicatorsscreen: UUID! """ Id of the default profile (saved view) of the Insights conversions screen for users with this role. """ Conversionsscreen: UUID! """ Id of the default profile (saved view) of the Insights lifecycle screen for users with this role. """ Lifecyclescreen: UUID! """ Id of the default profile (saved view) of the Projects screen for users with this role. """ Projectscreen: UUID! """ Id of the default profile (saved view) of the Quotes screen for users with this role. """ Quotescreen: UUID! """ Id of the default profile (saved view) of the quote archive for users with this role. """ QuoteArchivescreen: UUID! """ Id of the default profile (saved view) of the Navigator screen for users with this role. """ BetterNavigatorscreen: UUID! } """ A row of the bottom menu (Navigation list): an item that opens a screen, or a group row whose items open as a submenu. """ type InterfaceBottomMenuRow { """The screen of an item row; Section on a group row.""" kind: InterfaceBottomMenuItemKind! """Set on CustomEntity rows.""" entityApiName: String """Default Access of the item in the role; stored as the client sent it.""" isEnabled: Boolean """ Pinned to the bar. On the role's items it equals isEnabled after every role save; on a user's own layout it is what the user chose. """ isPinned: Boolean """ A group's name as the admin typed it, or a translation key (see useLang). """ name: String """ True when name is a translation key the client localizes, as on the default groups Communication, Analytics, Archive and Tools; false when shown as typed. """ useLang: Boolean """A group's icon.""" icon: EntityIconEnum """Members of a group row, in submenu order; null on items.""" items: [InterfaceBottomMenuRow!] } """ What a row of the bottom menu is: a group row (Section) or the screen an item row opens. """ enum InterfaceBottomMenuItemKind { """Group row whose items open as a submenu.""" Section """Accounts list.""" Accounts """Activities list.""" Activities """Appointment scheduler screen.""" AppointmentScheduler """Approval process settings.""" ApprovalProcesses """Approval requests waiting for the user.""" Approvals """Archived accounts.""" ArchiveAccounts """Archived contacts.""" ArchiveContacts """Archived leads.""" ArchiveLeads """Archived opportunities.""" ArchiveOpportunities """Archived quotes.""" ArchiveQuotes """Automatizer processes that automate actions on records.""" Automatizer """Calling screen.""" Calling """Contacts list.""" Contacts """List of the custom entity named by entityApiName.""" CustomEntity """Documents stored in the space.""" DocumentManagement """Templates for generating documents from records.""" DocumentTemplates """Duplicate checker that finds duplicate records.""" DuplicateChecker """Email sequences screen.""" EmailSequences """Templates for composing emails.""" EmailTemplates """Feeds screen.""" Feeds """Forecasts screen.""" Forecasts """The user's email inbox.""" Inbox """Insights screen with sales KPIs.""" Insights """Leads list.""" Leads """Navigator screen.""" Navigator """Online forms screen.""" OnlineForms """Opportunities list.""" Opportunities """Projects list.""" Projects """Quotes list.""" Quotes """Reports screen.""" Reports """Solutions screen.""" Solutions """Targets screen.""" Targets } """Icon used to display a custom entity and its records.""" enum EntityIconEnum { """Generic icon not tied to a specific kind of record.""" GeneralIcon """Icon depicting a task.""" Task """Icon depicting an appointment.""" Appointment """Icon depicting a phone call.""" Call """Icon depicting an email.""" Mail """Icon depicting a message.""" Message """Icon depicting a ticketing system integration.""" TicketingIntegration """Icon depicting document management.""" DocumentManagement """Icon depicting event management.""" EventManagement """Icon depicting an accounting system.""" AccountingSystem """Icon depicting a marketing communication system.""" MarketingCommunicationSystems """Icon depicting order processing.""" OrderProcessing """Icon depicting web services.""" WebServices """Icon depicting a return merchandise authorization (RMA) system.""" ReturnMerchandiseAuthorizationSystems """Icon depicting sales automation.""" SalesAutomatization """Icon depicting SMS messaging.""" SmsMessaging """Icon depicting an ERP system.""" ErpSystems """Icon depicting data analytics.""" DataAnalytics """Icon depicting a warehouse.""" Warehouses """Icon depicting contact management.""" ContactManagement """Icon depicting a content management system.""" ContentManagementSystems """Icon depicting an inventory system.""" InventorySystems """Icon depicting a workflow.""" Workflow """Icon depicting an asset management system.""" AssetManagementSystem } """Paginated list of AllowedPipeline records.""" type AllowedPipelineEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedPipelineEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedPipelineEntity` and its cursor.""" type AllowedPipelineEntityEdge { """The item at the end of the edge""" node: AllowedPipelineEntity """A cursor for use in pagination""" cursor: String! } """ Pipeline that a user role is allowed to use, optionally with access to the documents of its steps. """ type AllowedPipelineEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User role granted access to the pipeline.""" masterRight: MasterRightEntity """Pipeline the user role can use.""" pipeline: PipelineEntity """ When true, the user role can access documents attached to steps of this pipeline. """ accessStepDocuments: Boolean """Id of the user role.""" masterRightId: ID! """Id of the pipeline the user role can use.""" pipelineId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of AllowedLeadType records.""" type AllowedLeadTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedLeadTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedLeadTypeEntity` and its cursor.""" type AllowedLeadTypeEntityEdge { """The item at the end of the edge""" node: AllowedLeadTypeEntity """A cursor for use in pagination""" cursor: String! } """Lead type that a user role is allowed to use.""" type AllowedLeadTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Lead type the user role can use.""" leadType: LeadTypeEntity """User role granted access to the lead type.""" masterRight: MasterRightEntity """Id of the lead type the user role can use.""" leadTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of LeadType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead process (pipeline) this lead type follows. Sorts by fields of the related record, listed in order of priority. """ leadProcess: [LeadProcessOrderByNestedInput!] """True when the lost form is required on archiving leads of this type.""" formLostEnabled: OrderByEnum """ True when the lead type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Id of the lead process that leads of this type follow.""" leadProcessId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related LeadProcess record. Set exactly one field in each item. """ input LeadProcessOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AllowedQuoteType records.""" type AllowedQuoteTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedQuoteTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedQuoteTypeEntity` and its cursor.""" type AllowedQuoteTypeEntityEdge { """The item at the end of the edge""" node: AllowedQuoteTypeEntity """A cursor for use in pagination""" cursor: String! } """Quote type that a user role is allowed to use.""" type AllowedQuoteTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User role granted access to the quote type.""" masterRight: MasterRightEntity """Quote type the user role can use.""" quoteType: QuoteTypeEntity """Id of the user role.""" masterRightId: ID! """Id of the quote type the user role can use.""" quoteTypeId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of QuoteType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Quote process (pipeline) this quote type follows. Sorts by fields of the related record, listed in order of priority. """ quoteProcess: [QuoteProcessOrderByNestedInput!] """True when the lost form is required on archiving quotes of this type.""" formLostEnabled: OrderByEnum """ True when the quote type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the quote process that quotes of this type follow.""" quoteProcessId: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related QuoteProcess record. Set exactly one field in each item. """ input QuoteProcessOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AllowedAccountType records.""" type AllowedAccountTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedAccountTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedAccountTypeEntity` and its cursor.""" type AllowedAccountTypeEntityEdge { """The item at the end of the edge""" node: AllowedAccountTypeEntity """A cursor for use in pagination""" cursor: String! } """Account type that a user role is allowed to use.""" type AllowedAccountTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account type the user role can use.""" accountType: AccountTypeEntity """User role granted access to the account type.""" masterRight: MasterRightEntity """Id of the account type the user role can use.""" accountTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of AccountType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the account type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AllowedContactType records.""" type AllowedContactTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedContactTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedContactTypeEntity` and its cursor.""" type AllowedContactTypeEntityEdge { """The item at the end of the edge""" node: AllowedContactTypeEntity """A cursor for use in pagination""" cursor: String! } """Contact type that a user role is allowed to use.""" type AllowedContactTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact type the user role can use.""" contactType: ContactTypeEntity """User role granted access to the contact type.""" masterRight: MasterRightEntity """Id of the contact type the user role can use.""" contactTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of ContactType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the contact type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AllowedTaskType records.""" type AllowedTaskTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedTaskTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedTaskTypeEntity` and its cursor.""" type AllowedTaskTypeEntityEdge { """The item at the end of the edge""" node: AllowedTaskTypeEntity """A cursor for use in pagination""" cursor: String! } """Task type that a user role is allowed to use.""" type AllowedTaskTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User role granted access to the task type.""" masterRight: MasterRightEntity """Task type the user role can use.""" taskType: TaskTypeEntity """Id of the user role.""" masterRightId: ID! """Id of the task type the user role can use.""" taskTypeId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of TaskType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TaskTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Icon used to display tasks of this type in the UI.""" icon: OrderByEnum """ True when the task type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AllowedAppointmentType records.""" type AllowedAppointmentTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedAppointmentTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AllowedAppointmentTypeEntity` and its cursor. """ type AllowedAppointmentTypeEntityEdge { """The item at the end of the edge""" node: AllowedAppointmentTypeEntity """A cursor for use in pagination""" cursor: String! } """Appointment type that a user role is allowed to use.""" type AllowedAppointmentTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Appointment type the user role can use.""" appointmentType: AppointmentTypeEntity """User role granted access to the appointment type.""" masterRight: MasterRightEntity """Id of the appointment type the user role can use.""" appointmentTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of AppointmentType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AppointmentTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Icon used to display appointments of this type in the UI.""" icon: OrderByEnum """ True when the appointment type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AllowedCompanyEmail records.""" type AllowedCompanyEmailEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedCompanyEmailEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedCompanyEmailEntity` and its cursor.""" type AllowedCompanyEmailEntityEdge { """The item at the end of the edge""" node: AllowedCompanyEmailEntity """A cursor for use in pagination""" cursor: String! } """Company email address that a user role is allowed to send emails from.""" type AllowedCompanyEmailEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Company email address the user role can send from.""" companyEmail: CompanyEmailEntity """User role granted access to the company email address.""" masterRight: MasterRightEntity """Id of the company email address.""" companyEmailId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of CompanyEmail records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CompanyEmailOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Email address of the company mailbox (the From address).""" email: OrderByEnum """ False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise. """ enabled: OrderByEnum """ Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration. """ errorCode: OrderByEnum """Display name of the company email account, shown in the UI.""" name: OrderByEnum """ URL of the avatar image used as the sender picture for emails sent from this account. """ pictureUrl: OrderByEnum """ Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid. """ serviceType: OrderByEnum } """Paginated list of AllowedCompanyPhone records.""" type AllowedCompanyPhoneEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AllowedCompanyPhoneEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AllowedCompanyPhoneEntity` and its cursor.""" type AllowedCompanyPhoneEntityEdge { """The item at the end of the edge""" node: AllowedCompanyPhoneEntity """A cursor for use in pagination""" cursor: String! } """ Company phone number that a user role is allowed to use for calls and text messages. """ type AllowedCompanyPhoneEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User role granted access to the company phone.""" masterRight: MasterRightEntity """Company phone the user role can use for calling/SMS.""" phone: PhoneEntity """Id of the user role.""" masterRightId: ID! """Id of the company phone.""" phoneId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Phone number connected to Coevera for calls, text messages or WhatsApp, either personal to a user or shared by the company. """ type PhoneEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ User the phone is assigned to, when the phone belongs to a specific user (personal calling/SMS line). """ owner: ClientEntity """ Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy. """ errorCode: Int """Name of the entity and its default text representation.""" name: String! """ Id of the assigned user, or empty when the phone is a company-level resource. """ ownerId: ID """Phone number in E.164 format (e.g. "+12025550123").""" phoneNumber: String """ External caller identifier from the calling provider (e.g. Twilio caller SID). """ twilioCallerSid: String """ Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. """ type: PhoneTypeEnum! """Revision when entity was lastly changed.""" revision: Int """ Email address that incoming text messages to this phone are forwarded to. Empty when forwarding is not configured. """ messageForwardingEmail: String """ Phone number that incoming calls/SMS to this phone are forwarded to. Empty when forwarding is not configured. """ callForwardingPhone: String """ False when the user has disabled the calling/SMS integration on this phone (errorCode is set to indicate user disablement); true otherwise. """ enabled: Boolean! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of Phone records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input PhoneOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the phone is assigned to, when the phone belongs to a specific user (personal calling/SMS line). Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy. """ errorCode: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the assigned user, or empty when the phone is a company-level resource. """ ownerId: OrderByEnum """Phone number in E.164 format (e.g. "+12025550123").""" phoneNumber: OrderByEnum """ External caller identifier from the calling provider (e.g. Twilio caller SID). """ twilioCallerSid: OrderByEnum """ Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ False when the user has disabled the calling/SMS integration on this phone (errorCode is set to indicate user disablement); true otherwise. """ enabled: OrderByEnum } """ Rights of a user role to one custom entity: screen access, record access level and the actions its users may take. """ type CustomEntityMasterRight { """API name of the custom entity these settings apply to.""" entityApiName: String! """ Shows the screen of the custom entity to users with this role. Which records they can see and edit is set by accessLevel. """ navigationAccess: Boolean! """ Level of access to records of the custom entity for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the records the role can see. """ accessLevel: AccessLevelEntityEnum! """ Which records of the custom entity users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessDirection: AccessDirectionEnum! """ Allows users with this role to own private records of the custom entity, which are visible only to their owner. """ accessPrivate: Boolean! """ Allows users with this role to delete records of the custom entity they can edit. """ accessDelete: Boolean! """ Whether users with this role can work with all types of the custom entity (All) or only with those in allowedEntityTypeIds (Selected). """ accessEntityTypes: AccessEntityTypesEnum! """ Types of the custom entity this user role can use. Effective only when accessEntityTypes is set to Selected. """ allowedEntityTypeIds: [ID!]! """ Default screen profile (saved screen view) of the custom entity screen for users with this role. """ defaultProfileId: ID! """ Allows users with this role to create copies of existing records of the custom entity. """ accessCopy: Boolean! """ Allows users with this role to create new tags for records of the custom entity. """ accessTagCreate: Boolean! } """Level of access to a single field.""" enum AccessLevelFieldEnum { """The field can be viewed and edited.""" FullAccess """The field can be viewed but not edited.""" Readonly """The field is hidden.""" NoAccess } """ Submission (response) of an online form, with the answers and the records it created or updated. """ type OnlineFormEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Currency exchange rate list applied to product line-items at submission time. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ Email submitted with the response, used for identification or response notifications. """ email: EmailEntity """Online form definition this submission belongs to.""" onlineFormType: OnlineFormTypeEntity """ Currency selected by the respondent for product line-items, when the form contains products. """ productCurrency: CurrencyEntity """ Product price list selected by the respondent, when the form contains products. """ productPriceList: ProductPriceListEntity """ Id of the currency exchange rate list applied to product line items at submission time. """ currencyExchangeRatesListId: ID """Id of the linked email record, when available.""" emailId: ID """ Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). """ fieldIds: JSONString! """Id of the online form definition.""" onlineFormTypeId: ID! """Id of the selected currency.""" productCurrencyId: ID """Id of the selected price list.""" productPriceListId: ID """ Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. """ status: ProcessStatusEnum """Revision when entity was lastly changed.""" revision: Int """Accounts the submission was linked to.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter OnlineFormRelation relations by edge (relation) OnlineFormRelation attributes. """ filterEdge: OnlineFormRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """Contacts the submission was linked to.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter OnlineFormRelation relations by edge (relation) OnlineFormRelation attributes. """ filterEdge: OnlineFormRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """Leads the submission was linked to.""" leadRelations( """Filter Lead relations by target Lead attributes.""" filter: LeadFilterInput """ Filter OnlineFormRelation relations by edge (relation) OnlineFormRelation attributes. """ filterEdge: OnlineFormRelationFilterInput """Order Lead relations by target Lead attributes.""" orderBy: [LeadOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """Opportunities the submission was linked to.""" opportunityRelations( """Filter Opportunity relations by target Opportunity attributes.""" filter: OpportunityFilterInput """ Filter OnlineFormRelation relations by edge (relation) OnlineFormRelation attributes. """ filterEdge: OnlineFormRelationFilterInput """Order Opportunity relations by target Opportunity attributes.""" orderBy: [OpportunityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """Quotes the submission was linked to.""" quoteRelations( """Filter Quote relations by target Quote attributes.""" filter: QuoteFilterInput """ Filter OnlineFormRelation relations by edge (relation) OnlineFormRelation attributes. """ filterEdge: OnlineFormRelationFilterInput """Order Quote relations by target Quote attributes.""" orderBy: [QuoteOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """Projects the submission was linked to.""" projectRelations( """Filter Project relations by target Project attributes.""" filter: ProjectFilterInput """ Filter OnlineFormRelation relations by edge (relation) OnlineFormRelation attributes. """ filterEdge: OnlineFormRelationFilterInput """Order Project relations by target Project attributes.""" orderBy: [ProjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """Custom entity records the submission was linked to.""" customEntityRelations( """Filter CustomEntity relations by target CustomEntity attributes.""" filter: CustomEntityFilterInput """ Filter OnlineFormRelation relations by edge (relation) OnlineFormRelation attributes. """ filterEdge: OnlineFormRelationFilterInput """Order CustomEntity relations by target CustomEntity attributes.""" orderBy: [CustomEntityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """ Activity log lines describing what was done with this submission (visible only). """ lines( """ Filter OnlineFormActivityLogLine relations by target OnlineFormActivityLogLine attributes. """ filter: OnlineFormActivityLogLineFilterInput """ Order OnlineFormActivityLogLine relations by target OnlineFormActivityLogLine attributes. """ orderBy: [OnlineFormActivityLogLineOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormActivityLogLineEntityConnection """ Display name of the primary record (account/contact/lead/...) the submission was linked to. """ respondedBy: String! """Timestamp the submission was received (the response was completed).""" responseDate: DateTime """ Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format. """ recordName: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """Answers given in this submission, one item per form field, formatted.""" answers: [OnlineFormFieldAnswer!]! """Primary record of the submission when it is an account.""" primaryAccount: AccountEntity """Primary record of the submission when it is a contact.""" primaryContact: ContactEntity """Primary record of the submission when it is a lead.""" primaryLead: LeadEntity """Primary record of the submission when it is an opportunity.""" primaryOpportunity: OpportunityEntity """Primary record of the submission when it is a quote.""" primaryQuote: QuoteEntity """Primary record of the submission when it is a custom entity record.""" primaryCustomEntity: CustomEntityEntity """Id of the primary record of the submission when it is an account.""" primaryAccountId: ID """Id of the primary record of the submission when it is a contact.""" primaryContactId: ID """ Id of the primary record of the submission when it is a lead or opportunity. """ primaryLeadOpptyId: ID """Id of the primary record of the submission when it is a quote.""" primaryQuoteId: ID """ Id of the primary record of the submission when it is a custom entity record. """ primaryCustomEntityId: ID } """ Email message sent or received by users of the space, linked to the contacts, accounts and other records it concerns. """ type EmailEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Configured company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmail: CompanyEmailEntity """ The original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmail: EmailEntity """Sales user who owns this email. May be empty for unassigned emails.""" owner: ClientEntity """ For mass emails: the master email this copy was generated from. Empty for the master and for non-mass emails. """ parentEmail: EmailEntity """ Account record matched as the sender, or empty when the sender does not match an existing Account. """ senderAccount: AccountEntity """ Internal user matched as the sender, or empty when the sender is external. """ senderClient: ClientEntity """ Contact record matched as the sender, or empty when the sender does not match an existing Contact. """ senderContact: ContactEntity """ Email template used to compose this email, or empty when none was used. """ template: EmailTemplateEntity """ Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. """ additionalHeaders: JSONString """Comma-separated list of blind-carbon-copy recipients.""" bcc: String """ HTML body of the email, or a localized "Private content" label when the caller cannot read its content. """ body( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID ): String! """ Plain-text summary of the body, or a localized "Private content" label when the caller cannot read the email content. """ bodySummary( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID ): String! """Comma-separated list of carbon-copy recipients.""" cc: String """ Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmailId: ID """ How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). """ contentShareMode: ContentShareModeEnum """MIME content type of the body (e.g. text/html, text/plain).""" contentType: String """ Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. """ dateSent: DateTime """Direction of the email (Incoming, Outgoing).""" direction: EmailDirectionEnum! """ Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmailId: ID """ Saved state of an email draft (recipients, subject, body, attachments, template, sharing) used to reopen it for editing. Empty for emails that are not drafts. """ draftSettings: EmailDraftSettings """ Numeric error code recorded when the email failed to send. Zero when no error occurred. """ errorCode: Int """ True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. """ isDraft: Boolean """ True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. """ isTracked: Boolean """ External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. """ originalId: String """Id of the email owner.""" ownerId: ID """Id of the parent (master) email.""" parentEmailId: ID """ Sending configuration of a scheduled email (sending account, recipients, linked records, follow-up options). Empty when the email is not scheduled. """ scheduleSettings: EmailScheduleSettings """ Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. """ sendAt: DateTime """Sender address as it appeared on the email (free-text "From" header).""" sender: String """Id of the matched sender account.""" senderAccountId: ID """Id of the matched sender user.""" senderClientId: ID """Id of the matched sender contact.""" senderContactId: ID """Id of the personal email-integration account that sent this email.""" senderEmailAccountId: ID """Sentiment of the email. Null without access to the email content.""" sentiment( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID ): EmailSentimentEnum """ Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """ Subject line of the email, or a localized "Private content" label when the caller cannot read its content. """ subject( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID ): String! """ Discriminator identifying the concrete record type — always "email" for Email records. Read-only; useful when consuming polymorphic Message results. """ tableName: String! """Id of the email template.""" templateId: ID """Identifier grouping emails belonging to the same conversation thread.""" threadId: ID """Comma-separated list of primary recipients.""" to: String """ Whether the email is an individual email (Standard) or part of a mass email (Mass). """ type: EmailTypeEnum """IMAP UID of the email on the source mailbox.""" uid: String! """Revision when entity was lastly changed.""" revision: Int """ True when the current authenticated user has marked this email as favorite. Per-user. """ isFavorite: Boolean! """ Sales units that have been granted shared access to this email envelope. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter MessageSharingSalesUnitRelation relations by edge (relation) MessageSharingSalesUnitRelation attributes. """ filterEdge: MessageSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageSharingSalesUnitRelationEntityConnection """Users that have been granted shared access to this email envelope.""" sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter MessageSharingClientRelation relations by edge (relation) MessageSharingClientRelation attributes. """ filterEdge: MessageSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageSharingClientRelationEntityConnection """ Sales units that have been granted access to the email body when contentShareMode is restricted. """ contentSharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter EmailContentSharingSalesUnitRelation relations by edge (relation) EmailContentSharingSalesUnitRelation attributes. """ filterEdge: EmailContentSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailContentSharingSalesUnitRelationEntityConnection """ Users that have been granted access to the email body when contentShareMode is restricted. """ contentSharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter EmailContentSharingClientRelation relations by edge (relation) EmailContentSharingClientRelation attributes. """ filterEdge: EmailContentSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailContentSharingClientRelationEntityConnection """Accounts this email is linked to.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Contacts this email is linked to.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Projects this email is linked to.""" projectRelations( """Filter Project relations by target Project attributes.""" filter: ProjectFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Project relations by target Project attributes.""" orderBy: [ProjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Custom entity records this email is linked to.""" customEntityRelations( """Filter CustomEntity relations by target CustomEntity attributes.""" filter: CustomEntityFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order CustomEntity relations by target CustomEntity attributes.""" orderBy: [CustomEntityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Leads this email is linked to.""" leadRelations( """Filter Lead relations by target Lead attributes.""" filter: LeadFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Lead relations by target Lead attributes.""" orderBy: [LeadOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Opportunities this email is linked to.""" opportunityRelations( """Filter Opportunity relations by target Opportunity attributes.""" filter: OpportunityFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Opportunity relations by target Opportunity attributes.""" orderBy: [OpportunityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Quotes this email is linked to.""" quoteRelations( """Filter Quote relations by target Quote attributes.""" filter: QuoteFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Quote relations by target Quote attributes.""" orderBy: [QuoteOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """ Tag labels applied to this email. Visible only to users that can read the email body. """ tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Attachments and other documents linked to this email.""" documents( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ Ids of the mailboxes (company or personal) the email envelope belongs to, aggregated from the active emailMailboxRelation rows. """ mailboxIds: [UUID!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Tracking statistics (sent, opened, clicked, replied, bounced, unsubscribed) of the individual emails sent from this mass email. """ massTrackingInfo: MassEmailTrackingInfo! """ Tracking events of the email, newest first: up to the 20 latest opens, clicks and unsubscribes, followed by the send event. """ trackingHistory: [EmailTrackingEvent]! """ Recipients of this mass email in the selected category, with their delivery and engagement state. """ massEmailRelations( """Recipient group to list, by delivery or engagement outcome.""" category: MassEmailRelationCategory! """Column the recipients are sorted by.""" sortBy: MassEmailDetailGridSortyBy """Sort direction.""" sortOrder: SortOrder """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MassEmailRelationItemConnection """ True when a tracking event other than a bounce (such as an open or a click) was recorded for the email. """ hasTrackingEvent: Boolean! """True when at least one file is attached to the email.""" hasAnyAttachment: Boolean! """ True when the email bounced; for a mass email, when any email sent from it bounced. Soft bounces are not counted. """ wasBounced: Boolean! """ Subject of the latest sent email in this conversation whose content the caller can read, or a localized "Private content" label when there is none. """ conversationSubject( """Limits the conversation to emails in this mailbox.""" mailboxId: ID ): String """ True when the caller can read the content of at least one sent email in this conversation, so `conversationSubject` returns a real subject. """ isConversationSubjectAvailable( """Limits the conversation to emails in this mailbox.""" mailboxId: ID ): Boolean! """ True when the caller can read the content of this email; otherwise `subject`, `body` and `bodySummary` return a localized "Private content" label. """ isContentAvailable( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID ): Boolean! """ True when the caller can change who can read the content of at least one email in this conversation (see `updateEmailThreadContentShareModeEmail`). """ canChangeConversationContentShareMode( """Limits the conversation to emails in this mailbox.""" mailboxId: ID ): Boolean! """ Paged conversation this email is in, optionally scoped to one mailbox. Deprecated in favour of `conversation`, which returns the whole thread in one payload. """ conversationItems( """Order of the emails by time; oldest first by default.""" sortOrder: SortOrder """ Limits the conversation to emails in this mailbox and also includes its drafts and scheduled emails. """ mailboxId: ID """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailConversationItemConnection """ All emails of the conversation this email belongs to in one unpaged list, ordered like `conversationItems`. """ conversation( """ Limits the conversation to emails in this mailbox and also includes its drafts and scheduled emails. """ mailboxId: ID """Order of the emails by time; oldest first by default.""" sortOrder: SortOrder ): [EmailConversationItem!]! """ Earliest sent email of this conversation; empty when this email is the only one in it. """ oldestConversationItem( """Limits the conversation to emails in this mailbox.""" mailboxId: ID ): EmailEntity """ Latest sent email of this conversation whose content the caller can read; empty when this email is the only one in it. """ newestReadableConversationItem( """Limits the conversation to emails in this mailbox.""" mailboxId: ID ): EmailEntity """ HTML body prefilled for a reply: an "On wrote:" line followed by the quoted original message. Null when the caller cannot read the email content. """ replyBody( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID ): String """ HTML body prefilled for forwarding: a forwarded-message header (From, Date, Subject, To, Cc) followed by the quoted original message. Null when the caller cannot read the email content. """ forwardBody( """ Mailbox the email is shown in (inbox). Content sharing is not applied there: the content is available when the email is in one of your mailboxes. Without it content sharing applies. """ mailboxId: ID ): String """ True when another user created this email and the given mailbox is not a company mailbox the caller can use. """ isDifferentActor( """Mailbox the email is viewed in.""" mailboxId: ID! ): Boolean! """ Records the email is linked to in the given mailbox, such as its sender and recipients. An item without `id` is an address not matched to any record, and `isAvailable` is false for a record the caller cannot see. """ linkedRecords( """Mailbox the email is viewed in.""" mailboxId: ID! ): [EmailEntityLinkedRecord!]! """ Labels the caller applied to this email's conversation, oldest first. Labels applied by other users and deleted labels are not returned. """ labels( """Limits the labels to those applied in this mailbox.""" mailboxId: ID """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailLabelRelationEntityConnection } """ Reusable email whose body can contain placeholders filled with record values; templates are organized in folders and can be shared. """ type EmailTemplateEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Folder in the template hierarchy that the template belongs to. Empty for templates at the root level. """ emailTemplateFolder: EmailTemplateFolderEntity """User who owns the template.""" owner: ClientEntity """ HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. """ body: String """ Id of the folder the template belongs to. Empty for templates at the root level. """ emailTemplateFolderId: ID """Name of the entity and its default text representation.""" name: String! """Id of the template owner.""" ownerId: ID! """ Colors recently used in the editor of the template body, as integer color values. """ recentColors: [Int!] """ Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). """ shareMode: ShareModeEnum """ When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. """ sharingUrlIsEnabled: Boolean """ Public sharing link of the template and, when personalized, the record whose data fills the template. """ sharingUrlSettings: EmailTemplateSharingUrlSettings """ Subject line of emails composed from this template. Supports merge-field placeholders. """ subject: String! """ Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). """ type: EmailTemplateTypeEnum! """Revision when entity was lastly changed.""" revision: Int """ Solutions whose canvas contains this record. Deleted solutions are not included. """ solutions( """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionEntityConnection """ Sales units granted shared access to this template (custom share mode). """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter EmailTemplateSharingSalesUnitRelation relations by edge (relation) EmailTemplateSharingSalesUnitRelation attributes. """ filterEdge: EmailTemplateSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailTemplateSharingSalesUnitRelationEntityConnection """Users granted shared access to this template (custom share mode).""" sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter EmailTemplateSharingClientRelation relations by edge (relation) EmailTemplateSharingClientRelation attributes. """ filterEdge: EmailTemplateSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailTemplateSharingClientRelationEntityConnection """Files attached to the template (used as default attachments).""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Tracking statistics (sent, opened, clicked, replied, bounced, unsubscribed) of the emails sent with this template. """ trackingInfo( """Period in which the tracking events occurred; all time when omitted.""" period: PeriodOptionParams ): MassEmailTrackingInfo! } """Folder that organizes email templates; folders can be nested.""" type EmailTemplateFolderEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent folder in the template hierarchy. Empty for top-level folders.""" parentEmailTemplateFolder: EmailTemplateFolderEntity """Name of the entity and its default text representation.""" name: String! """ Id of the parent folder in the template hierarchy. Empty for top-level folders. """ parentEmailTemplateFolderId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Public sharing link of an email template and the record whose data fills the template on the shared page. """ type EmailTemplateSharingUrlSettings { """Public sharing link of the template. Generated by the server.""" url: String! """ Type of the record whose data fills the template on the shared page; empty when the template is not personalized. """ personalizedEntityType: EntityNameEnum """ API name of the custom entity when the personalizing record is a custom entity. """ personalizedEntityApiName: String """Id of the record whose data fills the template on the shared page.""" personalizedEntityRecordId: ID } """Paginated list of EmailTemplateSharingSalesUnitRelation records.""" type EmailTemplateSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailTemplateSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EmailTemplateSharingSalesUnitRelationEntity` and its cursor. """ type EmailTemplateSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: EmailTemplateSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """ Sharing of an email template with a sales unit, as a watcher or an editor. """ type EmailTemplateSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Email template being shared.""" emailTemplate: EmailTemplateEntity """Sales unit the template is shared with.""" unit: SalesUnitEntity """Id of the email template shared with the sales unit.""" emailTemplateId: ID! """ Access the sharing gives the sales unit on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of EmailTemplateSharingClientRelation records.""" type EmailTemplateSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailTemplateSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EmailTemplateSharingClientRelationEntity` and its cursor. """ type EmailTemplateSharingClientRelationEntityEdge { """The item at the end of the edge""" node: EmailTemplateSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """Sharing of an email template with a user, as a watcher or an editor.""" type EmailTemplateSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the template is shared with.""" client: ClientEntity """Email template being shared.""" emailTemplate: EmailTemplateEntity """Id of the user.""" clientId: ID! """Id of the email template shared with the user.""" emailTemplateId: ID! """ Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Tracking statistics of a mass email or of the emails sent from a template: how many were sent, opened, clicked, replied to, bounced or unsubscribed. """ type MassEmailTrackingInfo { """ Number of emails that were opened; a click or an unsubscribe also counts as an open. Bounced emails are not counted. """ openEmailEventCount: Int! """ Number of emails in which a link was clicked. Bounced emails are not counted. """ clickEmailEventCount: Int! """Total number of emails the statistics are based on.""" totalEmailEventCount: Int! """Number of emails that were sent.""" sentEmailEventCount: Int! """Number of emails that bounced.""" bouncedEmailCount: Int! """Number of emails that received a reply.""" repliedEmailCount: Int! """Number of emails through which the recipient unsubscribed.""" unsubscribedEmailCount: Int! } """ Time period used by reports, dashboards and targets: a predefined range such as the current month, or a custom date range. """ input PeriodOptionParams { """Set only if period set to Custom""" periodCustomFrom: Date """Set only if period set to Custom""" periodCustomTo: Date """ Time range the data is reported over (for example MonthCurrent, QuarterCurrent, Custom). When Custom, periodCustomFrom and periodCustomTo define the bounds. """ period: PeriodKind! } """ Saved state of an email draft: recipients, subject, body, attachments, template and sharing, so the draft can be reopened for editing. """ type EmailDraftSettings { """Email account the email is sent from (`SendEmailService`).""" service: SendEmailService! """Primary (To) recipients of the email.""" recipients: [SendEmailRecipient]! """Blind-carbon-copy recipients of the email.""" bcc: [SendEmailRecipient]! """Carbon-copy recipients of the email.""" cc: [SendEmailRecipient]! """ Id of the email this one replies to, which puts it in that conversation. """ replyTo: String """Records chosen to be linked to the email.""" linkedItems: [SendEmailLinkedEntity]! """ True when records could be chosen to be linked to the email while composing it; false, for example, for a mass email sent from the account or contact list. """ isLinkEntitiesEnabled: Boolean! """True when the email is composed from an HTML email template.""" isHtmlTemplate: Boolean! """True to also send the email to recipients who have unsubscribed.""" sendToUnsubscribed: Boolean! """ For a mass email: true to also link each individual email to the lead or opportunity given for its recipient. """ massMailWithLinkedRecords: Boolean! """Email sequence the recipients are enrolled in once it is sent.""" enrollEmailSequenceId: UUID """Records whose data fill the placeholders of the email.""" personifyBy: PersonificationEntityData """Task created to log the email once it has been sent.""" logEmailAsTask: SendEmailFollowupTaskSettings """Follow-up task created once the email has been sent.""" logFollowUpTask: SendEmailFollowupTaskSettings """ Type of the records the recipients were picked from, such as Contact or Account, which the email is primarily addressed to; empty when not known. """ primaryEntity: EntityNameEnum """ Records a standard (not mass) email is linked to in addition to its recipients. """ standardMailAdditionalLinkedItems: [SendEmailLinkedEntity]! """True when the draft is a mass email.""" massMail: Boolean! """Subject of the draft.""" subject: String! """HTML body of the draft.""" html: String! """Ids of the files attached to the draft.""" attachments: [UUID]! """Email template the draft was composed from.""" emailTemplateId: UUID """Who can read the content of the email once it is sent.""" contentShareMode: ContentShareModeEnum """Users who can read the content when `contentShareMode` is Custom.""" contentSharingClients: [UUID]! """ Sales units whose members can read the content when `contentShareMode` is Custom. """ contentSharingUnits: [UUID]! } """Record a sent email or text message is linked to; set one of the ids.""" type SendEmailLinkedEntity { """Lead or opportunity the email is linked to.""" leadOpptyId: UUID """Project the email is linked to.""" projectId: UUID """Account the email is linked to.""" accountId: UUID """Contact the email is linked to.""" contactId: UUID """Quote the email is linked to.""" quoteId: UUID """Custom entity record the email is linked to.""" customEntityId: CustomEntityID } """ Records whose data fill the placeholders of an email or text message, such as its contact, account or opportunity. """ type PersonificationEntityData { """ Which of the given records, such as the Contact or the Account, the message is primarily addressed to. """ primary: EntityLacotaType """Opportunity whose data fills the opportunity placeholders.""" opportunityId: UUID """Contact whose data fills the contact placeholders.""" contactId: UUID """Account whose data fills the account placeholders.""" accountId: UUID """Lead whose data fills the lead placeholders.""" leadId: UUID """Project whose data fills the project placeholders.""" projectId: UUID """Quote whose data fills the quote placeholders.""" quoteId: UUID """ Custom entity records whose data fill the custom entity placeholders, each given as a `CustomEntityID`. """ customEntityIds: [CustomEntityID] } """ Task created once an email has been sent, either to log the email or to follow it up. """ type SendEmailFollowupTaskSettings { """Activity type of the task.""" taskTypeId: UUID! """ Time the task is created; tasks are created only after the email has been sent. """ dueDate: DateTime! """Status of the created task.""" status: TaskStatusEnum! """Description of the task.""" description: String! """Subject of the task.""" subject: String! } """ Sending settings of an email scheduled to be sent later: sending account, recipients, linked records and the tasks created once it is sent. """ type EmailScheduleSettings { """Email account the email is sent from (`SendEmailService`).""" service: SendEmailService! """Primary (To) recipients of the email.""" recipients: [SendEmailRecipient]! """Blind-carbon-copy recipients of the email.""" bcc: [SendEmailRecipient]! """Carbon-copy recipients of the email.""" cc: [SendEmailRecipient]! """ Id of the email this one replies to, which puts it in that conversation. """ replyTo: String """Records chosen to be linked to the email.""" linkedItems: [SendEmailLinkedEntity]! """ True when records could be chosen to be linked to the email while composing it; false, for example, for a mass email sent from the account or contact list. """ isLinkEntitiesEnabled: Boolean! """True when the email is composed from an HTML email template.""" isHtmlTemplate: Boolean! """True to also send the email to recipients who have unsubscribed.""" sendToUnsubscribed: Boolean! """ For a mass email: true to also link each individual email to the lead or opportunity given for its recipient. """ massMailWithLinkedRecords: Boolean! """Email sequence the recipients are enrolled in once it is sent.""" enrollEmailSequenceId: UUID """Records whose data fill the placeholders of the email.""" personifyBy: PersonificationEntityData """Task created to log the email once it has been sent.""" logEmailAsTask: SendEmailFollowupTaskSettings """Follow-up task created once the email has been sent.""" logFollowUpTask: SendEmailFollowupTaskSettings """ Type of the records the recipients were picked from, such as Contact or Account, which the email is primarily addressed to; empty when not known. """ primaryEntity: EntityNameEnum } """Paginated list of MessageSharingSalesUnitRelation records.""" type MessageSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MessageSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `MessageSharingSalesUnitRelationEntity` and its cursor. """ type MessageSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: MessageSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Share of a message (email or memo) with a sales unit.""" type MessageSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Email being shared. Set when messageId resolves to an Email; otherwise empty. """ email: EmailEntity """ Memo being shared. Set when messageId resolves to a Memo; otherwise empty. """ memo: MemoEntity """Sales unit the message is shared with.""" unit: SalesUnitEntity """Id of the email or memo being shared.""" messageId: ID! """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Internal message written by a user and linked to records, which other users can comment on. """ type MemoEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who authored the memo.""" owner: ClientEntity """Id of the memo author.""" ownerId: ID! """Short summary line of the memo.""" subject: String! """ Discriminator identifying the concrete record type — always "memo" for Memo records. Read-only; useful when consuming polymorphic Message results. """ tableName: String! """Revision when entity was lastly changed.""" revision: Int """Sales units that have been granted shared access to this memo.""" sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter MessageSharingSalesUnitRelation relations by edge (relation) MessageSharingSalesUnitRelation attributes. """ filterEdge: MessageSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageSharingSalesUnitRelationEntityConnection """Users that have been granted shared access to this memo.""" sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter MessageSharingClientRelation relations by edge (relation) MessageSharingClientRelation attributes. """ filterEdge: MessageSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageSharingClientRelationEntityConnection """Accounts this memo is linked to.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Contacts this memo is linked to.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Projects this memo is linked to.""" projectRelations( """Filter Project relations by target Project attributes.""" filter: ProjectFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Project relations by target Project attributes.""" orderBy: [ProjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Leads this memo is linked to.""" leadRelations( """Filter Lead relations by target Lead attributes.""" filter: LeadFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Lead relations by target Lead attributes.""" orderBy: [LeadOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Quotes this memo is linked to.""" quoteRelations( """Filter Quote relations by target Quote attributes.""" filter: QuoteFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Quote relations by target Quote attributes.""" orderBy: [QuoteOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Opportunities this memo is linked to.""" opportunityRelations( """Filter Opportunity relations by target Opportunity attributes.""" filter: OpportunityFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order Opportunity relations by target Opportunity attributes.""" orderBy: [OpportunityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Custom entity records this memo is linked to.""" customEntityRelations( """Filter CustomEntity relations by target CustomEntity attributes.""" filter: CustomEntityFilterInput """ Filter MessageRelation relations by edge (relation) MessageRelation attributes. """ filterEdge: MessageRelationFilterInput """Order CustomEntity relations by target CustomEntity attributes.""" orderBy: [CustomEntityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """Documents linked to this memo.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """Comments authored on this memo.""" comments( """Filter MemoComment relations by target MemoComment attributes.""" filter: MemoCommentFilterInput """Order MemoComment relations by target MemoComment attributes.""" orderBy: [MemoCommentOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MemoCommentEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of MessageSharingClientRelation records.""" type MessageSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MessageSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `MessageSharingClientRelationEntity` and its cursor. """ type MessageSharingClientRelationEntityEdge { """The item at the end of the edge""" node: MessageSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """Share of a message (email or memo) with an individual user.""" type MessageSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the message is shared with.""" client: ClientEntity """ Email being shared. Set when messageId resolves to an Email; otherwise empty. """ email: EmailEntity """ Memo being shared. Set when messageId resolves to a Memo; otherwise empty. """ memo: MemoEntity """Id of the user.""" clientId: ID! """Id of the email or memo being shared.""" messageId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of MessageRelation records.""" type MessageRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MessageRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `MessageRelationEntity` and its cursor.""" type MessageRelationEntityEdge { """The item at the end of the edge""" node: MessageRelationEntity """A cursor for use in pagination""" cursor: String! } """ Link between a message (email or memo) and a record such as an account, contact, lead or opportunity. """ type MessageRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account the message is linked to, or empty when not linked to an account. """ account: AccountEntity """ Contact the message is linked to, or empty when not linked to a contact. """ contact: ContactEntity """ Custom entity record the message is linked to, or empty when not linked. """ customEntity: CustomEntityEntity """ Lead the message is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity the message is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """ Email side of the link. Set when messageId resolves to an Email; otherwise empty. """ email: EmailEntity """ Memo side of the link. Set when messageId resolves to a Memo; otherwise empty. """ memo: MemoEntity """Project the message is linked to, or empty when not linked.""" project: ProjectEntity """Quote the message is linked to, or empty when not linked.""" quote: QuoteEntity """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the email or memo on this link.""" messageId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. """ type CustomEntityEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """Sales user who owns this custom entity record.""" owner: ClientEntity """ Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records. """ type: CustomEntityTypeEntity """ Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """Id of the currency exchange rate list applied to this record.""" currencyExchangeRatesListId: ID """Name of the entity and its default text representation.""" name: String """Id of the sales user who owns the custom entity record.""" ownerId: ID! """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """ Discriminator identifying which custom entity type this record belongs to. Read-only; matches CustomEntityType.entityApiName and is used as the entity name in REST and GraphQL queries. """ tableName: String! """Id of the custom entity type.""" typeId: ID """Id of the sales unit.""" unitId: ID """ Sales units that have been granted shared access to this custom entity record. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter CustomEntitySharingSalesUnitRelation relations by edge (relation) CustomEntitySharingSalesUnitRelation attributes. """ filterEdge: CustomEntitySharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntitySharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this custom entity record. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter CustomEntitySharingClientRelation relations by edge (relation) CustomEntitySharingClientRelation attributes. """ filterEdge: CustomEntitySharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntitySharingClientRelationEntityConnection """Documents linked to this custom entity record.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """Saved view profiles this custom entity record currently matches.""" staticProfiles( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ProfileRelation relations by edge (relation) ProfileRelation attributes. """ filterEdge: ProfileRelationFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """Tag labels applied to this custom entity record.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """ True when the current authenticated user has marked this record as favorite. Per-user. """ isFavorite: Boolean! """Revision when entity was lastly changed.""" revision: Int """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Configurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity. """ type CustomEntityTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ JSON definition of the form layout used by the UI when creating or editing records of this custom entity type. """ formEdit: JSONString! """ True when the custom entity type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """ Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. """ settings: EntityTypeSettings! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """ API name of the custom entity type (e.g. "Vehicle", "Project_Phase"). Used as the entity name when calling REST endpoints or selecting a concrete custom entity in GraphQL. """ entityApiName: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of CustomEntitySharingSalesUnitRelation records.""" type CustomEntitySharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CustomEntitySharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `CustomEntitySharingSalesUnitRelationEntity` and its cursor. """ type CustomEntitySharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: CustomEntitySharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """ Sharing of a custom entity record with a sales unit, as a watcher or an editor. """ type CustomEntitySharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Custom entity record being shared.""" customEntity: CustomEntityEntity """Sales unit the custom entity record is shared with.""" unit: SalesUnitEntity """Id of the shared custom entity record.""" customEntityId: ID! """ Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of CustomEntitySharingClientRelation records.""" type CustomEntitySharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CustomEntitySharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `CustomEntitySharingClientRelationEntity` and its cursor. """ type CustomEntitySharingClientRelationEntityEdge { """The item at the end of the edge""" node: CustomEntitySharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """ Sharing of a custom entity record with a user, as a watcher or an editor. """ type CustomEntitySharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the custom entity record is shared with.""" client: ClientEntity """Custom entity record being shared.""" customEntity: CustomEntityEntity """Id of the user.""" clientId: ID! """Id of the shared custom entity record.""" customEntityId: ID! """ Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProfileRelation records.""" type ProfileRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProfileRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProfileRelationEntity` and its cursor.""" type ProfileRelationEntityEdge { """The item at the end of the edge""" node: ProfileRelationEntity """A cursor for use in pagination""" cursor: String! } """Record added explicitly to a static saved view (profile).""" type ProfileRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account this profile is linked to, when applicable.""" account: AccountEntity """Contact this profile is linked to, when applicable.""" contact: ContactEntity """Custom entity record this profile is linked to, when applicable.""" customEntity: CustomEntityEntity """ Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. """ lead: LeadEntity """ Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """Screen profile this relation links to a specific record.""" profile: ProfileEntity """Project this profile is linked to, when applicable.""" project: ProjectEntity """Quote this profile is linked to, when applicable.""" quote: QuoteEntity """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Saved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others. """ type ProfileEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns the screen profile.""" owner: ClientEntity """ Specific record this profile is synchronized to. Set only when syncEnabled is true. """ syncEntity: ReportEntity """ Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity. """ entity: ScreenTypeEnum! """ API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty. """ entityApiName: String """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ Layout and chart configuration of the screen profile, stored as a JSON document. This payload conforms to the `ProfileSettings` JSON Schema: GET /api/v100/rest/schemas/ProfileSettings.json on your region's API host """ settings: JSONString! """ Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users. """ shareMode: ShareModeEnum """ When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records. """ syncEnabled: Boolean """Id of the synchronized record.""" syncEntityId: ID """ Whether the profile lists the records matching its filter (Dynamic) or a fixed list of records added to it explicitly (Static). """ type: ProfileTypeEnum """ When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ For pipeline-screen profiles, ids of the pipelines included in the profile configuration; empty for profiles on other screens. """ pipelines: [UUID!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Saved report or dashboard with its settings, sharing and delivery schedule. """ type ReportEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns the report or dashboard.""" owner: ClientEntity """Report folder this report is filed under (default folder when empty).""" reportsFolder: ReportFolderEntity """ Specific record this report is synchronized to. Set only when syncEnabled is true. """ syncEntity: ProfileEntity """ Public access token used in shareable report URLs. Empty when public sharing is not configured for the report. """ accessLink: String """ AI assistant conversation associated with the report (e.g. records of AI-driven report generation). """ aiConversation: [AiConversationItem!] """Free-text description shown alongside the report.""" description: String """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """Id of the parent report folder.""" reportsFolderId: ID! """ Report definition (entity, columns, filters, charts, structure). Stored as a JSON document. This payload conforms to the `ReportSettings` JSON Schema: GET /api/v100/rest/schemas/ReportSettings.json on your region's API host """ settings: ReportSettings! """ Who besides the owner can access the report: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit). """ shareMode: ShareModeEnum """ Legacy additional sharing options; kept with the record but no longer applied. """ shareModeParams: Int """ When true, name and settings are kept in sync with the linked screen profile; when false, the report is detached from profile sync. """ syncEnabled: Boolean """Id of the synchronized record.""" syncEntityId: ID """ Kind of report: a table or pivot report, a dashboard, an opportunity forecast, or an advanced report built from several linked tables. """ type: ReportTypeEnum! """Revision when entity was lastly changed.""" revision: Int """ The calling user's scheduled email delivery of this report; empty when none is set. Set it with `setScheduleReport` and remove it with `removeScheduleReport`. """ schedule: ReportScheduleEntity """ True when the current user has marked this report as a favorite (see ClientFavorite). """ isFavorite: Boolean! """Sales units granted shared access to this report (custom share mode).""" sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter ReportSharingSalesUnitRelation relations by edge (relation) ReportSharingSalesUnitRelation attributes. """ filterEdge: ReportSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ReportSharingSalesUnitRelationEntityConnection """Users granted shared access to this report (custom share mode).""" sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter ReportSharingClientRelation relations by edge (relation) ReportSharingClientRelation attributes. """ filterEdge: ReportSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ReportSharingClientRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Folder that organizes reports; folders can be nested.""" type ReportFolderEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Parent report folder, when this folder is nested. Empty for top-level folders. """ parentReportFolder: ReportFolderEntity """Name of the entity and its default text representation.""" name: String! """Id of the parent folder, or empty for top-level folders.""" parentReportFolderId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ One message of a conversation with the AI assistant, written by the user or by the assistant. """ type AiConversationItem { """Text of the message.""" text: String! """Author of the message: the user or the AI assistant.""" actor: AiConversationItemActor! } """Author of a message in an AI assistant conversation.""" enum AiConversationItemActor { """Message written by the user.""" User """Response from the AI assistant.""" System } """ Settings of a report; the variant depends on the report type: a table or advanced report, a dashboard report or a forecast report. """ union ReportSettings = ReportSchema | DashboardSchema | ForecastSchema | BetterDashboardSchema """Schedule that emails a report to its recipients at regular intervals.""" type ReportScheduleEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ User who owns the schedule. The schedule sends emails on behalf of this user. """ owner: ClientEntity """Report whose delivery is scheduled.""" report: ReportEntity """Id of the owning user.""" ownerId: ID! """Id of the scheduled report.""" reportId: ID! """ Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document. This payload conforms to the `ReportScheduleSchema` JSON Schema: GET /api/v100/rest/schemas/ReportScheduleSchema.json on your region's API host """ settings: ReportScheduleSchema """Revision when entity was lastly changed.""" revision: Int """Files attached to scheduled emails sent for this report.""" documents: [CloudObjectRelationEntity!] """ Email address used to send the scheduled report (company email when configured, otherwise the owner's personal email). """ senderEmail: String """Name of the scheduled report (mirror of the linked Report.name).""" reportName: String! """Id of the user who owns the scheduled report.""" reportOwnerId: UUID! """ Kind of the scheduled report (e.g. TableReport, AdvancedReport, DashboardReport). """ reportType: ReportTypeEnum! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ReportSharingSalesUnitRelation records.""" type ReportSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ReportSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ReportSharingSalesUnitRelationEntity` and its cursor. """ type ReportSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: ReportSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Share of a report with a sales unit, with the access level granted.""" type ReportSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Report being shared.""" report: ReportEntity """Sales unit granted shared access to the report.""" unit: SalesUnitEntity """Id of the shared report.""" reportId: ID! """ Access the sharing gives members and managers of the sales unit on the report: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ReportSharingClientRelation records.""" type ReportSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ReportSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ReportSharingClientRelationEntity` and its cursor. """ type ReportSharingClientRelationEntityEdge { """The item at the end of the edge""" node: ReportSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """ Share of a report with an individual user, with the access level granted. """ type ReportSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User granted shared access to the report.""" client: ClientEntity """Report being shared.""" report: ReportEntity """Id of the user.""" clientId: ID! """Id of the shared report.""" reportId: ID! """ Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Project delivered for an account or run internally, with its objectives, activities and progress. """ type ProjectEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account this project is delivered for, or empty for internal projects without an external account. """ account: AccountEntity """ Currency exchange rate list used to convert monetary fields linked to this project. Empty to inherit the team space default. """ currencyExchangeRatesList: CurrencyExchangeRatesListEntity """Sales user who owns this project.""" owner: ClientEntity """ Project type that classifies this project. Project types are configurable per team space and drive which form, fields and objectives apply. """ projectType: ProjectTypeEntity """ Sales unit this project is assigned to. Determines which team members can see the record under unit-based sharing. """ unit: SalesUnitEntity """Id of the related account.""" accountId: ID """Id of the currency exchange rate list applied to this project.""" currencyExchangeRatesListId: ID """Free-form description of the project.""" description: String """ Planned end date of the project. Must be on or after startDate when both are set. """ endDate: Date! """Name of the entity and its default text representation.""" name: String! """Id of the project owner.""" ownerId: ID! """Id of the project type that classifies this project.""" projectTypeId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when the project starts.""" startDate: Date """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. """ revenueGoal: CurrencyForeignField """Documents linked to this project.""" documents( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ Sales units that have been granted shared access to this project. Editable only when shareMode allows unit sharing. """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter ProjectSharingSalesUnitRelation relations by edge (relation) ProjectSharingSalesUnitRelation attributes. """ filterEdge: ProjectSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectSharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this project. Editable only when shareMode allows user sharing. """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter ProjectSharingClientRelation relations by edge (relation) ProjectSharingClientRelation attributes. """ filterEdge: ProjectSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectSharingClientRelationEntityConnection """ Primary contact of this project. Set automatically from the contact relation marked as primary. """ primaryContact: ContactEntity """Contacts linked to this project, including the primary-contact flag.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter ProjectContactRelation relations by edge (relation) ProjectContactRelation attributes. """ filterEdge: ProjectContactRelationFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectContactRelationEntityConnection """Tag labels applied to this project.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """Saved view profiles this project currently matches.""" staticProfiles( """Filter Profile relations by target Profile attributes.""" filter: ProfileFilterInput """ Filter ProfileRelation relations by edge (relation) ProfileRelation attributes. """ filterEdge: ProfileRelationFilterInput """Order Profile relations by target Profile attributes.""" orderBy: [ProfileOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: Int! """Objectives defined for this project, sorted by display order.""" objectives: [ProjectObjectiveEntity!] """ True when the current authenticated user has marked this project as favorite. Per-user. """ isFavorite: Boolean! """ Current status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress. """ status: ProjectStatusEnum! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ viewerIdsPerSalesUnit: [UUID!]! """ Percentage of activities (tasks and appointments) on this project that are completed. Read-only; computed by Coevera. """ completionRate: Float """ Total number of activities (tasks and appointments) linked to this project. Read-only; computed by Coevera. """ activitiesTotal: Float """ Number of completed activities on this project. Read-only; computed by Coevera. """ activitiesCompleted: Float """Display version of the project name, used in lists and references.""" formattedName: String! """ Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. """ modifiedByUser: DateTime """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! """ Data of the given preview pane charts and lists, computed for this record. """ charts( """ Ids of the charts to compute, taken from the charts of the record type's interface preview. Comment charts are not supported. """ ids: [UUID!]! ): [DashboardChartData!] """ Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart. """ chartsDrilldown( """ Id of the chart, taken from the charts of the record type's interface preview. """ id: UUID! """ Index of the series of the drilled-down data point. Required for report charts; must not be set for list charts. """ seriesIndex: Int """ Index of the drilled-down data point within its series. Required for report charts; must not be set for list charts. """ itemIndex: Int ): CompactViewDrilldownModel! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! """Activities of this project linked to the given project objective.""" projectObjectiveActivitiesDrilldown( """Project objective whose activities are returned.""" projectObjectiveId: UUID ): CompactViewDrilldownModel! } """Project type that classifies projects and defines their form and icon.""" type ProjectTypeEntity { """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost). """ formEditApi: Form """ False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. """ canChangeReadonly: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ JSON definition of the form layout used by the UI when creating or editing projects of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host """ formEdit: JSONString! """ Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). """ icon: ProjectTypeIconEnum """ True when the project type is system-managed and cannot be edited or deleted by users. """ isReadonly: Boolean! """Name of the entity and its default text representation.""" name: String! """ Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. This payload conforms to the `EntityTypeSettings` JSON Schema: GET /api/v100/rest/schemas/EntityTypeSettings.json on your region's API host """ settings: EntityTypeSettings! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProjectSharingSalesUnitRelation records.""" type ProjectSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProjectSharingSalesUnitRelationEntity` and its cursor. """ type ProjectSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: ProjectSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Share of a project with a sales unit, with the access level granted.""" type ProjectSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Project being shared.""" project: ProjectEntity """Sales unit the project is shared with.""" unit: SalesUnitEntity """Id of the shared project.""" projectId: ID! """ Access the sharing gives the sales unit on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProjectSharingClientRelation records.""" type ProjectSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProjectSharingClientRelationEntity` and its cursor. """ type ProjectSharingClientRelationEntityEdge { """The item at the end of the edge""" node: ProjectSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """ Share of a project with an individual user, with the access level granted. """ type ProjectSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the project is shared with.""" client: ClientEntity """Project being shared.""" project: ProjectEntity """Id of the user.""" clientId: ID! """Id of the shared project.""" projectId: ID! """ Access the sharing gives the user on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProjectContactRelation records.""" type ProjectContactRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectContactRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProjectContactRelationEntity` and its cursor. """ type ProjectContactRelationEntityEdge { """The item at the end of the edge""" node: ProjectContactRelationEntity """A cursor for use in pagination""" cursor: String! } """Link between a project and a contact, marking the primary contact.""" type ProjectContactRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact linked to the project.""" contact: ContactEntity """Project the contact is linked to.""" project: ProjectEntity """Id of the contact linked to the project.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the project the contact is linked to.""" projectId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of Contact records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply. Sorts by fields of the related record, listed in order of priority. """ contactType: [ContactTypeOrderByNestedInput!] """ Currency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Sales user who owns this contact. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Sales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Street address of the contact.""" address: OrderByEnum """City of the contact address.""" city: OrderByEnum """Free-form notes describing the contact.""" comments: OrderByEnum """Id of the contact type assigned to this contact.""" contactTypeId: OrderByEnum """Country of the contact address.""" country: OrderByEnum """Id of the currency exchange rate list applied to this contact.""" currencyExchangeRatesListId: OrderByEnum """ Primary email address of the contact. Used as default recipient for emails sent from Coevera. """ email1: OrderByEnum """Additional email address.""" email2: OrderByEnum """Additional email address.""" email3: OrderByEnum """Additional email address.""" email4: OrderByEnum """Additional email address.""" email5: OrderByEnum """Given name of the contact.""" firstName: OrderByEnum """ Gender of the contact: Unknown when not specified, Male, Female or NonBinary. """ gender: OrderByEnum """ True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """Family name of the contact.""" lastName: OrderByEnum """Middle name of the contact, if applicable.""" middleName: OrderByEnum """Id of the contact owner.""" ownerId: OrderByEnum """ Primary phone number of the contact. Used as default target for click-to-call. """ phone1: OrderByEnum """Additional phone number.""" phone2: OrderByEnum """Additional phone number.""" phone3: OrderByEnum """Additional phone number.""" phone4: OrderByEnum """Additional phone number.""" phone5: OrderByEnum """Job title or position of the contact.""" position: OrderByEnum """ Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. """ quickAccountName: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """State or province of the contact address.""" stateProvince: OrderByEnum """ Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. """ title: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ZIP or postal code of the contact address.""" zipCode: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """ Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Sorts by fields of the related record, listed in order of priority. """ socialMedia: [ContactSocialRelationOrderByNestedInput!] """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related ContactType record. Set exactly one field in each item. """ input ContactTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the contact type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ContactSocialRelation record. Set exactly one field in each item. """ input ContactSocialRelationOrderByNestedInput { """Unique identifier of entity. Must match with Contact id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """AngelList profile URL of the contact.""" angellistUrl: OrderByEnum """Crunchbase profile URL of the contact.""" crunchbaseUrl: OrderByEnum """Disqus profile URL of the contact.""" disqusUrl: OrderByEnum """Facebook profile URL of the contact.""" facebookUrl: OrderByEnum """Flickr profile URL of the contact.""" flickrUrl: OrderByEnum """Foursquare profile URL of the contact.""" foursquareUrl: OrderByEnum """Google+ profile URL of the contact.""" googlePlusUrl: OrderByEnum """Gravatar profile URL of the contact.""" gravatarUrl: OrderByEnum """Klout profile URL of the contact.""" kloutUrl: OrderByEnum """LinkedIn profile URL of the contact.""" linkedinUrl: OrderByEnum """Pinterest profile URL of the contact.""" pinterestUrl: OrderByEnum """Quora profile URL of the contact.""" quoraUrl: OrderByEnum """Reddit profile URL of the contact.""" redditUrl: OrderByEnum """Skype contact URL or username of the contact.""" skypeUrl: OrderByEnum """SlideShare profile URL of the contact.""" slideshareUrl: OrderByEnum """Twitter (X) profile URL of the contact.""" twitterUrl: OrderByEnum """Vimeo profile URL of the contact.""" vimeoUrl: OrderByEnum """WordPress site URL of the contact.""" wordpressUrl: OrderByEnum """XING profile URL of the contact.""" xingUrl: OrderByEnum """Yahoo profile URL of the contact.""" yahooUrl: OrderByEnum """Yelp profile URL of the contact.""" yelpUrl: OrderByEnum """YouTube channel URL of the contact.""" youtubeUrl: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of Tag records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TagOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who created the tag. Sorts by fields of the related record, listed in order of priority. """ creator: [ClientOrderByNestedInput!] """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Id of the creating user.""" creatorId: OrderByEnum """ For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags. """ entityApiName: OrderByEnum """ When false, the tag is hidden in pickers and cannot be assigned to new records. """ isEnabled: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Bit flags of the entities the tag can be attached to, added together: Contact 1, Account 2, Opportunity 4, Lead 8, Project 16, Email 32, Process 64, Appointment 128, Task 256, Quote 512, CustomEntity 1024, Solution 2048. """ supportedEntities: OrderByEnum """ When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of Profile records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProfileOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the screen profile. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Specific record this profile is synchronized to. Set only when syncEnabled is true. Sorts by fields of the related record, listed in order of priority. """ syncEntity: [ReportOrderByNestedInput!] """ Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity. """ entity: OrderByEnum """ API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty. """ entityApiName: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users. """ shareMode: OrderByEnum """ When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records. """ syncEnabled: OrderByEnum """Id of the synchronized record.""" syncEntityId: OrderByEnum """ When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Report record. Set exactly one field in each item. """ input ReportOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Public access token used in shareable report URLs. Empty when public sharing is not configured for the report. """ accessLink: OrderByEnum """Free-text description shown alongside the report.""" description: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Id of the parent report folder.""" reportsFolderId: OrderByEnum """ Who besides the owner can access the report: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit). """ shareMode: OrderByEnum """ When true, name and settings are kept in sync with the linked screen profile; when false, the report is detached from profile sync. """ syncEnabled: OrderByEnum """Id of the synchronized record.""" syncEntityId: OrderByEnum """ Kind of report: a table or pivot report, a dashboard, an opportunity forecast, or an advanced report built from several linked tables. """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Objective (goal) of a project.""" type ProjectObjectiveEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Project this objective belongs to.""" project: ProjectEntity """Name of the entity and its default text representation.""" name: String! """ Id of the project this objective belongs to. Set on create; cannot be changed afterwards. """ projectId: ID! """ Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. """ sortOrder: Int! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Records of the given entity type that are related to this record, as a drilldown list. """ relatedEntitiesDrilldown( """Entity type of the related records to list.""" entityType: EntityNameEnum! ): CompactViewDrilldownModel! } """ Records behind a chart or related-record list of a record's preview pane, listed as rows with the requested columns. """ type CompactViewDrilldownModel { """ Records of the drilldown, one row per record with the requested columns. """ listViewItems( """ Extra filter on the listed records, as a JSON object whose __typename names the filter for the record type, for example {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies no extra filter. """ filter: DrilldownFilterJSONString """Fulltext search by string. When null, search is not applied.""" searchQuery: String """Id of the field the items are sorted by.""" sortBy: ID! """Options settings for tab grid sort order listing""" sortOrder: SortOrder! """ Columns returned for each item, given by field id and display option; the values of each item follow the order of this list. """ displayColumn: [DisplayColumnParams!]! """ Highlighting of recent changes: values changed within the period carry their latest change in the change field of the row data. """ highlightChanges: GridHighlightChangesParams """Maximum number of items returned in one call.""" limit: Int """Number of items to skip before the first returned item; starts at 0.""" offset: Int = 0 """Max total records to return. If null, then no limit.""" maxRecords: Int ): GenericDrilldownDataGridViewItems! } """ Scrollable list of the records behind a chart, grid or statistic, as rows with the requested columns, plus sums and averages of the numeric columns. """ type GenericDrilldownDataGridViewItems implements ListingViewInterface & SnapshotIndexedDataInterface { """Total number of results in the view""" total: Int! """ Session that identifies consistent snapshot of the view data used for scrolling """ sessionId: String! """ Rows of the requested page, one per record, with the values of the requested columns. """ items: [DataGridViewItem!]! """ Sum of each numeric column over all listed records, one value per field. """ sumItem: [FieldDataContainer!]! """ Average of each numeric column over all listed records, one value per field; empty values count as zero. """ averageItem: [FieldDataContainer!]! } """Scrollable list of records, with the total number of results.""" interface ListingViewInterface { """Total number of results in the view""" total: Int! } """ Rows of a scrollable view, addressed by their position within a consistent snapshot of the data. """ interface SnapshotIndexedDataInterface { """ Session that identifies consistent snapshot of the view data used for scrolling """ sessionId: String! """Total number of results in the view""" total: Int! """Row items of scrollable view indexed by number""" items: [ViewItemInterface!]! } """Row of a scrollable record list, identified by the record id.""" interface ViewItemInterface { """Id of the record shown in the row.""" id: ID! } """ Row of a record grid: the record id and the values of the requested columns. """ type DataGridViewItem implements ViewItemInterface { """Id of the record shown in the row.""" id: ID! """Values of the row, one per requested display column.""" data: [FieldDataContainer!]! } """Value of one field in a row of a data grid view.""" type FieldDataContainer { """Value of the field in the form given by displayOption.""" value: JSONString """Id of the field the value belongs to.""" fieldId: ID! """Form in which the value is returned.""" displayOption: DisplayOption! """ Most recent change of the value when the view highlights changes; null otherwise. """ change: DataGridChange } """ Most recent change of a field value in a record grid within the highlight period: the old and new value, when it changed, by whom and through which application. """ type DataGridChange { """ Value of the field after its most recent change in the highlight period. """ newValue: ChangeLogValueObject """Value of the field before that change.""" oldValue: ChangeLogValueObject """Id of the application through which the change was made.""" applicationId: UUID! """Date and time of the change.""" created: DateTime! """ Numeric account id of the user who made the change; it differs from the user id used on space records. """ userId: Int } """ Value of a field before or after a change; the variant matches the kind of field, such as text, number, date, option, record reference or currency amount. """ union ChangeLogValueObject = ChangeLogStringValue | ChangeLogIntValue | ChangeLogFloatValue | ChangeLogBooleanValue | ChangeLogDateValue | ChangeLogDatetimeValue | ChangeLogDropdownValue | ChangeLogForeignCurrencyValue | ChangeLogMultiCheckboxValue | ChangeLogEntityListValue | ChangeLogUuidValue | ChangeLogGenderValue | ChangeLogLabelFlagValue | ChangeLogPriorityValue | ChangeLogAccountClassValue | ChangeLogShareModeValue | ChangeLogTaskStatusValue | ChangeLogLeadStatusValue | ChangeLogOpptyStatusValue | ChangeLogMeetingValue | ChangeLogTagsValue | ChangeLogAttendeeEmailsValue | ChangeLogQuoteStatusValue | ChangeLogGeoLocationValue """Value of a text field before or after a change.""" type ChangeLogStringValue { """Text value of the field.""" stringValue: String! } """Value of a whole-number field before or after a change.""" type ChangeLogIntValue { """Whole-number value of the field.""" intValue: Int! } """Value of a decimal-number field before or after a change.""" type ChangeLogFloatValue { """Decimal value of the field.""" floatValue: Float! } """Value of a true/false field before or after a change.""" type ChangeLogBooleanValue { """True/false value of the field.""" booleanValue: Boolean! } """Value of a date field before or after a change.""" type ChangeLogDateValue { """Date the field held before or after the change, without a time part.""" dateValue: Date! } """Value of a date and time field before or after a change.""" type ChangeLogDatetimeValue { """Date and time value of the field, in the requesting user's time zone.""" datetimeValue: DateTime! } """ Option selected in a dropdown or checkbox field value recorded in a change. """ type ChangeLogDropdownValue { """Id of the selected option.""" id: ID! """Current name of the selected option.""" label: String! } """ Amount of a foreign-currency field before or after a change, in its own currency and in the base currency of the space. """ type ChangeLogForeignCurrencyValue { """Amount converted to the base currency of the space.""" baseValue: Float! """Amount in the currency given by currencyId.""" valueForeign: Float! """Symbol of the currency given by currencyId.""" symbol: String! """Id of the currency the amount was entered in.""" currencyId: ID! } """ Options selected in a multi-select checkbox field before or after a change. """ type ChangeLogMultiCheckboxValue { """Options selected in the field value.""" values: [ChangeLogDropdownValue!]! } """ Records referenced by a field that links several records, such as linked records or watchers, before or after a change. """ type ChangeLogEntityListValue { """ Records referenced by the field value, such as the related records of a lookup, linked-records, products or watchers field. """ values: [ChangeLogEntityListValueItem!]! } """Record referenced by a field value recorded in a change.""" type ChangeLogEntityListValueItem { """Id of the referenced record.""" id: ID! """Current name of the referenced record.""" label: String! """ Type of the referenced record; CustomEntity for a custom entity record. """ entityName: EntityNameEnum! """ API name of the custom entity when entityName is CustomEntity; null otherwise. """ entityApiName: String } """Record referenced by a single-record field before or after a change.""" type ChangeLogUuidValue { """Id of the referenced record.""" id: ID! """Current name of the referenced record.""" label: String! } """Value of a gender field before or after a change.""" type ChangeLogGenderValue { """Gender the field held before or after the change.""" genderValue: GenderEnum! } """ Label flags (priority, hot, stalled) of a record before or after a change. """ type ChangeLogLabelFlagValue { """ Flags of the field value as a bit mask: Priority = 1, Hot = 2, Stalled = 4. """ flagValue: Int! } """Value of a priority field before or after a change.""" type ChangeLogPriorityValue { """Priority the field held before or after the change.""" priorityValue: PriorityEnum! } """Value of an account class field before or after a change.""" type ChangeLogAccountClassValue { """Account class the field held before or after the change.""" accountClassValue: AccountClassEnum! } """Sharing mode of a record before or after a change.""" type ChangeLogShareModeValue { """Sharing mode the field held before or after the change.""" shareModeValue: ShareModeEnum! } """Status of a task before or after a change.""" type ChangeLogTaskStatusValue { """Task status the field held before or after the change.""" taskStatusValue: TaskStatusEnum! } """Status of a lead before or after a change.""" type ChangeLogLeadStatusValue { """Lead status the field held before or after the change.""" leadStatusValue: LeadStatusEnum! } """Status of an opportunity before or after a change.""" type ChangeLogOpptyStatusValue { """Opportunity status the field held before or after the change.""" opptyStatusValue: OpptyStatusEnum! } """Online meeting of an appointment before or after a change.""" type ChangeLogMeetingValue { """Link participants use to join the online meeting.""" joinUrl: String! """Online meeting service hosting the meeting.""" type: AppointmentMeetingTypeEnum! } """Tags of a tags field before or after a change.""" type ChangeLogTagsValue { """Tags in the field value.""" values: [ChangeLogTagsValueItem!]! } """Tag in a tags field value recorded in a change.""" type ChangeLogTagsValueItem { """Id of the tag.""" id: ID! """Current name of the tag.""" label: String! """Display color of the tag, encoded as a 24-bit RGB integer.""" color: Int! } """ Value of an appointment attendee email field as recorded in a change log entry. """ type ChangeLogAttendeeEmailsValue { """Email addresses of the attendees in the field value.""" emails: [String]! } """Status of a quote before or after a change.""" type ChangeLogQuoteStatusValue { """Quote status the field held before or after the change.""" quoteStatusValue: QuoteStatusEnum! } """Coordinates of a geographic location field before or after a change.""" type ChangeLogGeoLocationValue { """Location written as degrees, minutes and seconds.""" formatted: String! """Latitude in decimal degrees.""" lat: Float! """Longitude in decimal degrees.""" lng: Float! } """JSON value, sent and returned as a string.""" scalar DrilldownFilterJSONString """ Column requested from a record list: the field and the form in which its value is returned. """ input DisplayColumnParams { """Id of the field shown in the column.""" fieldId: ID! """ Form in which the column value is returned, for example as a readable name or as the raw stored value. """ displayOption: DisplayOption! } """ Settings for highlighting recent changes in a record grid: the look-back period, the columns watched and whether only changed records are listed. """ input GridHighlightChangesParams { """ Look-back window in which changes are highlighted; with Custom, customPeriodValue gives the number of days. """ period: HighlightPeriodEnum! """ Ids of the displayed fields whose changes are highlighted. Null highlights all displayed fields; an empty list turns highlighting off. """ columns: [UUID!] """When true, only records with a highlighted change are listed.""" showOnlyRecordsWithChanges: Boolean! """Number of days to look back when period is Custom.""" customPeriodValue: Int = 1 """ When true, changes are highlighted. Defaults to false, which turns highlighting off. """ isEnabled: Boolean = false } """ Computed data of a dashboard item or of a chart on a record's preview pane; the variant matches the kind of item. """ union DashboardChartData = DashboardReportChartData | DashboardPipelineConversionsChartData | DashboardListChartData | DashboardTileData | DashboardInsightsData | DashboardAgendaData | DashboardTargetData | DashboardOpportunitiesTrendData | DashboardGridData | DashboardKpiData | DashboardKpiListData """ Computed data of a report chart: its series, or its scorecard or Sankey values, and the fields used. """ type DashboardReportChartData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """Data series of the chart; null for Scorecard and Sankey charts.""" series: [DashboardChartSeries!] """Value and comparison of a Scorecard chart; null for other chart types.""" scorecard: ScorecardData """Flow data of a Sankey chart; null for other chart types.""" sankey: SankeyData """Field whose values are aggregated; null when the chart counts records.""" field: FieldDescriptor """Field the values are grouped by along the main axis.""" groupField: FieldDescriptor """ Field that splits the groups into separate series; null without segmentation. """ segmentField: FieldDescriptor """Type of the chart, such as Line, Column, Pie, Scorecard or Sankey.""" type: ReportChartType } """ Fields shared by all computed dashboard and preview chart data: the chart id and the reason the data could not be loaded. """ interface DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError } """Reason a dashboard chart, tile, target or agenda returns no data.""" enum DashboardChartError { """The chart is turned off in the source report or forecast.""" Disabled """The user lacks access to the source report or to fields it uses.""" NotEnoughPermissions """The source report or record no longer exists.""" Deleted """ The data cannot be computed for the current configuration, for example an unsupported source or aggregation. """ Unavailable } """ One data series of a computed report chart, such as a segment, a comparison period or the average line. """ type DashboardChartSeries { """Data points of the series, in display order.""" items: [DashboardChartSeriesItem!]! """ Name of the series: the segment value for a segmented chart; null otherwise. """ label: String """True for the series that draws the average line.""" isAverage: Boolean """Period of the comparison series; null for the other series.""" comparisonPeriod: PeriodOption """History comparison date the series shows, for history-based reports.""" historyComparisonDateId: UUID } """ Data point of a report chart series: a labeled value, or a point with coordinates for bubble and scatter charts. """ union DashboardChartSeriesItem = DashboardChartSeriesValueItem | DashboardChartSeriesXYItem """Data point of a chart: a label on the horizontal axis and its value.""" type DashboardChartSeriesValueItem { """ Label of the data point shown on the horizontal axis, such as a month or an owner name. """ label: String """ Value of the data point shown on the vertical axis; null when there is no value, for example in some forecast series. """ value: Float } """Item for bubble chart (x, y, r) and scatter plot (x, y)""" type DashboardChartSeriesXYItem { """Value on the horizontal axis: the numeric value of the grouping field.""" x: Float! """Value on the vertical axis: the aggregated value.""" y: Float! """Bubble size for bubble charts; null for scatter plots.""" r: Float } """ Computed value of a scorecard chart, with the value of the comparison period when one is set. """ type ScorecardData { """Aggregated value shown on the scorecard.""" value: Float """Value of the comparison period; null when the chart has no comparison.""" comparisonValue: Float """ Period the comparison value covers; null when the chart has no comparison. """ comparisonPeriod: PeriodOption } """ Computed data of a Sankey chart: the groups of records at the start and end of the flow and the flows between them. """ type SankeyData { """Field the records are grouped by at the start of the flow.""" startField: FieldDescriptor """Field the records are grouped by at the end of the flow.""" endField: FieldDescriptor """Total aggregated value at the start of the flow.""" startValue: Float! """Total aggregated value at the end of the flow.""" endValue: Float! """Groups at the start of the flow.""" startNodes: [SankeyDataNode!]! """Groups at the end of the flow.""" endNodes: [SankeyDataNode!]! """Flows from a start group to an end group, with their values.""" links: [SankeyDataLink!]! } """ Description of a field: its names, type, the access level of the current user and its type-specific settings. """ type FieldDescriptor { """Unique identifier of the field.""" id: ID! """Name of the field; a translation key when useLang is true.""" name: String! """ Field name in the current user's language, taken from nameTranslations. Null when no translation is available for that language. """ nameTranslated: String """ Map of locale codes to translated field names (e.g. {"en-US": "First name"}). Empty when no translations are defined. """ nameTranslations: JSONString! """ Immutable name of the field used in the REST API and integrations; null for fields without an API name. """ apiName: String """ Name of the field in the GraphQL API: apiName in camelCase. Null when the field has no apiName. """ graphqlName: String """ Entity the field belongs to; CustomEntity for custom entities (see entityApiName). Null for fields of an external service (see externalEntity). """ entity: EntityNameEnum """ API name of the custom entity the field belongs to; null for fields of other entities. """ entityApiName: 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. """ externalEntity: String """ When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown. """ useLang: Boolean! """Primitive value type of the field type (e.g. STRING, INT, BOOL, DATE).""" primitiveType: PrimitiveType! """Id of the field type (e.g. input, dropdown, currency, lookup).""" typeId: String! """ Field type with its properties, such as whether it is filterable or sortable. """ type: TypeEntity! """ 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. """ sourceTypeId: String! """ 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. """ sourceFieldId: ID """Access level of the current user to the field.""" permissionLevel: AccessLevelFieldEnum! """ For enum fields, name of the enum type that lists the allowed values (e.g. AccountClassEnum); null for other fields. """ typeEnumClassName: String """True when the field is deleted.""" isDeleted: Boolean! """Default value of the field, as text; null when none is set.""" defaultValue: String """Id of this fields composite parent (main) field.""" compositeFieldId: ID """ Id of the data set holding the options of a dropdown, radio or multiselect field; null for other fields. """ dataSetId: ID """ For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. """ parentOptionsFieldId: ID """Formula used to calculate value of this field.""" calcFormula: String """Id of sequence set used for this fields for auto incremented fields.""" sequenceSetId: ID """Marks if field is required no matter what form validator says.""" systemRequired: Boolean """Marks if field is readonly by default - cannot be updated.""" systemReadonly: Boolean """Origin of the field: built-in, created by the space, or derived.""" systemType: FieldSystemType! """ When the field is shared between abstract entities (e.g. Lead and Opportunity), id of the counterpart field on the other entity; null otherwise. """ sharedWithFieldId: ID "\nEntities where field is allowed to be used,\nfor relation fields both left relation entity and right relation entity record is returned.\nAbstract Entity (e.g. LeadOppty, Activity) are not returned they have to be evaluated by receiver.\n" allowedEntityTypes: [AllowedEntityType!]! """Properties for fields of type lookup. Otherwise null.""" lookup: LookupProperty """Properties for fields of type rollup. Otherwise null.""" rollup: RollupProperty """Formula used to calculate value of this field.""" advancedFormula: AdvancedFormulaProperty """ 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. """ options: FieldOptionsProperty """ AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency field types. """ aiOptions: FieldAiOptions "\nDescribes possible usage of field in application.\n" fieldUseOptions: FieldUseOptions """ 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. """ valueOptions( """ Entity on which the field is being used. This is used to identify correct value options, e.g Using ActivityType (TaskType + AppointmentType together) options when Task.type field is used on Activity entity. """ entity: EntityNameEnum """ Name of the entity in an external service (e.g. HubSpot or Salesforce) the field belongs to; set instead of entity for fields of that service. """ externalEntity: String """Conditions that limit the returned options.""" filter: FieldValueOptionFilterInput """Number of option items to return.""" first: Int """Return items located after item with this id.""" after: ID """Limit result set to options with provided ids.""" typeIds: [String!] """When true, deleted options are listed after the others.""" inaccessibleLast: Boolean = false ): [FieldValueOption!] """ For relation fields, the entity the field points to (e.g. Contact, Account); null for other fields. """ relatedEntity: String } """Underlying data type of a field type.""" enum PrimitiveType { """ Structured payload, such as a JSON document, form definition or geolocation. """ BLOB """True/false value.""" BOOL """Calendar date without time.""" DATE """Date and time.""" DATETIME """Exact decimal number, used for amounts, prices and quantities.""" DECIMAL """Floating-point number, used for example for percentages.""" DOUBLE """Value whose type depends on context, such as a target value.""" DYNAMIC """One value, or a combination of flags, from a fixed set of options.""" ENUM """Whole number.""" INT """ List of values, such as multi-select options, lookup links or attachments. """ LIST """Composite value, such as a record card, date range or key-value map.""" OBJECT """Text.""" STRING """Identifier, typically a reference to another record or option.""" UUID """Full-text search index of the record; not a user-editable value.""" TSVECTOR } """ Data type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped. """ type TypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """ Underlying data type of values of this field type, such as STRING, DECIMAL or DATETIME. Read-only. """ primitiveType: PrimitiveType! """ Validation rules applied to values of this type (e.g. max length, regex, allowed enum values), as a JSON document. """ validator: JSONString """ What fields of this type can do, as a sum of flags: 1 - can be a custom field, 2 - can have a calculation formula, 4 - can have a default value, 8 - can be shown on mobile, 16 - needs a field mapping, 32 - cannot be placed on forms, 64 - can be read-only on forms, 128 - only on the main form, 256 - can be used in calculation formulas, 512 - must stay on the form, 1024 - searchable in global search, 2048 - needs a calculation formula, 4096 - can be used in advanced calculation formulas. """ flag: Int! """ Default value applied to fields of this type when no value is supplied at create-time. Empty when the type has no default. """ defaultValue: String """ Whether fields of this type hold a plain value (NO_RELATION), a reference to one related record (MANY_TO_ONE_SCALAR) or a collection of related records (MANY_TO_MANY_VECTOR). """ relationType: RelationType! """ Maximum length or capacity for fields of this type (e.g. string max-length). """ containerSize: Int! """ True when fields of this type can be used as a grouping column in reports. """ isGroupable: Boolean! """True when fields of this type can be used in filters.""" isFilterable: Boolean! """True when fields of this type can be used to sort records.""" isSortable: Boolean! """True when fields of this type can be selected in queries.""" isSelectable: Boolean! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Whether a field type holds a plain value or references related records. """ enum RelationType { """Plain value; no related record.""" NO_RELATION """Reference to a single related record.""" MANY_TO_ONE_SCALAR """Collection of related records.""" MANY_TO_MANY_VECTOR } """ Origin of a field: built into Coevera, created by the space, or derived by the server. """ enum FieldSystemType { """Core built-in field the entity always has; it cannot be deleted.""" SYSTEM """Standard built-in field that cannot be deleted.""" PROTECTED """Field created by the space's administrators.""" CUSTOM """ Field whose value is not stored on the record itself but assembled from related data, such as tags or watchers. """ VIRTUAL """Field whose value is calculated and stored by the server; read-only.""" COMPUTED } """ 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. """ type AllowedEntityType { """ Name of entity where field is allowed to be used, for relation fields both left relation entity and right relation entity is returned.Abstract Entity (e.g. LeadOppty, Activity) are not returned they have to be evaluated by receiver. """ entity: EntityNameEnum! """ API name of the custom entity when entity is CustomEntity; null for other entities. """ entityApiName: String """ Ids of entity types where field is declared on its type form, if entity doesn't have types a NULL is returned. """ entityTypeIds: [ID!] } """Describes possible usage of field in application.""" type FieldUseOptions { """Field can retrieved in result set. E.g. as grid view column.""" isDisplayable: Boolean! """Field can be used in entity filter.""" isFilterable: Boolean! """Results can be grouped by this field.""" isGroupable: Boolean! """Results can be sorted by this field.""" isSortable: Boolean! """True when the field can be used as a row or column of a pivot report.""" isDisplayableOnPivot: Boolean! """True when report results can be aggregated by this field.""" isAvailableForAggregation: Boolean! """True when the field can be the measured value of a sales target.""" isAvailableForTargetCalculation: Boolean! """ True when the field can be a value field of a pivot report; numeric fields only. """ isAvailableForPivotDataField: Boolean! """True when the field can be referenced from a Webresource URL template.""" isAvailableForWebresource: Boolean! """Field can be used in other field's calculation formula""" isAvailableForCalculationFormula: Boolean! """Field can be used in advanced calculation formula""" isAvailableForAdvancedCalcFormula: 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. """ isAvailableForChangeLog: Boolean! """ True when the field can be used in history reports, which show how values changed over time. """ isAvailableForHistoryReport: Boolean! """ True when the field can be used as an input in an advanced formula on this entity. """ isAvailableForAdvancedFormula: Boolean! """ True when the field can be used to find similar accounts in the product white space analysis. """ isAvailableForWhiteSpaceComparison: Boolean! """ True when the value of the field can be chosen when merging duplicate records. """ isAvailableForMerge: Boolean! """ True when the field cannot be edited on individual occurrences of a recurring appointment. """ isReadonlyOnRecurrentAppointment: Boolean! } """ Value a field can take, with its label and color, for example to offer it in a filter. """ type FieldValueOption { """ Value of the option as used in filter conditions and field values, typically the id of the option or of the referenced record. """ value: String """Label of the option; a translation key when useLang is true.""" label: String! """Label of the option in the current user's language.""" labelTranslated: String! """ When true, the label is treated as a translation key and resolved through the translation system; otherwise the literal label is shown. """ useLang: Boolean! """True when the option, or the record it points to, is deleted.""" isDeleted: Boolean! """True when the option points to an archived record.""" isArchived: Boolean! """ Color of the option, encoded as an integer; null when the option has no color. """ color: Int """ 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. """ extraInfo: String """ URL of the picture of the option. Set only for an option that is a user, null when the user has no picture. """ pictureUrl: String } """Conditions that limit the value options returned for a field.""" input FieldValueOptionFilterInput { """Returns only the options with these values.""" valueIn: [String!] = [] """Returns only the option with this value.""" value: 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. """ labelContains: String = "" """ For the opportunity step field, returns only the steps of these pipelines. """ pipelineIds: [UUID] """ For the lead step field, returns only the steps of these lead processes. """ leadProcessIds: [UUID] """ For the quote step field, returns only the steps of these quote processes. """ quoteProcessIds: [UUID] """Leaves out options that point to archived records.""" excludeArchived: Boolean = false """Returns only options that point to archived records.""" excludeNonArchived: Boolean = false } """Group of records at the start or end of a Sankey chart.""" type SankeyDataNode { """Id of the node, referenced by the links.""" id: String! """ Name of the group the node stands for; null for records without a value. """ label: String } """ Flow of records from a start group to an end group of a Sankey chart, with its value at both ends. """ type SankeyDataLink { """Id of the start node the flow leaves.""" startId: String! """Always null; the label is on the startNodes item with the same id.""" startLabel: String """Id of the end node the flow reaches.""" endId: String! """Always null; the label is on the endNodes item with the same id.""" endLabel: String """ Aggregated value of the records in the flow, measured at the end of the flow. """ endValue: Float! """ Aggregated value of the records in the flow, measured at the start of the flow. """ startValue: Float! } """ Computed data of a pipeline conversions dashboard item: the conversion of each step of the pipeline. """ type DashboardPipelineConversionsChartData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """Conversion of each step of the sales pipeline, in step order.""" steps: [DashboardChartStep!] } """ Conversion data of one step of a sales pipeline in a pipeline conversions chart. """ type DashboardChartStep { """ Share, in percent, of the opportunities (or of their value, for Sum) that reached the step and moved beyond it. """ conversion: Float """Name of the pipeline step.""" label: String! """ Number of opportunities that reached the step, or their total value for Sum. """ value: Float } """ Computed data of a list chart on a record's preview pane: the records listed, their sorting and the total count. """ type DashboardListChartData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """Records shown in the list; most list charts show at most five records.""" entities: [DashboardListChartDataEntity!] """Field the records are sorted by; null when no sorting is set.""" sortField: FieldDescriptor """ Total number of matching records, which can exceed the records listed; null for a list of linked records. """ total: Int } """ One record shown in a dashboard list chart, in the field matching its kind. """ type DashboardListChartDataEntity { """The list item when it is an account.""" account: AccountEntity """The list item when it is a contact.""" contact: ContactEntity """The list item when it is a lead.""" lead: LeadEntity """The list item when it is an opportunity.""" opportunity: OpportunityEntity """The list item when it is a note.""" note: NoteEntity """The list item when it is a file.""" cloudObject: CloudObjectEntity """The list item when it is a task.""" task: TaskEntity """The list item when it is an appointment.""" appointment: AppointmentEntity """The list item when it is a project objective.""" projectObjectiveData: ProjectObjectiveData """The list item when it is a project, with its objective progress.""" projectData: ProjectData """The list item when it is a quote.""" quote: QuoteEntity """The list item when it is a custom entity record.""" customEntity: CustomEntityEntity } """ Note a user wrote on a record such as an account, contact, lead, opportunity, project or quote. """ type NoteEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account the note is attached to. Exactly one of account / contact / leadOppty / project / quote / customEntity must be set. """ account: AccountEntity """Contact the note is attached to.""" contact: ContactEntity """Custom entity record the note is attached to.""" customEntity: CustomEntityEntity """Lead the note is attached to. Set when leadOpptyId resolves to a Lead.""" lead: LeadEntity """ Opportunity the note is attached to. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """User who authored the note.""" owner: ClientEntity """Project the note is attached to.""" project: ProjectEntity """Quote the note is attached to.""" quote: QuoteEntity """Id of the account the note is attached to.""" accountId: ID """Id of the contact the note is attached to.""" contactId: ID """Id of the custom entity record the note is attached to.""" customEntityId: ID """Id of the lead or opportunity the note is attached to.""" leadOpptyId: ID """Free-form text body of the note (sanitized HTML allowed).""" note: String! """Id of the note author.""" ownerId: ID! """Id of the project the note is attached to.""" projectId: ID """Id of the quote the note is attached to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Project objective in a dashboard list, with the progress of its activities. """ type ProjectObjectiveData { """The objective; null for the activities not assigned to any objective.""" objective: ProjectObjectiveEntity """Progress status of the objective, derived from its activities.""" status: ProjectObjectiveStatusEnum """ Number of activities of the objective that the tab lists, after its filters. """ total: Int! """Number of completed activities of the objective.""" completedTotal: Int! """ Number of activities of the objective that are in progress, deferred or waiting and not overdue. """ inProgressTotal: Int! """Number of overdue activities of the objective.""" overdueTotal: Int! """Earliest start date among the listed activities of the objective.""" firstActivityStartDate: Date """Latest due or end date among the listed activities of the objective.""" lastActivityEndDate: Date """ Total number of activities of the objective the user can see, regardless of the tab filters. """ objectiveTotal: Int! """ Earliest future start date among the listed activities that are not completed or deferred. """ nextPlannedActivityStartDate: Date } """Status of a project objective, derived from its activities.""" enum ProjectObjectiveStatusEnum { """None of the objective's activities has started.""" NotStarted """Some of the objective's activities are started or completed.""" InProgress """At least one of the objective's activities is overdue.""" AtRisk """All of the objective's activities are completed.""" Completed } """Project in a dashboard list, with the progress of its objectives.""" type ProjectData { """ Project shown in the dashboard list; its objective progress is in objectivesCompleted and objectivesTotal. """ project: ProjectEntity! """Number of completed objectives of the project.""" objectivesCompleted: Int! """Total number of objectives of the project.""" objectivesTotal: Int! } """ Computed value of a dashboard tile and the color set by its conditional formatting. """ type DashboardTileData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """Id of the tile in the dashboard schema.""" tileId: UUID """Aggregated value of the tile.""" tileValue: Float """ Color set by the first matching conditional formatting rule, as a packed RGB integer; null when no rule matches. """ tileColor: Int } """Computed values of the tiles of an insights dashboard item.""" type DashboardInsightsData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """Values of the insight tiles, in the order of the insights item.""" insights: [DashboardTileData!]! } """Computed agenda of an agenda dashboard item.""" type DashboardAgendaData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """ Agenda of the item: upcoming tasks, appointments and opportunities, and overdue tasks. """ agenda: BetterDashboardAgenda } """ Agenda of a dashboard item: upcoming tasks, appointments and opportunities, and overdue tasks. """ type BetterDashboardAgenda { """ Agenda items up to the end of the agenda period, of the kinds the item shows: tasks by due date, appointments, and opportunities by closing date or step deadline. """ items( """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): NavigatorAgendaItemConnection """ Uncompleted tasks due before today that match the agenda activity filter. """ overdueTasks: OverdueTasks! } """Paginated list of NavigatorAgendaItemInterface items.""" type NavigatorAgendaItemConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [NavigatorAgendaItemEdge]! } """A Relay edge containing a `NavigatorAgendaItem` and its cursor.""" type NavigatorAgendaItemEdge { """The item at the end of the edge""" node: NavigatorAgendaItemInterface """A cursor for use in pagination""" cursor: String! } """ Entry of an agenda: a task, appointment or opportunity listed on its date. """ interface NavigatorAgendaItemInterface { """Id of the task, appointment or opportunity the item stands for.""" linkedId: ID! """ Day the item is listed on: the task due date, the appointment start, or the opportunity closing date or step deadline. """ date: Date! """Subject of the task or appointment, or name of the opportunity.""" name: String! } """Overdue tasks shown in the dashboard agenda, with their count.""" type OverdueTasks { """Number of overdue tasks.""" overdueTasksCount: Int! """Overdue tasks, earliest due date first.""" overdueTasksList( """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OverdueTaskOverviewAgendaConnection } """Paginated list of OverdueTaskOverviewAgenda items.""" type OverdueTaskOverviewAgendaConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OverdueTaskOverviewAgendaEdge]! } """A Relay edge containing a `OverdueTaskOverviewAgenda` and its cursor.""" type OverdueTaskOverviewAgendaEdge { """The item at the end of the edge""" node: OverdueTaskOverviewAgenda """A cursor for use in pagination""" cursor: String! } """ Overdue task listed in an agenda, with its type, priority, reminder and owner. """ type OverdueTaskOverviewAgenda implements OverdueTaskOverview { """Id of the task.""" id: ID! """Subject of the task.""" subject: String! """Due date the task has passed.""" dueDate: Date """Icon of the task type.""" taskType: ActivityTypeIconEnum! """Priority of the task.""" priority: PriorityEnum! """Reminder date and time of the task; null when no reminder is set.""" reminder: DateTime """Name of the task owner.""" ownerName: String! } """Task in the dashboard agenda that is past its due date.""" interface OverdueTaskOverview { """Id of the task.""" id: ID! """Subject of the task.""" subject: String! """Due date the task has passed.""" dueDate: Date } """ Computed data of a target dashboard item: the actual value and the goal it is compared with. """ type DashboardTargetData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """ Name of the saved target or forecast the item measures against; null for an inline goal. """ targetName: String """Description of the saved target or forecast; null for an inline goal.""" targetDescription: String """Actual aggregated value of the source records.""" targetValue: Float """Goal value the actual value is compared against.""" targetGoal: Float } """ Computed series of an opportunities trend dashboard item, one per value type. """ type DashboardOpportunitiesTrendData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """ Weighted value of open and won opportunities by closing date, one item per step of the chart period. """ opportunitiesTrendWeightedData: [DashboardChartSeriesValueItem!]! """ Unweighted value of open and won opportunities by closing date, one item per step of the chart period. """ opportunitiesTrendUnweightedData: [DashboardChartSeriesValueItem!]! """ Balanced value of open and won opportunities by closing date, one item per step of the chart period. """ opportunitiesTrendBalancedData: [DashboardChartSeriesValueItem!]! """ Value of won opportunities by closing date, one item per step of the chart period. """ opportunitiesTrendWonData: [DashboardChartSeriesValueItem!]! """ Ranked value of open and won opportunities by closing date, one item per step of the chart period. """ opportunitiesTrendRankedData: [DashboardChartSeriesValueItem!]! """Goal value of the item target; null when no target is set.""" goal: Float } """Computed rows of a grid dashboard item.""" type DashboardGridData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """ Rows of the grid item. Columns, sorting and the record limit default to the grid configuration and can be overridden by the arguments; the filter argument is not applied. """ listViewItems( """ Extra filter on the listed records, as a JSON object whose __typename names the filter for the record type, for example {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies no extra filter. """ filter: DrilldownFilterJSONString """Fulltext search by string. When null, search is not applied.""" searchQuery: String """Id of the field the items are sorted by.""" sortBy: ID! """Options settings for tab grid sort order listing""" sortOrder: SortOrder! """ Columns returned for each item, given by field id and display option; the values of each item follow the order of this list. """ displayColumn: [DisplayColumnParams!]! """ Highlighting of recent changes: values changed within the period carry their latest change in the change field of the row data. """ highlightChanges: GridHighlightChangesParams """Maximum number of items returned in one call.""" limit: Int """Number of items to skip before the first returned item; starts at 0.""" offset: Int = 0 """Max total records to return. If null, then no limit.""" maxRecords: Int ): GenericDrilldownDataGridViewItems! } """ Computed values of a dashboard KPI for the current and comparison periods, with its chart data. """ type DashboardKpiData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """Id of the KPI in the dashboard schema.""" kpiId: UUID """KPI value for the current period.""" kpiCurrentValue: Float """ KPI value for the comparison period; null or 0 when the KPI is not compared. """ kpiPreviousValue: Float """ Values of the KPI over the current period, for its chart; null for a KPI in a KPI list. """ kpiChartData: [DashboardChartSeriesValueItem!] """Goal of the KPI target; null for a KPI in a KPI list.""" kpiChartTarget: Float """ For a KPI in a KPI list, the current value minus the comparison value prorated to the elapsed part of the current period (0 when today is outside it); null for a standalone KPI. """ kpiRelativeDifference: Float } """Computed values of the KPIs of a KPI list dashboard item.""" type DashboardKpiListData implements DashboardChartId { """ Id of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items. """ id: String """Reason the item has no data; null when the data loaded.""" error: DashboardChartError """Values of the KPIs in the list, in list order.""" kpiList: [DashboardKpiData!]! } """ Value of one field of a record as shown in its preview pane; each implementing type holds the value in its own type. """ interface InterfaceFieldData { """Id of the field the value belongs to.""" fieldId: UUID! } """ Sorting of Project records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account this project is delivered for, or empty for internal projects without an external account. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Currency exchange rate list used to convert monetary fields linked to this project. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Sales user who owns this project. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Project type that classifies this project. Project types are configurable per team space and drive which form, fields and objectives apply. Sorts by fields of the related record, listed in order of priority. """ projectType: [ProjectTypeOrderByNestedInput!] """ Sales unit this project is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the related account.""" accountId: OrderByEnum """Id of the currency exchange rate list applied to this project.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the project.""" description: OrderByEnum """ Planned end date of the project. Must be on or after startDate when both are set. """ endDate: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the project owner.""" ownerId: OrderByEnum """Id of the project type that classifies this project.""" projectTypeId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: OrderByEnum """Date when the project starts.""" startDate: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. """ revenueGoal: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """ Current status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress. """ status: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related ProjectType record. Set exactly one field in each item. """ input ProjectTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). """ icon: OrderByEnum """ True when the project type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of Lead records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space. Sorts by fields of the related record, listed in order of priority. """ leadSource: [DataOrderByNestedInput!] """ Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply. Sorts by fields of the related record, listed in order of priority. """ leadType: [LeadTypeOrderByNestedInput!] """ Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it. Sorts by fields of the related record, listed in order of priority. """ reasonOfClose: [DataOrderByNestedInput!] """ Step in the lead process the lead is currently in. Sorts by fields of the related record, listed in order of priority. """ step: [StepOrderByNestedInput!] """ Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the currency exchange rate list applied to this lead.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the lead.""" description: OrderByEnum """ True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """User-set colored flag used to highlight the lead in lists and reports.""" labelFlag: OrderByEnum """ Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). """ leadSourceId: OrderByEnum """ Id of the lead type that classifies the lead and drives which form, fields and lead process apply. """ leadTypeId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the lead owner.""" ownerId: OrderByEnum """ Free-text company email captured at lead creation when no Account record has been linked yet. """ quickAccountEmail: OrderByEnum """ Free-text company name captured at lead creation when no Account record has been linked yet. """ quickAccountName: OrderByEnum """ Free-text company phone captured at lead creation when no Account record has been linked yet. """ quickAccountPhone: OrderByEnum """ Free-text contact name captured at lead creation when no Contact record has been linked yet. """ quickContactName: OrderByEnum """ Free-text contact email captured at lead creation when no Contact record has been linked yet. """ quickEmail: OrderByEnum """ Free-text contact phone captured at lead creation when no Contact record has been linked yet. """ quickPhone: OrderByEnum """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. """ ranking: OrderByEnum """ Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. """ reasonOfCloseDescription: OrderByEnum """ Id of the reason recorded when the lead is archived (lost), or empty when none was given. """ reasonOfCloseId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Id of the lead process step.""" stepId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events. """ status: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related LeadType record. Set exactly one field in each item. """ input LeadTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """True when the lost form is required on archiving leads of this type.""" formLostEnabled: OrderByEnum """ True when the lead type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Id of the lead process that leads of this type follow.""" leadProcessId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Step record. Set exactly one field in each item. """ input StepOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text description shown in the step UI.""" description: OrderByEnum """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: OrderByEnum """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: OrderByEnum """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: OrderByEnum """Id of the opportunity pipeline.""" pipelineId: OrderByEnum """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: OrderByEnum """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: OrderByEnum """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of Quote records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Currency exchange rate list used to convert monetary fields linked to this quote. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Opportunity this quote was prepared for. Empty for standalone quotes. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Sales user who owns this quote. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Product price list used to populate prices for product line items added to this quote. Empty to use catalog defaults. Sorts by fields of the related record, listed in order of priority. """ productPriceList: [ProductPriceListOrderByNestedInput!] """ Quote type that classifies this quote. Each type maps to one quote process and drives which form, fields and stages apply. Sorts by fields of the related record, listed in order of priority. """ quoteType: [QuoteTypeOrderByNestedInput!] """ Configurable reason recorded when the quote is archived (lost). Required when the lost form mandates it. Sorts by fields of the related record, listed in order of priority. """ reasonOfClose: [DataOrderByNestedInput!] """ Quote-process step the quote is currently sitting in. Reaching the last step in the process marks the quote as accepted. Sorts by fields of the related record, listed in order of priority. """ step: [StepOrderByNestedInput!] """ Sales unit this quote is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the quote.""" description: OrderByEnum """Date after which the quote is no longer considered valid.""" expirationDate: OrderByEnum """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the opportunity.""" opptyId: OrderByEnum """Id of the quote owner.""" ownerId: OrderByEnum """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: OrderByEnum """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: OrderByEnum """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: OrderByEnum """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: OrderByEnum """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: OrderByEnum """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: OrderByEnum """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: OrderByEnum """ Auto-generated sequential identifier of the quote, used for human-readable reference. """ quoteNumber: OrderByEnum """Id of the quote type that classifies this quote.""" quoteTypeId: OrderByEnum """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: OrderByEnum """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Id of the quote-process step.""" stepId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. """ totalAmount: OrderByEnum """ Current status of the quote (Open, Lost, Accepted). Read-only; derived from the current step and the archived flag. """ status: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related Opportunity record. Set exactly one field in each item. """ input OpportunityOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the quote currently synchronized with this opportunity, or empty when no quote is active. A quote can be active on only one opportunity at a time. """ activeQuoteId: OrderByEnum """Expected or actual closing date of the opportunity.""" closingDate: OrderByEnum """Id of the currency exchange rate list applied to this opportunity.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the opportunity.""" description: OrderByEnum """ True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """ True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. """ isValueAutoCalculate: OrderByEnum """ User-set colored flag used to highlight the opportunity in lists and reports. """ labelFlag: OrderByEnum """Id of the lead source the opportunity originated from.""" leadSourceId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """Id of the opportunity owner.""" ownerId: OrderByEnum """ Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. """ productPriceListId: OrderByEnum """ Free-text company email captured at opportunity creation when no Account record has been linked yet. """ quickAccountEmail: OrderByEnum """ Free-text company name captured at opportunity creation when no Account record has been linked yet. """ quickAccountName: OrderByEnum """ Free-text company phone captured at opportunity creation when no Account record has been linked yet. """ quickAccountPhone: OrderByEnum """ Free-text contact name captured at opportunity creation when no Contact record has been linked yet. """ quickContactName: OrderByEnum """ Free-text contact email captured at opportunity creation when no Contact record has been linked yet. """ quickEmail: OrderByEnum """ Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. """ quickPhone: OrderByEnum """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. """ ranking: OrderByEnum """Free-form note explaining why the opportunity was archived (lost).""" reasonOfCloseDescription: OrderByEnum """ Id of the reason of close option selected when the opportunity was archived (lost). """ reasonOfCloseId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Id of the pipeline step.""" stepId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ True when the opportunity has gone through the qualification step at least once. """ wasQualified: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. """ value: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """ Current status of the opportunity (Open, Won, Lost). Read-only; derived from the current pipeline step and the archived flag. """ status: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related ProductPriceList record. Set exactly one field in each item. """ input ProductPriceListOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-form description of the price list.""" description: OrderByEnum """Date when the price list expires. Empty means open-ended.""" endDate: OrderByEnum """ Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates. """ isActive: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Date when the price list becomes active. Empty means immediately.""" startDate: OrderByEnum """ Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled). """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ True for the team space default price list, which cannot be deleted. Read-only. """ isDefault: OrderByEnum } """ Sorting by a field of the related QuoteType record. Set exactly one field in each item. """ input QuoteTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """True when the lost form is required on archiving quotes of this type.""" formLostEnabled: OrderByEnum """ True when the quote type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the quote process that quotes of this type follow.""" quoteProcessId: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of Opportunity records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpportunityOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Quote currently used to drive the opportunity (e.g. for synchronisation of monetary fields). Empty when no quote is active. Sorts by fields of the related record, listed in order of priority. """ activeQuote: [QuoteOrderByNestedInput!] """ Currency exchange rate list used to convert monetary fields linked to this opportunity. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ How the opportunity originated (e.g. Website, Referral, Trade Show). Configurable per team space. Sorts by fields of the related record, listed in order of priority. """ leadSource: [DataOrderByNestedInput!] """ Opportunity type that classifies this opportunity. Each type maps to one pipeline and drives which form, fields and stages apply. Sorts by fields of the related record, listed in order of priority. """ opptyType: [OpportunityTypeOrderByNestedInput!] """ Sales user who owns this opportunity. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Product price list used to populate prices for product line items added to this opportunity. Empty to use catalog defaults. Sorts by fields of the related record, listed in order of priority. """ productPriceList: [ProductPriceListOrderByNestedInput!] """ Configurable reason recorded when the opportunity is archived (lost). Required when the lost form mandates it. Sorts by fields of the related record, listed in order of priority. """ reasonOfClose: [DataOrderByNestedInput!] """ Pipeline step the opportunity is currently sitting in. Reaching the last step in the pipeline marks the opportunity as won; archiving sets it to lost. Sorts by fields of the related record, listed in order of priority. """ step: [StepOrderByNestedInput!] """ Sales unit this opportunity is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """ Id of the quote currently synchronized with this opportunity, or empty when no quote is active. A quote can be active on only one opportunity at a time. """ activeQuoteId: OrderByEnum """Expected or actual closing date of the opportunity.""" closingDate: OrderByEnum """Id of the currency exchange rate list applied to this opportunity.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the opportunity.""" description: OrderByEnum """ True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """ True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. """ isValueAutoCalculate: OrderByEnum """ User-set colored flag used to highlight the opportunity in lists and reports. """ labelFlag: OrderByEnum """Id of the lead source the opportunity originated from.""" leadSourceId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """Id of the opportunity owner.""" ownerId: OrderByEnum """ Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. """ productPriceListId: OrderByEnum """ Free-text company email captured at opportunity creation when no Account record has been linked yet. """ quickAccountEmail: OrderByEnum """ Free-text company name captured at opportunity creation when no Account record has been linked yet. """ quickAccountName: OrderByEnum """ Free-text company phone captured at opportunity creation when no Account record has been linked yet. """ quickAccountPhone: OrderByEnum """ Free-text contact name captured at opportunity creation when no Contact record has been linked yet. """ quickContactName: OrderByEnum """ Free-text contact email captured at opportunity creation when no Contact record has been linked yet. """ quickEmail: OrderByEnum """ Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. """ quickPhone: OrderByEnum """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. """ ranking: OrderByEnum """Free-form note explaining why the opportunity was archived (lost).""" reasonOfCloseDescription: OrderByEnum """ Id of the reason of close option selected when the opportunity was archived (lost). """ reasonOfCloseId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Id of the pipeline step.""" stepId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ True when the opportunity has gone through the qualification step at least once. """ wasQualified: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. """ value: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """ Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. Sorts by fields of the related record, listed in order of priority. """ opptyRecurrence: [OpptyRecurrenceOrderByNestedInput!] """ Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. Sorts by fields of the related record, listed in order of priority. """ revenueSchedule: [OpptyRevenueScheduleOrderByNestedInput!] """ Current status of the opportunity (Open, Won, Lost). Read-only; derived from the current pipeline step and the archived flag. """ status: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related Quote record. Set exactly one field in each item. """ input QuoteOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the quote.""" description: OrderByEnum """Date after which the quote is no longer considered valid.""" expirationDate: OrderByEnum """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the opportunity.""" opptyId: OrderByEnum """Id of the quote owner.""" ownerId: OrderByEnum """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: OrderByEnum """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: OrderByEnum """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: OrderByEnum """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: OrderByEnum """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: OrderByEnum """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: OrderByEnum """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: OrderByEnum """ Auto-generated sequential identifier of the quote, used for human-readable reference. """ quoteNumber: OrderByEnum """Id of the quote type that classifies this quote.""" quoteTypeId: OrderByEnum """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: OrderByEnum """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Id of the quote-process step.""" stepId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. """ totalAmount: OrderByEnum """ Current status of the quote (Open, Lost, Accepted). Read-only; derived from the current step and the archived flag. """ status: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related OpportunityType record. Set exactly one field in each item. """ input OpportunityTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the opportunity type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the pipeline this opportunity type drives.""" pipelineId: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related OpptyRecurrence record. Set exactly one field in each item. """ input OpptyRecurrenceOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: OrderByEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: OrderByEnum """ Date information. The last date when no more other items should be created. """ endDate: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: OrderByEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: OrderByEnum """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: OrderByEnum """Id of the parent opportunity.""" opptyId: OrderByEnum """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: OrderByEnum """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: OrderByEnum """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related OpptyRevenueSchedule record. Set exactly one field in each item. """ input OpptyRevenueScheduleOrderByNestedInput { """Unique identifier of entity. Must match with Opportunity id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: OrderByEnum """Number of periods the opportunity value is split into.""" periodCount: OrderByEnum """Date when revenue recognition for the opportunity begins.""" startDate: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of CustomEntity records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CustomEntityOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Sales user who owns this custom entity record. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records. Sorts by fields of the related record, listed in order of priority. """ type: [CustomEntityTypeOrderByNestedInput!] """ Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the currency exchange rate list applied to this record.""" currencyExchangeRatesListId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the sales user who owns the custom entity record.""" ownerId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: OrderByEnum """Id of the custom entity type.""" typeId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related CustomEntityType record. Set exactly one field in each item. """ input CustomEntityTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the custom entity type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum } """Paginated list of MemoComment records.""" type MemoCommentEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MemoCommentEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `MemoCommentEntity` and its cursor.""" type MemoCommentEntityEdge { """The item at the end of the edge""" node: MemoCommentEntity """A cursor for use in pagination""" cursor: String! } """Comment a user wrote on a memo.""" type MemoCommentEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Memo this comment belongs to.""" memo: MemoEntity """User who authored the comment.""" owner: ClientEntity """Free-form text body of the comment.""" comment: String! """Id of the memo this comment belongs to.""" memoId: ID! """Id of the comment author.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of MemoComment records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input MemoCommentOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Memo this comment belongs to. Sorts by fields of the related record, listed in order of priority. """ memo: [MemoOrderByNestedInput!] """ User who authored the comment. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Free-form text body of the comment.""" comment: OrderByEnum """Id of the memo this comment belongs to.""" memoId: OrderByEnum """Id of the comment author.""" ownerId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Memo record. Set exactly one field in each item. """ input MemoOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the memo author.""" ownerId: OrderByEnum """Short summary line of the memo.""" subject: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of EmailContentSharingSalesUnitRelation records.""" type EmailContentSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailContentSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EmailContentSharingSalesUnitRelationEntity` and its cursor. """ type EmailContentSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: EmailContentSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """ Sharing of the body of an email with a sales unit, letting its members read its content. """ type EmailContentSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Email whose body is being shared.""" email: EmailEntity """Sales unit granted access to the email body.""" unit: SalesUnitEntity """Id of the email whose body is shared with the sales unit.""" emailId: ID! """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of EmailContentSharingClientRelation records.""" type EmailContentSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailContentSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EmailContentSharingClientRelationEntity` and its cursor. """ type EmailContentSharingClientRelationEntityEdge { """The item at the end of the edge""" node: EmailContentSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """ Sharing of the body of an email with a user, letting them read its content. """ type EmailContentSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User granted access to the email body.""" client: ClientEntity """Email whose body is being shared.""" email: EmailEntity """Id of the user.""" clientId: ID! """Id of the email whose body is shared with the user.""" emailId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Tracking event of a sent email, such as an open, a link click or an unsubscribe. """ type EmailTrackingEvent { """Kind of event: sent, opened, clicked or unsubscribed.""" type: EmailTrackingEventTypeEnum! """Time the event happened.""" modified: DateTime! """Link the recipient clicked, for a click event.""" url: String } """Type of an entry in an email's tracking history.""" enum EmailTrackingEventTypeEnum { """The email was sent.""" Sent """The recipient opened the email.""" Opened """The recipient clicked a link in the email; url holds the link.""" Clicked """The recipient unsubscribed through the email.""" Unsubscribed } """Paginated list of MassEmailRelation items.""" type MassEmailRelationItemConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MassEmailRelationItemEdge]! """Total number of results in the view""" totalCount: Int! } """A Relay edge containing a `MassEmailRelationItem` and its cursor.""" type MassEmailRelationItemEdge { """The item at the end of the edge""" node: MassEmailRelation """A cursor for use in pagination""" cursor: String! } """ Recipient of a mass email: the account or contact the individual email went to, and its delivery and reply state. """ type MassEmailRelation { """ Id of the account or contact the email was sent to; empty when the recipient is not linked to a record. """ id: ID """Whether the recipient record is an Account or a Contact.""" entityType: EntityNameEnum """Name of the recipient record; empty when `isAvailable` is false.""" name: String """URL of the picture of the recipient record.""" pictureUrl: String """Id of the individual email sent to this recipient.""" emailId: ID! """Address the email was sent to; empty when `isAvailable` is false.""" primaryEmail: String """ Name of the owner of the recipient record; empty when `isAvailable` is false. """ ownerName: String """False when the caller cannot see the recipient record.""" isAvailable: Boolean! """Number of emails in the conversation of this email.""" itemsInConversationCount: Int! """ Error code recorded when the email failed to send; zero when it was sent. """ errorCode: Int! """True when the email was sent.""" wasSent: Boolean! """True when the email bounced.""" wasBounced: Boolean! """Tags of the latest reply received in the conversation.""" tags: [FeedTag]! """Sentiment of the latest reply received in the conversation.""" sentiment: EmailSentimentEnum } """Tag shown on a feed item, with its name and color.""" type FeedTag { """Id of the tag.""" id: ID! """Name of the tag.""" name: String! """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int! } """ Group of mass-email recipients to list, by what happened to their copy of the email. """ enum MassEmailRelationCategory { """All recipients.""" All """ Recipients who opened the email (or clicked or unsubscribed) and whose copy did not bounce. """ Opened """ Recipients who clicked a link in the email and whose copy did not bounce. """ Clicked """Recipients who replied to the email.""" Replied """Recipients whose email was sent but not opened.""" NotOpened """Recipients whose email has not been sent yet.""" NotSent """Recipients who unsubscribed through the email.""" Unsubscribed """Recipients whose email bounced permanently.""" Bounced } """Column by which the recipients of a mass email are sorted.""" enum MassEmailDetailGridSortyBy { """Recipient name (default).""" Name """Recipient email address.""" Email """Name of the owner of the recipient account or contact.""" Owner """Number of emails in the conversation thread with the recipient.""" EmailCountInThread } """Paginated list of Email records.""" type EmailConversationItemConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailConversationItemEdge]! """Total number of results.""" totalCount: Int! } """A Relay edge containing a `EmailConversationItem` and its cursor.""" type EmailConversationItemEdge { """The item at the end of the edge""" node: EmailEntity """A cursor for use in pagination""" cursor: String! } """ One email of a conversation, as listed in the conversation of an email. """ type EmailConversationItem { """Id of the email.""" id: UUID! """ True when the caller can read the content of this email; otherwise `bodySummary` is empty. """ isContentAvailable: Boolean! """Plain-text summary of the email body.""" bodySummary: String """Time the email was created.""" created: DateTime """ Time the email was sent; empty for drafts and scheduled emails not yet sent. """ dateSent: DateTime """ Time a scheduled email is queued to be sent; empty for emails sent immediately. """ sendAt: DateTime """True when at least one file is attached to the email.""" hasAnyAttachment: Boolean! """True when the email is an unsent draft.""" isDraft: Boolean! """ For a draft reply, the id of the email it replies to; the draft is listed right after that email. """ draftParentEmailId: UUID """True when the caller marked the email as a favorite.""" isFavorite: Boolean! """ True when another user created this email and the given mailbox is not a company mailbox the caller can use. Always false without `mailboxId`. """ isDifferentActor: Boolean! """Sender address as it appeared on the email.""" sender: String """Id of the user matched as the sender.""" senderClientId: UUID """Account matched as the sender; empty when there is none.""" senderAccount: EmailConversationSenderAccount """User matched as the sender; empty when there is none.""" senderClient: EmailConversationSenderClient """Contact matched as the sender; empty when there is none.""" senderContact: EmailConversationSenderContact } """ Account recognized as the sender of a message in an email conversation. """ type EmailConversationSenderAccount { """Name of the account.""" name: String """Picture of the account.""" picture: EmailConversationPicture } """Picture of the sender of a conversation item.""" type EmailConversationPicture { """URL of the picture; empty when there is none.""" url: String } """User recognized as the sender of a message in an email conversation.""" type EmailConversationSenderClient { """Id of the user.""" id: UUID """Email address of the user.""" email: String """First name of the user.""" firstName: String """True when the user has been deleted.""" isDeleted: Boolean """Last name of the user.""" lastName: String """Middle name of the user.""" middleName: String """URL of the profile picture of the user.""" pictureUrl: String } """ Contact recognized as the sender of a message in an email conversation. """ type EmailConversationSenderContact { """First name of the contact.""" firstName: String """Last name of the contact.""" lastName: String """Middle name of the contact.""" middleName: String """Title of the contact.""" title: String """Picture of the contact.""" picture: EmailConversationPicture } """ Record an email is linked to in a mailbox, such as its sender or a recipient, or an email address not matched to any record. """ type EmailEntityLinkedRecord { """ Id of the linked record; empty for an email address not matched to any record. """ id: UUID """Type of the linked record; empty for an unmatched email address.""" entity: EntityNameEnum """API name of the custom entity when the record is a custom entity.""" entityApiName: String """False when the caller cannot see the linked record.""" isAvailable: Boolean! """ Name of the linked record, or the email address when it is not matched. """ name: String } """Paginated list of EmailLabelRelation records.""" type EmailLabelRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailLabelRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EmailLabelRelationEntity` and its cursor.""" type EmailLabelRelationEntityEdge { """The item at the end of the edge""" node: EmailLabelRelationEntity """A cursor for use in pagination""" cursor: String! } """Email label applied to a conversation in a mailbox.""" type EmailLabelRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Label applied to the thread by this relation.""" emailLabel: EmailLabelEntity """ Sales user who owns this relation. Derived from the label's owner on write. """ owner: ClientEntity """Id of the applied label.""" emailLabelId: ID! """ Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes. """ mailboxId: ID! """Id of the relation owner.""" ownerId: ID """ Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label. """ threadId: ID! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Personal label a user applies to email conversations to organize their mailbox; labels can be nested. """ type EmailLabelEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Client who created this label; labels are personal and not shared with teammates. """ owner: ClientEntity """Parent label this one is nested under, or empty for a top-level label.""" parentEmailLabel: EmailLabelEntity """Color the label is displayed with, as a packed RGB integer.""" color: Int! """Name of the entity and its default text representation.""" name: String! """Id of the client who created this label.""" ownerId: ID! """ Id of the parent label this one is nested under, or empty for a top-level label. """ parentEmailLabelId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of OnlineFormRelation records.""" type OnlineFormRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OnlineFormRelationEntity` and its cursor.""" type OnlineFormRelationEntityEdge { """The item at the end of the edge""" node: OnlineFormRelationEntity """A cursor for use in pagination""" cursor: String! } """ Link between an online form submission and a record it created or updated. """ type OnlineFormRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account the submission is linked to, when applicable.""" account: AccountEntity """Contact the submission is linked to, when applicable.""" contact: ContactEntity """Custom entity record the submission is linked to, when applicable.""" customEntity: CustomEntityEntity """ Lead the submission is linked to. Set when leadOpptyId resolves to a Lead. """ lead: LeadEntity """ Opportunity the submission is linked to. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """Online form submission being linked.""" onlineForm: OnlineFormEntity """Project the submission is linked to, when applicable.""" project: ProjectEntity """Quote the submission is linked to, when applicable.""" quote: QuoteEntity """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType. """ isPrimary: Boolean! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the submission.""" onlineFormId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of OnlineFormActivityLogLine records.""" type OnlineFormActivityLogLineEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormActivityLogLineEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OnlineFormActivityLogLineEntity` and its cursor. """ type OnlineFormActivityLogLineEntityEdge { """The item at the end of the edge""" node: OnlineFormActivityLogLineEntity """A cursor for use in pagination""" cursor: String! } """One step logged while processing an online form submission.""" type OnlineFormActivityLogLineEntity { """ Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id. """ formattedText: String! """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Online form submission this log line belongs to.""" onlineForm: OnlineFormEntity """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the submission.""" onlineFormId: ID! """Position of the line within its log run.""" sortOrder: Int! """ Result of the processing step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of OnlineFormActivityLogLine records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OnlineFormActivityLogLineOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Online form submission this log line belongs to. Sorts by fields of the related record, listed in order of priority. """ onlineForm: [OnlineFormOrderByNestedInput!] """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: OrderByEnum """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: OrderByEnum """Id of the submission.""" onlineFormId: OrderByEnum """Position of the line within its log run.""" sortOrder: OrderByEnum """ Result of the processing step recorded by this line, such as Ok, Warning or Error. """ status: OrderByEnum } """ Sorting by a field of the related OnlineForm record. Set exactly one field in each item. """ input OnlineFormOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the currency exchange rate list applied to product line items at submission time. """ currencyExchangeRatesListId: OrderByEnum """Id of the linked email record, when available.""" emailId: OrderByEnum """Id of the online form definition.""" onlineFormTypeId: OrderByEnum """Id of the selected price list.""" productPriceListId: OrderByEnum """ Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. """ status: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format. """ recordName: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """Answer to one question of an online form submission.""" type OnlineFormFieldAnswer { """Id of the form field the answer belongs to.""" id: String! """ Answer as text: option labels for choice fields, a download URL for uploaded files; null when not answered. """ value: String } """ Revenue schedule that splits the amount of a product line item into periods. """ type OpptyProductRelationRevenueScheduleEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity. Must match with OpptyProductRelation id.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: Date """Number of periods the line-item amount is split into.""" periodCount: Int """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnum """Date when revenue recognition for this product line begins.""" startDate: Date """Revision when entity was lastly changed.""" revision: Int """Periods produced by this revenue schedule, ordered by date.""" periods( """ Filter OpptyProductRelationRevenueSchedulePeriod relations by target OpptyProductRelationRevenueSchedulePeriod attributes. """ filter: OpptyProductRelationRevenueSchedulePeriodFilterInput """ Order OpptyProductRelationRevenueSchedulePeriod relations by target OpptyProductRelationRevenueSchedulePeriod attributes. """ orderBy: [OpptyProductRelationRevenueSchedulePeriodOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationRevenueSchedulePeriodEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of OpptyProductRelationRevenueSchedulePeriod records.""" type OpptyProductRelationRevenueSchedulePeriodEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyProductRelationRevenueSchedulePeriodEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OpptyProductRelationRevenueSchedulePeriodEntity` and its cursor. """ type OpptyProductRelationRevenueSchedulePeriodEntityEdge { """The item at the end of the edge""" node: OpptyProductRelationRevenueSchedulePeriodEntity """A cursor for use in pagination""" cursor: String! } """ One period of a product line item revenue schedule, with its date and amount. """ type OpptyProductRelationRevenueSchedulePeriodEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent revenue schedule this period belongs to.""" opptyProductRelationRevenueSchedule: OpptyProductRelationRevenueScheduleEntity """Recognition date of this period.""" date: Date """Id of the parent revenue schedule.""" opptyProductRelationRevenueScheduleId: ID! """Identifier linking the period to the recognition transaction.""" transactionId: ID! """Amount recognised in this period.""" value: Float """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of OpptyProductRelationRevenueSchedulePeriod records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyProductRelationRevenueSchedulePeriodOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Parent revenue schedule this period belongs to. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelationRevenueSchedule: [OpptyProductRelationRevenueScheduleOrderByNestedInput!] """Recognition date of this period.""" date: OrderByEnum """Id of the parent revenue schedule.""" opptyProductRelationRevenueScheduleId: OrderByEnum """Amount recognised in this period.""" value: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related OpptyProductRelationRevenueSchedule record. Set exactly one field in each item. """ input OpptyProductRelationRevenueScheduleOrderByNestedInput { """Unique identifier of entity. Must match with OpptyProductRelation id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: OrderByEnum """Number of periods the line-item amount is split into.""" periodCount: OrderByEnum """Date when revenue recognition for this product line begins.""" startDate: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of QuoteContactRelation records.""" type QuoteContactRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteContactRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `QuoteContactRelationEntity` and its cursor.""" type QuoteContactRelationEntityEdge { """The item at the end of the edge""" node: QuoteContactRelationEntity """A cursor for use in pagination""" cursor: String! } """Link between a quote and a contact, marking the primary contact.""" type QuoteContactRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact linked to the quote.""" contact: ContactEntity """Quote the contact is linked to.""" quote: QuoteEntity """Id of the contact linked to this quote.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the quote the contact is linked to.""" quoteId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of QuoteAccountRelation records.""" type QuoteAccountRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteAccountRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `QuoteAccountRelationEntity` and its cursor.""" type QuoteAccountRelationEntityEdge { """The item at the end of the edge""" node: QuoteAccountRelationEntity """A cursor for use in pagination""" cursor: String! } """Link between a quote and an account, marking the primary account.""" type QuoteAccountRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account linked to the quote.""" account: AccountEntity """Quote the account is linked to.""" quote: QuoteEntity """Id of the account linked to this quote.""" accountId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the quote the account is linked to.""" quoteId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of QuoteSharingSalesUnitRelation records.""" type QuoteSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `QuoteSharingSalesUnitRelationEntity` and its cursor. """ type QuoteSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: QuoteSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Share of a quote with a sales unit, with the access level granted.""" type QuoteSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Quote being shared.""" quote: QuoteEntity """Sales unit the quote is shared with.""" unit: SalesUnitEntity """Id of the shared quote.""" quoteId: ID! """ Access the sharing gives the sales unit on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of QuoteSharingClientRelation records.""" type QuoteSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `QuoteSharingClientRelationEntity` and its cursor. """ type QuoteSharingClientRelationEntityEdge { """The item at the end of the edge""" node: QuoteSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """ Share of a quote with an individual user, with the access level granted. """ type QuoteSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the quote is shared with.""" client: ClientEntity """Quote being shared.""" quote: QuoteEntity """Id of the user.""" clientId: ID! """Id of the shared quote.""" quoteId: ID! """ Access the sharing gives the user on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Completion state of one step checklist item for a lead, opportunity or quote. """ type StepChecklistActivityItem { """Id of the step checklist item.""" stepChecklistId: ID! """ Id of the record's entry for this checklist item, which holds its checked state and the linked activity, note, email or file; null for items evaluated from field values, processes, email sequences or sales roles. """ stepChecklistRelationId: ID """Id of the task or appointment linked to the item; null when none.""" activityId: ID """Id of the note linked to the item; null when none.""" noteId: ID """Id of the email linked to the item; null when none.""" emailId: ID """Id of the document linked to the item; null when none.""" cloudObjectId: ID """True when the item was checked off on the record.""" itemChecked: Boolean! """ True when the item is fulfilled for the record: checked off, or its activity, field value, email, document or process requirement is met. """ isComplete: Boolean! } """ Recurrence rule that creates new copies of an opportunity on a schedule, e.g. for repeat deals once it is won or lost. """ type OpptyRecurrenceEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Opportunity this recurrence belongs to. Each recurrence is bound to exactly one opportunity. """ oppty: OpportunityEntity """Pipeline step that newly generated opportunities are placed in.""" step: StepEntity "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: Int """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """Id of the parent opportunity.""" opptyId: ID! """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date! """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: ID! """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Revenue schedule that splits the value of an opportunity into periods.""" type OpptyRevenueScheduleEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity. Must match with Opportunity id.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: Date """Number of periods the opportunity value is split into.""" periodCount: Int """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnum """Date when revenue recognition for the opportunity begins.""" startDate: Date """Revision when entity was lastly changed.""" revision: Int """Periods produced by this revenue schedule, ordered by date.""" periods( """ Filter OpptyRevenueSchedulePeriod relations by target OpptyRevenueSchedulePeriod attributes. """ filter: OpptyRevenueSchedulePeriodFilterInput """ Order OpptyRevenueSchedulePeriod relations by target OpptyRevenueSchedulePeriod attributes. """ orderBy: [OpptyRevenueSchedulePeriodOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyRevenueSchedulePeriodEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of OpptyRevenueSchedulePeriod records.""" type OpptyRevenueSchedulePeriodEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyRevenueSchedulePeriodEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OpptyRevenueSchedulePeriodEntity` and its cursor. """ type OpptyRevenueSchedulePeriodEntityEdge { """The item at the end of the edge""" node: OpptyRevenueSchedulePeriodEntity """A cursor for use in pagination""" cursor: String! } """ One period of an opportunity revenue schedule, with its date and amount. """ type OpptyRevenueSchedulePeriodEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent revenue schedule this period belongs to.""" opptyRevenueSchedule: OpptyRevenueScheduleEntity """Recognition date of this period.""" date: Date """Id of the parent revenue schedule.""" opptyRevenueScheduleId: ID! """Identifier linking the period to the recognition transaction.""" transactionId: ID! """Amount recognised in this period.""" value: Float """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of OpptyRevenueSchedulePeriod records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyRevenueSchedulePeriodOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Parent revenue schedule this period belongs to. Sorts by fields of the related record, listed in order of priority. """ opptyRevenueSchedule: [OpptyRevenueScheduleOrderByNestedInput!] """Recognition date of this period.""" date: OrderByEnum """Id of the parent revenue schedule.""" opptyRevenueScheduleId: OrderByEnum """Amount recognised in this period.""" value: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of LeadOpptyContactRelation records.""" type LeadOpptyContactRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyContactRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptyContactRelationEntity` and its cursor. """ type LeadOpptyContactRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptyContactRelationEntity """A cursor for use in pagination""" cursor: String! } """ Link between a lead or opportunity and a contact, with the contact's sales roles and org-chart position. """ type LeadOpptyContactRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact linked to the lead or opportunity.""" contact: ContactEntity """ Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. """ leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity """ Lead the contact is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity the contact is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """Free-form note describing this contact link.""" comment: String """Id of the contact linked to the lead or opportunity.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: ID """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID! """ Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the contact for this lead or opportunity.""" salesRoles: [LeadOpptyContactSalesRoleRelationEntity!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Group of contacts on the org chart of a lead or opportunity.""" type LeadOpptyContactGroupRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Lead this contact group belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity this contact group belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """ Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """ Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }. """ groupPosition: JSONString! """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: ID! """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Sales role assigned to a contact on a lead or opportunity.""" type LeadOpptyContactSalesRoleRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Lead/opportunity-contact link this sales-role assignment belongs to.""" leadOpptyContactRelation: LeadOpptyContactRelationEntity """Sales role assigned to the contact on this lead or opportunity.""" salesRole: SalesRoleEntity """Id of the lead/opportunity-contact link.""" leadOpptyContactRelationId: ID """ Id of the sales role assigned to the contact on this lead or opportunity. """ salesRoleId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Role a contact plays in a deal (e.g. decision maker), assigned to contacts on leads and opportunities. """ type SalesRoleEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ colorCode: Int! """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of LeadOpptyAccountRelation records.""" type LeadOpptyAccountRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyAccountRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptyAccountRelationEntity` and its cursor. """ type LeadOpptyAccountRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptyAccountRelationEntity """A cursor for use in pagination""" cursor: String! } """ Link between a lead or opportunity and an account, marking the primary account. """ type LeadOpptyAccountRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account linked to the lead or opportunity.""" account: AccountEntity """ Lead the account is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity the account is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """Id of the account linked to the lead or opportunity.""" accountId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of Quote records.""" type QuoteEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `QuoteEntity` and its cursor.""" type QuoteEntityEdge { """The item at the end of the edge""" node: QuoteEntity """A cursor for use in pagination""" cursor: String! } """Paginated list of LeadOpptySharingSalesUnitRelation records.""" type LeadOpptySharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptySharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptySharingSalesUnitRelationEntity` and its cursor. """ type LeadOpptySharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptySharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """ Share of a lead or opportunity with a sales unit, with the access level granted. """ type LeadOpptySharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """Sales unit the lead or opportunity is shared with.""" unit: SalesUnitEntity """Id of the lead or opportunity being shared.""" leadOpptyId: ID! """ Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of LeadOpptySharingClientRelation records.""" type LeadOpptySharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptySharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptySharingClientRelationEntity` and its cursor. """ type LeadOpptySharingClientRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptySharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """ Share of a lead or opportunity with an individual user, with the access level granted. """ type LeadOpptySharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the lead or opportunity is shared with.""" client: ClientEntity """ Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """Id of the user.""" clientId: ID! """Id of the lead or opportunity being shared.""" leadOpptyId: ID! """ Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Fitness of a lead or opportunity: its overall warning level and the indicators that apply to it. """ type FitnessDescription { """True when the opportunity is won; always false for leads.""" isWon: Boolean! """True when the record is archived.""" isArchived: Boolean! """ Overall fitness of the record: the most severe level among its indicators, Ok when there are none. """ fitness: WarningLevelEnum! """ Fitness indicators that apply to the record with their current level, most severe first. """ indicators: [FitnessDescriptionIndicator!]! } """Current warning level of one fitness indicator for a record.""" type FitnessDescriptionIndicator { """Level the indicator currently reports for the record.""" fitness: WarningLevelEnum! """Fitness indicator that is evaluated.""" indicator: EntityFitnessIndicatorEntity! } """ Indicator of a fitness configuration: a rule that flags lead or opportunity records needing attention and suggests how to fix them. """ type EntityFitnessIndicatorEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Fitness configuration this indicator belongs to.""" entityFitness: EntityFitnessEntity """Description of what the indicator measures, shown in the UI.""" description: String! """ When true, description is treated as a translation key and localized in the UI. """ descriptionUseLang: Boolean! """Id of the fitness configuration.""" entityFitnessId: ID! """ Suggested remediation text shown to the user when a record triggers this indicator. """ howToFix: String! """ When true, howToFix is treated as a translation key and localized in the UI. """ howToFixUseLang: Boolean! """When false, the indicator is configured but not evaluated for records.""" isEnabled: Boolean! """Display name of the indicator.""" name: String! """ When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ nameUseLang: Boolean! """ Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules. This payload conforms to the `FitnessIndicatorSettings` JSON Schema: GET /api/v100/rest/schemas/FitnessIndicatorSettings.json on your region's API host """ settings: FitnessIndicatorSettings! """ Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. """ type: FitnessIndicatorTypeEnum! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Fitness configuration of a lead or opportunity type: the indicators that flag records of that type needing attention. """ type EntityFitnessEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Lead type this fitness configuration applies to. Set when configuring fitness for leads. """ leadType: LeadTypeEntity """ Opportunity type this fitness configuration applies to. Set when configuring fitness for opportunities. """ opptyType: OpportunityTypeEntity """ Id of the lead type this fitness configuration applies to. Set when configuring fitness for leads. """ leadTypeId: ID """Id of the opportunity type.""" opptyTypeId: ID """Revision when entity was lastly changed.""" revision: Int """ Fitness indicators (system or custom rules) defined for this configuration. """ indicatorRelations( """ Filter EntityFitnessIndicator relations by target EntityFitnessIndicator attributes. """ filter: EntityFitnessIndicatorFilterInput """ Order EntityFitnessIndicator relations by target EntityFitnessIndicator attributes. """ orderBy: [EntityFitnessIndicatorOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EntityFitnessIndicatorEntityConnection """ Id of the lead or opportunity type this fitness configuration applies to. """ entityTypeId: UUID! """ Entity kind this fitness configuration applies to (Lead or Opportunity). Derived from whichever of leadType/opptyType is set. """ entityType: BaseEntityTypeEnum! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of EntityFitnessIndicator records.""" type EntityFitnessIndicatorEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EntityFitnessIndicatorEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `EntityFitnessIndicatorEntity` and its cursor. """ type EntityFitnessIndicatorEntityEdge { """The item at the end of the edge""" node: EntityFitnessIndicatorEntity """A cursor for use in pagination""" cursor: String! } """ Filter conditions for EntityFitnessIndicator records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EntityFitnessIndicatorFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EntityFitnessIndicatorFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EntityFitnessIndicatorFilterInput!] """Matches records that do not meet this filter.""" NOT: EntityFitnessIndicatorFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Description of what the indicator measures, shown in the UI.""" description: EntityFilterStringField """ When true, description is treated as a translation key and localized in the UI. """ descriptionUseLang: Boolean """Id of the fitness configuration.""" entityFitnessId: EntityFilterStringField """ Suggested remediation text shown to the user when a record triggers this indicator. """ howToFix: EntityFilterStringField """ When true, howToFix is treated as a translation key and localized in the UI. """ howToFixUseLang: Boolean """When false, the indicator is configured but not evaluated for records.""" isEnabled: Boolean """Display name of the indicator.""" name: EntityFilterStringField """ When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ nameUseLang: Boolean """ Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. """ type: FitnessIndicatorTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Fitness configuration this indicator belongs to. Matches records where a related record meets these conditions. """ entityFitness: EntityFitnessFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input FitnessIndicatorTypeEnumFilterInput { """Matches any of the listed values.""" eq: [FitnessIndicatorTypeEnum!] """Matches values that do not meet this condition.""" NOT: FitnessIndicatorTypeEnumFilterInput } """ Rule a lead or opportunity fitness indicator evaluates to raise a warning. """ enum FitnessIndicatorTypeEnum { """ User-defined filter conditions; each matching condition sets its configured warning level. """ Custom """ Too few emails sent to the record, its accounts or contacts within the configured number of days. """ LowEmailOutreach """ Too few emails received from the record, its accounts or contacts within the configured number of days. """ LowEmailEngagement """ A related task is overdue by the configured number of days, optionally limited to selected task types. """ TasksOverdue """ The record has no scheduled activity, optionally limited to selected activity types. """ NoFollowUp """The opportunity's closing date is in the past.""" ClosingDateOverdue """ The opportunity has stayed in its current sales step longer than the step's time frame. """ SalesStepVelocityOverdue """The opportunity is older than the configured number of days.""" SalesCycleOverdue """ The opportunity's closing date has been changed at least the configured number of times. """ ManyClosingDateUpdates """ The opportunity was moved back to an earlier sales step than one it had already reached. """ MovedToPreviousStep """The opportunity's ranking decreased within the configured period.""" RankingDecrease """ The opportunity's value decreased within the configured period, by amount or percentage. """ ValueDecrease } """ Filter conditions for EntityFitness records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EntityFitnessFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EntityFitnessFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EntityFitnessFilterInput!] """Matches records that do not meet this filter.""" NOT: EntityFitnessFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the lead type this fitness configuration applies to. Set when configuring fitness for leads. """ leadTypeId: EntityFilterStringField """Id of the opportunity type.""" opptyTypeId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Id of the lead or opportunity type this fitness configuration applies to. """ entityTypeId: UUID """ Entity kind this fitness configuration applies to (Lead or Opportunity). Derived from whichever of leadType/opptyType is set. """ entityType: BaseEntityTypeEnum """ Lead type this fitness configuration applies to. Set when configuring fitness for leads. Matches records where a related record meets these conditions. """ leadType: LeadTypeFilterInput """ Opportunity type this fitness configuration applies to. Set when configuring fitness for opportunities. Matches records where a related record meets these conditions. """ opptyType: OpportunityTypeFilterInput """ Fitness indicators (system or custom rules) defined for this configuration. Matches records where a related record meets these conditions. """ indicatorRelations: EntityFitnessIndicatorFilterInput } """ Sorting of EntityFitnessIndicator records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EntityFitnessIndicatorOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Fitness configuration this indicator belongs to. Sorts by fields of the related record, listed in order of priority. """ entityFitness: [EntityFitnessOrderByNestedInput!] """Description of what the indicator measures, shown in the UI.""" description: OrderByEnum """ When true, description is treated as a translation key and localized in the UI. """ descriptionUseLang: OrderByEnum """Id of the fitness configuration.""" entityFitnessId: OrderByEnum """ Suggested remediation text shown to the user when a record triggers this indicator. """ howToFix: OrderByEnum """ When true, howToFix is treated as a translation key and localized in the UI. """ howToFixUseLang: OrderByEnum """When false, the indicator is configured but not evaluated for records.""" isEnabled: OrderByEnum """Display name of the indicator.""" name: OrderByEnum """ When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ nameUseLang: OrderByEnum """ Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related EntityFitness record. Set exactly one field in each item. """ input EntityFitnessOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the lead type this fitness configuration applies to. Set when configuring fitness for leads. """ leadTypeId: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of EmailSequenceEnrolled records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailSequenceEnrolledOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account that was enrolled, when the trigger entity is an Account; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ User who triggered the enrolment, or empty for runs triggered by automation. Sorts by fields of the related record, listed in order of priority. """ actor: [ClientOrderByNestedInput!] """ Application context the enrolment was triggered in. Sorts by fields of the related record, listed in order of priority. """ application: [ApplicationOrderByNestedInput!] """ Contact that was enrolled, when the trigger entity is a Contact; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Activity log run that produced this enrolment. Sorts by fields of the related record, listed in order of priority. """ emailSequenceActivityLog: [EmailSequenceActivityLogOrderByNestedInput!] """ Email sequence this enrolment belongs to. Sorts by fields of the related record, listed in order of priority. """ emailSequence: [EmailSequenceOrderByNestedInput!] """ Lead that was enrolled, when the trigger entity is a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Project that was enrolled, when the trigger entity is a Project; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """Id of the enrolled account.""" accountId: OrderByEnum """ Id of the user who triggered the enrolment, or empty for runs triggered by automation. """ actorId: OrderByEnum """ Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in. """ applicationId: OrderByEnum """Id of the enrolled contact.""" contactId: OrderByEnum """Id of the activity log run that produced this enrolment.""" emailSequenceActivityLogId: OrderByEnum """Id of the email sequence this enrolment belongs to.""" emailSequenceId: OrderByEnum """ Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active. """ endReason: OrderByEnum """ Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active. """ endTime: OrderByEnum """ True when this enrolment is excluded from sequence statistics (e.g. after a stats reset). """ excludedFromStats: OrderByEnum """Id of the enrolled lead.""" leadId: OrderByEnum """Id of the enrolled opportunity.""" opptyId: OrderByEnum """Id of the enrolled project.""" projectId: OrderByEnum """Timestamp when the enrolment started.""" startTime: OrderByEnum """Number of steps the enrolment has reached. Read-only.""" stepCount: OrderByEnum """ Display name of the enrolled record, formatted according to the calling user's preferred name format. Empty when the underlying record has been deleted. """ name: OrderByEnum """Email address used for delivery of this enrolment.""" address: OrderByEnum """ Zero-based index of the next step the enrolment will execute (i.e. one past the highest stepIndex recorded in EmailSequenceEnrolledStatus). Empty before the first step runs. """ stepIndex: OrderByEnum """ Status of the enrolment's most recent sequence run (e.g. Ok, Warning, Error). Empty before the first run. """ status: OrderByEnum """ Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entityType. """ entityName: OrderByEnum } """ Sorting by a field of the related Contact record. Set exactly one field in each item. """ input ContactOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Street address of the contact.""" address: OrderByEnum """City of the contact address.""" city: OrderByEnum """Free-form notes describing the contact.""" comments: OrderByEnum """Id of the contact type assigned to this contact.""" contactTypeId: OrderByEnum """Country of the contact address.""" country: OrderByEnum """Id of the currency exchange rate list applied to this contact.""" currencyExchangeRatesListId: OrderByEnum """ Primary email address of the contact. Used as default recipient for emails sent from Coevera. """ email1: OrderByEnum """Additional email address.""" email2: OrderByEnum """Additional email address.""" email3: OrderByEnum """Additional email address.""" email4: OrderByEnum """Additional email address.""" email5: OrderByEnum """Given name of the contact.""" firstName: OrderByEnum """ Gender of the contact: Unknown when not specified, Male, Female or NonBinary. """ gender: OrderByEnum """ True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """Family name of the contact.""" lastName: OrderByEnum """Middle name of the contact, if applicable.""" middleName: OrderByEnum """Id of the contact owner.""" ownerId: OrderByEnum """ Primary phone number of the contact. Used as default target for click-to-call. """ phone1: OrderByEnum """Additional phone number.""" phone2: OrderByEnum """Additional phone number.""" phone3: OrderByEnum """Additional phone number.""" phone4: OrderByEnum """Additional phone number.""" phone5: OrderByEnum """Job title or position of the contact.""" position: OrderByEnum """ Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. """ quickAccountName: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """State or province of the contact address.""" stateProvince: OrderByEnum """ Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. """ title: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ZIP or postal code of the contact address.""" zipCode: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related Lead record. Set exactly one field in each item. """ input LeadOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the currency exchange rate list applied to this lead.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the lead.""" description: OrderByEnum """ True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: OrderByEnum """User-set colored flag used to highlight the lead in lists and reports.""" labelFlag: OrderByEnum """ Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). """ leadSourceId: OrderByEnum """ Id of the lead type that classifies the lead and drives which form, fields and lead process apply. """ leadTypeId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the lead owner.""" ownerId: OrderByEnum """ Free-text company email captured at lead creation when no Account record has been linked yet. """ quickAccountEmail: OrderByEnum """ Free-text company name captured at lead creation when no Account record has been linked yet. """ quickAccountName: OrderByEnum """ Free-text company phone captured at lead creation when no Account record has been linked yet. """ quickAccountPhone: OrderByEnum """ Free-text contact name captured at lead creation when no Contact record has been linked yet. """ quickContactName: OrderByEnum """ Free-text contact email captured at lead creation when no Contact record has been linked yet. """ quickEmail: OrderByEnum """ Free-text contact phone captured at lead creation when no Contact record has been linked yet. """ quickPhone: OrderByEnum """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. """ ranking: OrderByEnum """ Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. """ reasonOfCloseDescription: OrderByEnum """ Id of the reason recorded when the lead is archived (lost), or empty when none was given. """ reasonOfCloseId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Id of the lead process step.""" stepId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events. """ status: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related Project record. Set exactly one field in each item. """ input ProjectOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the related account.""" accountId: OrderByEnum """Id of the currency exchange rate list applied to this project.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the project.""" description: OrderByEnum """ Planned end date of the project. Must be on or after startDate when both are set. """ endDate: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the project owner.""" ownerId: OrderByEnum """Id of the project type that classifies this project.""" projectTypeId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: OrderByEnum """Date when the project starts.""" startDate: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. """ revenueGoal: OrderByEnum """ Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). """ enrolledEmailSequences: OrderByEnum """ Current status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress. """ status: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Statistics of an email sequence for a period: enrollments, sent emails with their opens, clicks and replies, and the records it created. """ type EmailSequenceStats implements EmailSequenceCountStats { """Number of sent emails that were opened at least once.""" openCount: Int! """Number of sent emails in which at least one link was clicked.""" clickCount: Int! """Number of sent emails that received a reply.""" replyCount: Int! """Number of sent emails through which the recipient unsubscribed.""" unsubscribeCount: Int! """Number of emails sent.""" sentCount: Int! """Number of tasks created by the sequence steps.""" createTaskCount: Int! """Number of leads created by the sequence steps.""" createLeadCount: Int! """Number of text messages sent by the sequence steps.""" createTextCount: Int! """ Number of enrolled records for which the sequence created at least one task. """ createTaskRecipientsCount: Int! """ Number of enrolled records for which the sequence created at least one lead. """ createLeadRecipientsCount: Int! """ Number of enrolled records the sequence sent at least one text message to. """ createTextRecipientsCount: Int! """Number of enrollments that are still running.""" currentEnrollCount: Int! """Number of enrollments that ended because the record was unenrolled.""" unenrollCount: Int! """Number of enrolled records the sequence sent at least one email to.""" sentRecipientsCount: Int! """ Number of enrolled records that were sent emails but opened none of them. """ notOpenRecipientsCount: Int! """Number of enrolled records that opened at least one email.""" openRecipientsCount: Int! """Number of enrolled records that clicked a link in an email.""" clickRecipientsCount: Int! """Number of enrolled records that replied to at least one email.""" replyRecipientsCount: Int! """Number of enrolled records with at least one bounced email.""" bounceRecipientsCount: Int! """Number of sent emails that were not opened.""" notOpenCount: Int! """Number of enrollments.""" enrollCount: Int! """Number of sent emails that bounced.""" bounceCount: Int! """ Statistics of each step, in step order. They count only activity since the step statistics were last reset. """ steps: [EmailSequenceStepStats!]! """ Records behind one of the counts, chosen by `type`, as a list view. Empty for a sequence without settings. """ recipients( """Count whose records are listed, such as Open or NotOpen.""" type: EmailSequenceStatsRecipientTypeEnum! """ Extra filter on the listed records, as a JSON object whose __typename names the filter for the record type, for example {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies no extra filter. """ filter: DrilldownFilterJSONString """Fulltext search by string. When null, search is not applied.""" searchQuery: String """Id of the field the items are sorted by.""" sortBy: ID! """Options settings for tab grid sort order listing""" sortOrder: SortOrder! """ Columns returned for each item, given by field id and display option; the values of each item follow the order of this list. """ displayColumn: [DisplayColumnParams!]! """ Highlighting of recent changes: values changed within the period carry their latest change in the change field of the row data. """ highlightChanges: GridHighlightChangesParams """Maximum number of items returned in one call.""" limit: Int """Number of items to skip before the first returned item; starts at 0.""" offset: Int = 0 """Max total records to return. If null, then no limit.""" maxRecords: Int ): GenericDrilldownDataGridViewItems """Tasks created by the sequence, as a list view.""" createdTasks( """ Extra filter on the listed records, as a JSON object whose __typename names the filter for the record type, for example {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies no extra filter. """ filter: DrilldownFilterJSONString """Fulltext search by string. When null, search is not applied.""" searchQuery: String """Id of the field the items are sorted by.""" sortBy: ID! """Options settings for tab grid sort order listing""" sortOrder: SortOrder! """ Columns returned for each item, given by field id and display option; the values of each item follow the order of this list. """ displayColumn: [DisplayColumnParams!]! """ Highlighting of recent changes: values changed within the period carry their latest change in the change field of the row data. """ highlightChanges: GridHighlightChangesParams """Maximum number of items returned in one call.""" limit: Int """Number of items to skip before the first returned item; starts at 0.""" offset: Int = 0 """Max total records to return. If null, then no limit.""" maxRecords: Int ): GenericDrilldownDataGridViewItems! """Leads created by the sequence, as a list view.""" createdLeads( """ Extra filter on the listed records, as a JSON object whose __typename names the filter for the record type, for example {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies no extra filter. """ filter: DrilldownFilterJSONString """Fulltext search by string. When null, search is not applied.""" searchQuery: String """Id of the field the items are sorted by.""" sortBy: ID! """Options settings for tab grid sort order listing""" sortOrder: SortOrder! """ Columns returned for each item, given by field id and display option; the values of each item follow the order of this list. """ displayColumn: [DisplayColumnParams!]! """ Highlighting of recent changes: values changed within the period carry their latest change in the change field of the row data. """ highlightChanges: GridHighlightChangesParams """Maximum number of items returned in one call.""" limit: Int """Number of items to skip before the first returned item; starts at 0.""" offset: Int = 0 """Max total records to return. If null, then no limit.""" maxRecords: Int ): GenericDrilldownDataGridViewItems! """Statistics over time, one item per period with activity, oldest first.""" timeline( """Length of the periods the statistics are grouped by.""" period: EmailSequenceTimelinePeriodEnum! ): [EmailSequencePeriodStats!]! } """ Email counts of an email sequence: how many of its emails were sent, opened, clicked, replied to or used to unsubscribe. """ interface EmailSequenceCountStats { """Number of sent emails that were opened at least once.""" openCount: Int! """Number of sent emails in which at least one link was clicked.""" clickCount: Int! """Number of sent emails that received a reply.""" replyCount: Int! """Number of sent emails through which the recipient unsubscribed.""" unsubscribeCount: Int! """Number of emails sent.""" sentCount: Int! } """Statistics of one step of an email sequence.""" type EmailSequenceStepStats implements EmailSequenceCountStats { """Number of sent emails that were opened at least once.""" openCount: Int! """Number of sent emails in which at least one link was clicked.""" clickCount: Int! """Number of sent emails that received a reply.""" replyCount: Int! """Number of sent emails through which the recipient unsubscribed.""" unsubscribeCount: Int! """Number of emails sent.""" sentCount: Int! """Sequence step these statistics belong to.""" step: EmailSequenceNode! """ Email template the step sends; empty when the step sends no email from a template. """ emailTemplate: EmailTemplateEntity """ Share, in percent, of this step's emails and created records that the next step followed up on. Empty for the last step. """ conversion: Int """Number of tasks, leads and text messages the step created.""" createCount: Int! """Number of emails sent by the step that bounced.""" bounceCount: Int! } """ Group of email sequence recipients to list in the sequence statistics drill-down. """ enum EmailSequenceStatsRecipientTypeEnum { """All records ever enrolled in the sequence.""" Enroll """Records that are still running through the sequence.""" CurrentEnroll """Records that were unenrolled before the sequence finished.""" Unenroll """Recipients who unsubscribed through a sequence email.""" Unsubscribe """Recipients who were sent at least one sequence email.""" Sent """Recipients who opened a sequence email.""" Open """Recipients who were sent a sequence email but opened none.""" NotOpen """Recipients who clicked a link in a sequence email.""" Click """Recipients who replied to a sequence email.""" Reply """Recipients whose sequence email bounced.""" Bounce """Recipients for whom a sequence step created a task.""" CreateTask """Recipients for whom a sequence step created a lead.""" CreateLead """Recipients for whom a sequence step created a text message.""" CreateText } """Statistics of an email sequence for one period of its timeline.""" type EmailSequencePeriodStats implements EmailSequenceCountStats { """Number of sent emails that were opened at least once.""" openCount: Int! """Number of sent emails in which at least one link was clicked.""" clickCount: Int! """Number of sent emails that received a reply.""" replyCount: Int! """Number of sent emails through which the recipient unsubscribed.""" unsubscribeCount: Int! """Number of emails sent.""" sentCount: Int! """Number of tasks, leads and text messages created in the period.""" createCount: Int! """Number of records enrolled in the period.""" enrollCount: Int! """Date of the first activity in the period.""" date: Date! } """Time bucket used to group email sequence statistics in the timeline.""" enum EmailSequenceTimelinePeriodEnum { """One data point per day.""" Daily """One data point per week.""" Weekly """One data point per month.""" Monthly """One data point per quarter.""" Quarterly """One data point per year.""" Yearly } """Time window for email sequence statistics.""" enum EmailSequenceStatsPeriodEnum { """The whole history of the sequence.""" All """The last 7 days.""" Last7Days """The last 30 days.""" Last30Days """The last 90 days.""" Last90Days """The last 12 months.""" LastYear } """ Automatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook). """ type ProcessEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns the process.""" owner: ClientEntity """ AI assistant conversation associated with the process (e.g. records of AI-driven schema generation). """ aiConversation: [AiConversationItem!] """ Why the process is disabled: turned off by a user, suspended after repeated failed runs, or suspended because Automatizer was switched off for the space. NoReason while enabled; read-only. """ deactivationReason: ProcessDeactivationReasonEnum """Free-text description shown alongside the process.""" description: String """ When true, the process actively responds to its trigger; when false, the process is paused. Toggle via enable/disable mutations. """ isEnabled: Boolean """Timestamp of the most recent change to settings.""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ Process schema as a JSON object conforming to the ProcessSchema type — trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema This payload conforms to the `ProcessSchema` JSON Schema: GET /api/v100/rest/schemas/ProcessSchema.json on your region's API host """ settings: ProcessSchema """ Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. """ type: ProcessTypeEnum! """ Activity log runs (one per process execution) recorded for this process. """ activityLogs( """ Filter ProcessActivityLog relations by target ProcessActivityLog attributes. """ filter: ProcessActivityLogFilterInput """ Order ProcessActivityLog relations by target ProcessActivityLog attributes. """ orderBy: [ProcessActivityLogOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessActivityLogEntityConnection """Tags attached to the process for organisation/filtering.""" tags( """Filter Tag relations by target Tag attributes.""" filter: TagFilterInput """ Filter TagRelation relations by edge (relation) TagRelation attributes. """ filterEdge: TagRelationFilterInput """Order Tag relations by target Tag attributes.""" orderBy: [TagOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """ Timestamp of the most recent execution of this process. Empty when never run. """ lastProcessRun: DateTime """ Solutions whose canvas contains this record. Deleted solutions are not included. """ solutions( """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionEntityConnection """ Activity timeline for the last 24 hours showing per-hour counts of successful, warning, and error process runs. """ activity: ProcessTimelineResult! """ Overall status of the process, derived from its most recent runs since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are no runs. """ status: ProcessStatusEnum """ For record-triggered processes, the event that starts the process: Create, Update, CreateOrUpdate or Delete, or EmailSent / EmailReceived for email-triggered processes. Empty for other trigger types. """ recordTriggerEvent: ProcessRecordTriggerEventEnum """ What starts the process: a record event (ProcessRecordTrigger), a schedule (ProcessScheduleTrigger), a user on selected records (ProcessManualTrigger) or an online form submission (ProcessOnlineFormTrigger). """ triggerType: ProcessTriggerTypeEnum """ For record-based triggers, the entity whose records fire the process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: EntityNameEnum """ API name of the trigger entity (useful for custom entities where this differs from triggerEntityName). Empty for non-record triggers. """ triggerEntityApiName: String """Files attached to the process (e.g. process documentation).""" documents: [CloudObjectRelationEntity!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProcessActivityLog records.""" type ProcessActivityLogEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProcessActivityLogEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProcessActivityLogEntity` and its cursor.""" type ProcessActivityLogEntityEdge { """The item at the end of the edge""" node: ProcessActivityLogEntity """A cursor for use in pagination""" cursor: String! } """ One run of an Automatizer process, with its status, timing and the steps it took. """ type ProcessActivityLogEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who triggered the run, or empty for runs triggered by automation.""" actor: ClientEntity """Application context the run was triggered in.""" application: ApplicationEntity """Process whose execution this log records.""" process: ProcessEntity """ Id of the user who triggered the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. """ applicationId: ID! """Total CPU time consumed by the run, in seconds.""" cpuRunTime: Float """ Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). """ endTime: DateTime """ True when the run was triggered as a test (results are not persisted to records). """ isTestRun: Boolean """ Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. """ parentProcessIds: JSONString """Id of the Automatizer process whose run this log records.""" processId: ID! """ Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. """ runId: ID """Timestamp the run started.""" startTime: DateTime! """ Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. """ status: ProcessStatusEnum! """ Activity log lines describing each step taken in this run (visible only). """ lines( """ Filter ProcessActivityLogLine relations by target ProcessActivityLogLine attributes. """ filter: ProcessActivityLogLineFilterInput """ Order ProcessActivityLogLine relations by target ProcessActivityLogLine attributes. """ orderBy: [ProcessActivityLogLineOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessActivityLogLineEntityConnection """ Name of the trigger record (extracted from the first log line) for display in activity log lists. """ recordName: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ProcessActivityLogLine records.""" type ProcessActivityLogLineEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProcessActivityLogLineEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProcessActivityLogLineEntity` and its cursor. """ type ProcessActivityLogLineEntityEdge { """The item at the end of the edge""" node: ProcessActivityLogLineEntity """A cursor for use in pagination""" cursor: String! } """One step logged in a run of an Automatizer process.""" type ProcessActivityLogLineEntity { """ Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id. """ formattedText: String! """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Activity log run this line belongs to.""" processActivityLog: ProcessActivityLogEntity """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the process run (activity log) this line belongs to.""" processActivityLogId: ID! """Position of the line within its log run.""" sortOrder: Int! """ Result of the process step recorded by this line, such as Ok, Warning (for example a scheduled action that was canceled) or Error. """ status: ProcessStatusEnum """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of ProcessActivityLogLine records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProcessActivityLogLineOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Activity log run this line belongs to. Sorts by fields of the related record, listed in order of priority. """ processActivityLog: [ProcessActivityLogOrderByNestedInput!] """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: OrderByEnum """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: OrderByEnum """Id of the process run (activity log) this line belongs to.""" processActivityLogId: OrderByEnum """Position of the line within its log run.""" sortOrder: OrderByEnum """ Result of the process step recorded by this line, such as Ok, Warning (for example a scheduled action that was canceled) or Error. """ status: OrderByEnum } """ Sorting by a field of the related ProcessActivityLog record. Set exactly one field in each item. """ input ProcessActivityLogOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the user who triggered the run, or empty for runs triggered by automation. """ actorId: OrderByEnum """ Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. """ applicationId: OrderByEnum """Total CPU time consumed by the run, in seconds.""" cpuRunTime: OrderByEnum """ Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). """ endTime: OrderByEnum """ True when the run was triggered as a test (results are not persisted to records). """ isTestRun: OrderByEnum """Id of the Automatizer process whose run this log records.""" processId: OrderByEnum """Timestamp the run started.""" startTime: OrderByEnum """ Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. """ status: OrderByEnum """ Name of the trigger record (extracted from the first log line) for display in activity log lists. """ recordName: OrderByEnum } """ Sorting of ProcessActivityLog records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProcessActivityLogOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who triggered the run, or empty for runs triggered by automation. Sorts by fields of the related record, listed in order of priority. """ actor: [ClientOrderByNestedInput!] """ Application context the run was triggered in. Sorts by fields of the related record, listed in order of priority. """ application: [ApplicationOrderByNestedInput!] """ Process whose execution this log records. Sorts by fields of the related record, listed in order of priority. """ process: [ProcessOrderByNestedInput!] """ Id of the user who triggered the run, or empty for runs triggered by automation. """ actorId: OrderByEnum """ Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. """ applicationId: OrderByEnum """Total CPU time consumed by the run, in seconds.""" cpuRunTime: OrderByEnum """ Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). """ endTime: OrderByEnum """ True when the run was triggered as a test (results are not persisted to records). """ isTestRun: OrderByEnum """Id of the Automatizer process whose run this log records.""" processId: OrderByEnum """Timestamp the run started.""" startTime: OrderByEnum """ Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. """ status: OrderByEnum """ Name of the trigger record (extracted from the first log line) for display in activity log lists. """ recordName: OrderByEnum } """ Sorting by a field of the related Process record. Set exactly one field in each item. """ input ProcessOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Why the process is disabled: turned off by a user, suspended after repeated failed runs, or suspended because Automatizer was switched off for the space. NoReason while enabled; read-only. """ deactivationReason: OrderByEnum """Free-text description shown alongside the process.""" description: OrderByEnum """ When true, the process actively responds to its trigger; when false, the process is paused. Toggle via enable/disable mutations. """ isEnabled: OrderByEnum """Timestamp of the most recent change to settings.""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled.""" lastStatusChange: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. """ type: OrderByEnum """ Timestamp of the most recent execution of this process. Empty when never run. """ lastProcessRun: OrderByEnum """ Names of the solutions whose canvas contains this process, in name order. Empty when the process is on no solution canvas. """ solutions: OrderByEnum """ Overall status of the process, derived from its most recent runs since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are no runs. """ status: OrderByEnum """ For record-triggered processes, the event that starts the process: Create, Update, CreateOrUpdate or Delete, or EmailSent / EmailReceived for email-triggered processes. Empty for other trigger types. """ recordTriggerEvent: OrderByEnum """ What starts the process: a record event (ProcessRecordTrigger), a schedule (ProcessScheduleTrigger), a user on selected records (ProcessManualTrigger) or an online form submission (ProcessOnlineFormTrigger). """ triggerType: OrderByEnum """ For record-based triggers, the entity whose records fire the process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: OrderByEnum """ API name of the trigger entity (useful for custom entities where this differs from triggerEntityName). Empty for non-record triggers. """ triggerEntityApiName: OrderByEnum } """ Activity timeline of process runs, per hour or per day, with totals by outcome. """ type ProcessTimelineResult { """ One item per hour (last 24 hours) or per day, oldest first, including periods without runs. """ items: [ProcessTimelineItem!]! """Process runs in the whole period that ended without problems.""" successCount: Int! """Process runs in the whole period that ended with warnings.""" warningCount: Int! """Process runs in the whole period that failed.""" errorCount: Int! } """ Counts of the process runs started within one hour or day of an activity timeline. """ type ProcessTimelineItem { """Start of the hour or day this item covers, in the user's timezone.""" startTime: DateTime! """End of the hour or day this item covers.""" endTime: DateTime! """Process runs started in this period that ended without problems.""" successCount: Int! """Process runs started in this period that ended with warnings.""" warningCount: Int! """Process runs started in this period that failed.""" errorCount: Int! } """Paginated list of StepChecklistSalesRoleRelation records.""" type StepChecklistSalesRoleRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [StepChecklistSalesRoleRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `StepChecklistSalesRoleRelationEntity` and its cursor. """ type StepChecklistSalesRoleRelationEntityEdge { """The item at the end of the edge""" node: StepChecklistSalesRoleRelationEntity """A cursor for use in pagination""" cursor: String! } """Sales role that a step checklist item is shown to.""" type StepChecklistSalesRoleRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Sales role that sees the checklist item.""" salesRole: SalesRoleEntity """Checklist item the role is granted access to.""" stepChecklist: StepChecklistEntity """Id of the sales role that sees the checklist item.""" salesRoleId: ID! """Id of the checklist item.""" stepChecklistId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of SalesRole records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input SalesRoleOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ colorCode: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of StepChecklist records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input StepChecklistOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment type that satisfies this checklist item. Set when activityTypeId resolves to an AppointmentType. Sorts by fields of the related record, listed in order of priority. """ appointmentType: [AppointmentTypeOrderByNestedInput!] """ Task type that satisfies this checklist item. Set when activityTypeId resolves to a TaskType. Sorts by fields of the related record, listed in order of priority. """ taskType: [TaskTypeOrderByNestedInput!] """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. Sorts by fields of the related record, listed in order of priority. """ cloudObjectTemplate: [CloudObjectTemplateOrderByNestedInput!] """ Email sequence the item should enroll the record into. Sorts by fields of the related record, listed in order of priority. """ emailSequence: [EmailSequenceOrderByNestedInput!] """ Field whose value satisfies this checklist item. Set when itemType is FieldType. Sorts by fields of the related record, listed in order of priority. """ field: [FieldOrderByNestedInput!] """ Automatizer process that completes the item once it has run for the record. Set when itemType is RunProcess. Sorts by fields of the related record, listed in order of priority. """ process: [ProcessOrderByNestedInput!] """ Field that supplies the recipient email address when the checklist item triggers sending an email. Sorts by fields of the related record, listed in order of priority. """ sendEmailField: [FieldOrderByNestedInput!] """ Contact or Account lookup field whose primary record supplies the recipient. When set, sendEmailField is read from that record instead of the Primary Contact or Primary Account. Only lookup fields with a primary record are valid. Sorts by fields of the related record, listed in order of priority. """ sendEmailLookupField: [FieldOrderByNestedInput!] """ Email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail. Sorts by fields of the related record, listed in order of priority. """ sendEmailTemplate: [EmailTemplateOrderByNestedInput!] """ Pipeline or process step this checklist item belongs to. Sorts by fields of the related record, listed in order of priority. """ step: [StepOrderByNestedInput!] """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: OrderByEnum """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: OrderByEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: OrderByEnum """Free-text description shown alongside the checklist item.""" description: OrderByEnum """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: OrderByEnum """Id of the related field.""" fieldId: OrderByEnum """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: OrderByEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: OrderByEnum """Display label of the checklist item.""" label: OrderByEnum """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: OrderByEnum """Id of the related process.""" processId: OrderByEnum """Id of the recipient field.""" sendEmailFieldId: OrderByEnum """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: OrderByEnum """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: OrderByEnum """ Position of the checklist item within its step; lower values appear first. """ sortOrder: OrderByEnum """Id of the pipeline or process step this checklist item belongs to.""" stepId: OrderByEnum """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related AppointmentType record. Set exactly one field in each item. """ input AppointmentTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Icon used to display appointments of this type in the UI.""" icon: OrderByEnum """ True when the appointment type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related TaskType record. Set exactly one field in each item. """ input TaskTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Icon used to display tasks of this type in the UI.""" icon: OrderByEnum """ True when the task type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related CloudObjectTemplate record. Set exactly one field in each item. """ input CloudObjectTemplateOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the producing application.""" applicationId: OrderByEnum """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: OrderByEnum """Id of the uploading user.""" creatorId: OrderByEnum """File name (with extension) used when downloading the object.""" filename: OrderByEnum """When true, the object can be served via a public URL (see publicUrl).""" isPublic: OrderByEnum """Mime-type of the cloud object Is detected from content.""" mimeType: OrderByEnum """Size of the object in bytes.""" size: OrderByEnum """ Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. """ status: OrderByEnum """ Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. """ templateEntityName: OrderByEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. """ templateEntityApiName: OrderByEnum } """ Sorting by a field of the related Field record. Set exactly one field in each item. """ input FieldOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """True when the field is marked as deleted (soft-delete).""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: 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. """ entityName: OrderByEnum """Immutable and generated name. This name is used for integrations.""" apiName: OrderByEnum """User friendly name for field.""" name: OrderByEnum """ When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown. """ useLang: OrderByEnum """ Storage column name for the field; used as the filter key in API queries. """ columnName: OrderByEnum """ Storage origin of the field: on the main entity record, on the custom-field data record, or computed. """ columnSource: OrderByEnum """ For relation-typed fields, identifier of the relation kind that connects this entity to the related entity. Empty for non-relation fields. """ relationId: OrderByEnum """ For relation-typed fields, the entity the field points to (e.g. Contact, Account). Empty for non-relation fields. """ relationWithEntityId: 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. """ sharedWithFieldId: OrderByEnum """ Whether the field is System (built-in, immutable), Protected (built-in, limited changes), or Custom (user-created). """ systemType: 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 """ typeId: 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. """ compositeFieldId: OrderByEnum """Optional custom data set id can be set.""" dataSetId: OrderByEnum """ For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. """ parentOptionsFieldId: OrderByEnum """Calculated formula used for fields which supports calculation.""" calcFormula: 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. """ defaultValue: OrderByEnum """ True when the field cannot be made optional (enforced by the platform). """ systemRequired: OrderByEnum """ True when the field configuration is published; false while the field exists only as an unpublished draft. """ isPublished: OrderByEnum """ True when the field cannot be made writable (enforced by the platform). """ systemReadonly: OrderByEnum """If this field is allowed in global search.""" useInGlobalSearch: OrderByEnum """ If true, then there will be an API validation if value of entity is unique. """ isUnique: OrderByEnum """ Deprecated - previously returned sequence pattern used for sequence type of field. """ sequencePattern: OrderByEnum } """ Sorting by a field of the related EmailTemplate record. Set exactly one field in each item. """ input EmailTemplateOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the folder the template belongs to. Empty for templates at the root level. """ emailTemplateFolderId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the template owner.""" ownerId: OrderByEnum """ Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). """ shareMode: OrderByEnum """ When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. """ sharingUrlIsEnabled: OrderByEnum """ Subject line of emails composed from this template. Supports merge-field placeholders. """ subject: OrderByEnum """ Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Names of the solutions whose canvas contains this template, in name order. Empty when the template is on no solution canvas. """ solutions: OrderByEnum } """ Score of a record: its value, trend and category, and the rules that affect it. """ type EntityScoringResult { """Score categories of the scoring, such as Hot, Warm and Cold.""" categories: [EntityScoringCategory!]! """ Score of the record as a percentile from 0 to 100, comparing its rule points with those of the other records of the same scoring; 0 when it has no points. """ score: Int! """How the score changed compared with the previous calculation.""" trend: EntityScoringTrendEnum! """ Scoring rules that currently add points to the score of the record, or subtract them. """ rules: [EntityScoringResultRule!]! """Id of the scoring the record was scored by.""" entityScoringId: UUID! """Name of the scoring the record was scored by.""" entityScoringName: String! """ When true, entityScoringName is treated as a translation key and resolved through the translation system; otherwise the literal text is shown. """ entityScoringUseLang: Boolean! """When the score of the record was last calculated.""" lastCalculation: DateTime! } """ Direction of a record's score, or of one scoring rule's contribution to it. """ enum EntityScoringTrendEnum { """The score went down, or the rule subtracts points.""" Decreasing """The score went up, or the rule adds points.""" Increasing """The score did not change, or the rule adds no points.""" NoChange } """ Scoring rule that currently adds points to the score of a record, or subtracts them. """ type EntityScoringResultRule { """Id of the scoring rule.""" id: UUID! """Name of the scoring rule.""" name: String! """ When true, name is treated as a translation key and resolved through the translation system; otherwise the literal text is shown. """ useLang: Boolean! """Whether the rule adds points to the score or subtracts them.""" trend: EntityScoringTrendEnum! } """Paginated list of ApprovalApprover records.""" type ApprovalApproverEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ApprovalApproverEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ApprovalApproverEntity` and its cursor.""" type ApprovalApproverEntityEdge { """The item at the end of the edge""" node: ApprovalApproverEntity """A cursor for use in pagination""" cursor: String! } """ User asked to decide an approval request, with their response and comment. """ type ApprovalApproverEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Approval this approver is assigned to.""" approval: ApprovalEntity """User responsible for approving (or rejecting) the request.""" client: ClientEntity """Id of the approval this approver is assigned to.""" approvalId: ID! """Id of the assigned user.""" clientId: ID! """Comment the user attached when responding to the approval.""" comment: String """ Response of this approver to the approval request: Pending until the user approves or rejects it. """ status: ApprovalStatusEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of ApprovalApprover records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ApprovalApproverOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Approval this approver is assigned to. Sorts by fields of the related record, listed in order of priority. """ approval: [ApprovalOrderByNestedInput!] """ User responsible for approving (or rejecting) the request. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """Id of the approval this approver is assigned to.""" approvalId: OrderByEnum """Id of the assigned user.""" clientId: OrderByEnum """Comment the user attached when responding to the approval.""" comment: OrderByEnum """ Response of this approver to the approval request: Pending until the user approves or rejects it. """ status: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Approval record. Set exactly one field in each item. """ input ApprovalOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the linked account.""" accountId: OrderByEnum """Id of the triggering user.""" actorId: OrderByEnum """ Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. """ applicationId: OrderByEnum """Id of the approval process this approval was raised from.""" approvalProcessId: OrderByEnum """ Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. """ approvalStatus: OrderByEnum """Comment the requester attached when raising the approval.""" comment: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """ Timestamp the approval reached a final status (Approved/Rejected/Cancelled). Empty while the approval is still pending. """ endTime: OrderByEnum """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """ Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. """ status: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Display name of the approval, derived from the underlying record being approved (e.g. the quote name). Empty when the underlying record has been deleted. """ name: OrderByEnum """ Id of the user who owns the record being approved (the record's owner, not the approver). Empty when the underlying record has been deleted. """ ownerId: OrderByEnum """Timestamp the approval was raised (alias of created).""" startTime: OrderByEnum } """Paginated list of ApprovalProcessActivityLogLine records.""" type ApprovalProcessActivityLogLineEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ApprovalProcessActivityLogLineEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ApprovalProcessActivityLogLineEntity` and its cursor. """ type ApprovalProcessActivityLogLineEntityEdge { """The item at the end of the edge""" node: ApprovalProcessActivityLogLineEntity """A cursor for use in pagination""" cursor: String! } """ Entry in the activity log of an approval, recording one step of the approval and its result. """ type ApprovalProcessActivityLogLineEntity { """ Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id. """ formattedText: String! """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Approval this log line belongs to.""" approval: ApprovalEntity """Id of the approval this log line belongs to.""" approvalId: ID! """ Typed JSON payload describing the approval step (e.g. approver decisions, comments). """ data: JSONString! """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its approval run.""" sortOrder: Int! """ Result of the approval step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of ApprovalProcessActivityLogLine records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ApprovalProcessActivityLogLineOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Approval this log line belongs to. Sorts by fields of the related record, listed in order of priority. """ approval: [ApprovalOrderByNestedInput!] """Id of the approval this log line belongs to.""" approvalId: OrderByEnum """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: OrderByEnum """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: OrderByEnum """Position of the line within its approval run.""" sortOrder: OrderByEnum """ Result of the approval step recorded by this line, such as Ok, Warning or Error. """ status: OrderByEnum } """ Sorting of Approval records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ApprovalOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the approval is requested on, when the trigger record is an Account. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ User who triggered the approval, or empty when triggered automatically. Sorts by fields of the related record, listed in order of priority. """ actor: [ClientOrderByNestedInput!] """ Application context the approval was triggered in. Sorts by fields of the related record, listed in order of priority. """ application: [ApplicationOrderByNestedInput!] """ Approval process this approval was raised from. Sorts by fields of the related record, listed in order of priority. """ approvalProcess: [ApprovalProcessOrderByNestedInput!] """ Contact the approval is requested on, when the trigger record is a Contact. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Lead the approval is requested on. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the approval is requested on. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Quote the approval is requested on, when the trigger record is a Quote. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the triggering user.""" actorId: OrderByEnum """ Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. """ applicationId: OrderByEnum """Id of the approval process this approval was raised from.""" approvalProcessId: OrderByEnum """ Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. """ approvalStatus: OrderByEnum """Comment the requester attached when raising the approval.""" comment: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """ Timestamp the approval reached a final status (Approved/Rejected/Cancelled). Empty while the approval is still pending. """ endTime: OrderByEnum """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """ Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. """ status: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Display name of the approval, derived from the underlying record being approved (e.g. the quote name). Empty when the underlying record has been deleted. """ name: OrderByEnum """ Id of the user who owns the record being approved (the record's owner, not the approver). Empty when the underlying record has been deleted. """ ownerId: OrderByEnum """Timestamp the approval was raised (alias of created).""" startTime: OrderByEnum } """ Sorting by a field of the related ApprovalProcess record. Set exactly one field in each item. """ input ApprovalProcessOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text description shown alongside the approval process.""" description: OrderByEnum """ When true, the approval process actively raises approvals on matching record events; when false, the process is paused. """ isEnabled: OrderByEnum """Timestamp of the most recent change to settings.""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled.""" lastStatusChange: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Position of this process among approval processes for the same record-trigger entity type; lower values are evaluated first. Read-only; managed via update_priority. Null for manual-trigger approval processes. """ priority: OrderByEnum """ For record-change triggers, the entity whose records can raise an approval (e.g. "Quote"). Empty for manual triggers. """ triggerEntityName: OrderByEnum """ Overall status of the approval process, derived from the approvals it raised since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are none. """ status: OrderByEnum """ How approvals are raised: Manual (a user must initiate) or RecordChange (automatically when a record matching the trigger condition is created or updated). """ triggerType: OrderByEnum } """ Rules for copying field values from a source record to a new target record, for example when a lead is qualified into an opportunity. """ type FieldMappingEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ True when the mapping is shipped by the platform and cannot be deleted by the user. """ isSystem: Boolean! """ Default field-to-field mapping template applied when no per-type-pair mapping matches. """ mapping: FieldMappingTemplate """ Situation in which the mapping pre-fills a new target record from a source record, such as qualifying a lead into an opportunity or creating a follow-up activity. """ operation: FieldMappingOperationTypeEnum """ API name of the source custom entity. Set only when sourceEntityName is "CustomEntity"; otherwise empty. """ sourceEntityApiName: String """ API name of the target custom entity. Set only when targetEntityName is "CustomEntity"; otherwise empty. """ targetEntityApiName: String """ Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match. """ typeMappings: [EntityTypeFieldMapping!] """Revision when entity was lastly changed.""" revision: Int """ Source entity kind for the mapping (e.g. Lead, Account, Contact). Returns "CustomEntity" when the source is a custom entity; the API name is then exposed via sourceEntityApiName. """ sourceEntityName: EntityNameEnum! """ Target entity kind for the mapping (e.g. Lead, Account, Contact). Returns "CustomEntity" when the target is a custom entity; the API name is then exposed via targetEntityApiName. """ targetEntityName: EntityNameEnum! """Files attached to the mapping (e.g. import source files).""" documents: [CloudObjectRelationEntity!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Recording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment. """ type MediaEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment this media is attached to. Set when activityId resolves to an Appointment. """ appointment: AppointmentEntity """ Task this media is attached to. Set when activityId resolves to a Task. """ task: TaskEntity """Call this media belongs to (e.g. a recording or transcription).""" call: CallEntity """ Id of the linked appointment or task, or empty when not linked to an activity. """ activityId: ID """Id of the linked call, or empty when not linked.""" callId: ID """ Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object. """ data: JSONString """Free-text description of the media.""" description: String """ Error code reported by the calling/recording provider when processing failed; empty on success. """ errorCode: Int """ Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode. """ status: MediaStatusEnum """ Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set. """ type: MediaTypeEnum """Revision when entity was lastly changed.""" revision: Int """Id of the cloud object holding the audio recording, when available.""" audioId: UUID """ Id of the cloud object holding the transcription payload, when available. """ transcriptionFileId: UUID """External transcription identifier from the calling provider.""" transcriptionId: String """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US", "de-DE"). Set when the transcription was requested. """ transcriptionLanguage: String """AI-generated summary of the transcription content.""" transcriptionSummary: String """ Short-lived token for opening the transcription in the calling provider's viewer. Empty when no transcription is available. """ getTranscriptionViewerToken: String! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Audio recording (MP3 file) of the media or of the call it belongs to; empty when none is stored. """ audio: CloudObjectEntity """ Transcription (JSON file) of the media or of the call it belongs to; empty when none is stored. """ transcriptionFile: CloudObjectEntity } """ Ready-made Automatizer process offered in the template gallery as a starting point for new processes. """ type ProcessTemplateEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template does.""" description: String """ True when the platform recommends this template (highlighted in the template gallery). """ isRecommended: Boolean """Name of the entity and its default text representation.""" name: String! """ Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema """ settings: ProcessSchema """ Files attached to the template (e.g. reference documents, screenshots). """ documents: [CloudObjectRelationEntity!] """ Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template. """ triggerType: ProcessTriggerTypeEnum """ For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: EntityNameEnum """ Action-type icons present in the template schema, used for filtering templates by capability (e.g. SendEmail, CreateRecord, Webhook). """ actionTypes: [ProcessActionTypeIconEnum!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of trigger or action in a process template, used to show and filter templates by what they do. """ enum ProcessActionTypeIconEnum { """The template creates records.""" CreateRecord """The template updates records.""" UpdateRecord """The template archives records.""" ArchiveRecord """The template sends webhooks.""" SendWebhook """The template sends emails.""" SendEmail """The template is started manually.""" ManualTrigger """The template runs on a schedule.""" ScheduledTrigger """The template runs when a record changes.""" RecordChangedTrigger } """ Message sent or received in a text message conversation or in an AI assistant chat. """ type TextMessageEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ AI assistant chat conversation this message belongs to, when applicable. """ chatConversation: ChatConversationEntity """ Conversation this message belongs to. Empty for messages produced by AI chat that do not belong to a thread of customer conversation. """ textMessageConversation: TextMessageConversationEntity """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: ID """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: String! """Timestamp the message was sent.""" datetimeSent: DateTime """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnum! """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: String """ Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. """ score: Int """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnum """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: ID """Revision when entity was lastly changed.""" revision: Int """Files attached to the message (e.g. MMS attachments).""" attachments( """Filter CloudObject relations by target CloudObject attributes.""" filter: CloudObjectFilterInput """ Filter CloudObjectRelation relations by edge (relation) CloudObjectRelation attributes. """ filterEdge: CloudObjectRelationFilterInput """Order CloudObject relations by target CloudObject attributes.""" orderBy: [CloudObjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ HTML-rendered version of the message body, ready for display in chat UIs. """ contentAsHtml: String! """ Structured AI payload of the message (examples or suggestions). Empty for regular text messages. """ data: AiMessageData """ List of suggested follow-up prompts produced by the AI for this message. Empty when the AI did not produce prompts. """ topicPrompts: [String!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ AI credits consumed by generating this text message, and whether the generation is still in progress. Empty when no AI credits were tracked for the message. """ creditInfo: AiCreditInfo } """ Conversation of a user with the AI assistant, either general or about a specific record. """ type ChatConversationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the conversation belongs to.""" owner: ClientEntity """ Record context the conversation was started in (entity type, entity id and the AI screen view). Empty for conversations not bound to a record. """ context: AiContext """Id of the owning user.""" ownerId: ID! """ Kind of AI chat: a general conversation with the AI assistant, or one about a specific record identified by context. """ type: ChatConversationTypeEnum """Messages exchanged in the conversation, in chronological order.""" messages( """Filter TextMessage relations by target TextMessage attributes.""" filter: TextMessageFilterInput """Order TextMessage relations by target TextMessage attributes.""" orderBy: [TextMessageOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Record an AI chat conversation is about, with the screen it was started from. """ type AiContext { """Entity of the record the conversation is about.""" entityType: EntityNameEnum """ API name of the custom entity when entityType is CustomEntity; null otherwise. """ entityApiName: String """Id of the record the conversation is about.""" entityId: ID """ Data of the screen the conversation was started from, as a JSON object. """ data: JSONString } """Paginated list of TextMessage records.""" type TextMessageEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TextMessageEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TextMessageEntity` and its cursor.""" type TextMessageEntityEdge { """The item at the end of the edge""" node: TextMessageEntity """A cursor for use in pagination""" cursor: String! } """ Sorting of TextMessage records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TextMessageOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ AI assistant chat conversation this message belongs to, when applicable. Sorts by fields of the related record, listed in order of priority. """ chatConversation: [ChatConversationOrderByNestedInput!] """ Conversation this message belongs to. Empty for messages produced by AI chat that do not belong to a thread of customer conversation. Sorts by fields of the related record, listed in order of priority. """ textMessageConversation: [TextMessageConversationOrderByNestedInput!] """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: OrderByEnum """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: OrderByEnum """Timestamp the message was sent.""" datetimeSent: OrderByEnum """Direction of the message (Incoming, Outgoing).""" direction: OrderByEnum """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: OrderByEnum """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: OrderByEnum """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ChatConversation record. Set exactly one field in each item. """ input ChatConversationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Kind of AI chat: a general conversation with the AI assistant, or one about a specific record identified by context. """ type: OrderByEnum } """ Sorting by a field of the related TextMessageConversation record. Set exactly one field in each item. """ input TextMessageConversationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the sender phone.""" phoneId: OrderByEnum """Id of the matched account.""" recipientAccountId: OrderByEnum """Id of the matched contact.""" recipientContactId: OrderByEnum """ External phone number of the conversation recipient. Cannot be changed once the conversation has started. """ recipientPhoneNumber: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Text message conversation between a Coevera phone number and an external phone number. """ type TextMessageConversationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Coevera phone number used as the sender side of the conversation.""" phone: PhoneEntity """Account record matched to the recipient phone, when one exists.""" recipientAccount: AccountEntity """Contact record matched to the recipient phone, when one exists.""" recipientContact: ContactEntity """Id of the sender phone.""" phoneId: ID! """Id of the matched account.""" recipientAccountId: ID """Id of the matched contact.""" recipientContactId: ID """ External phone number of the conversation recipient. Cannot be changed once the conversation has started. """ recipientPhoneNumber: String """Revision when entity was lastly changed.""" revision: Int """Messages exchanged in the conversation, ordered by send time.""" messages( """Filter TextMessage relations by target TextMessage attributes.""" filter: TextMessageFilterInput """Order TextMessage relations by target TextMessage attributes.""" orderBy: [TextMessageOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageEntityConnection """Accounts linked to this conversation.""" accountRelations( """Filter Account relations by target Account attributes.""" filter: AccountFilterInput """ Filter TextMessageConversationRelations relations by edge (relation) TextMessageConversationRelations attributes. """ filterEdge: TextMessageConversationRelationsFilterInput """Order Account relations by target Account attributes.""" orderBy: [AccountOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationRelationsEntityConnection """Contacts linked to this conversation.""" contactRelations( """Filter Contact relations by target Contact attributes.""" filter: ContactFilterInput """ Filter TextMessageConversationRelations relations by edge (relation) TextMessageConversationRelations attributes. """ filterEdge: TextMessageConversationRelationsFilterInput """Order Contact relations by target Contact attributes.""" orderBy: [ContactOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationRelationsEntityConnection """Projects linked to this conversation.""" projectRelations( """Filter Project relations by target Project attributes.""" filter: ProjectFilterInput """ Filter TextMessageConversationRelations relations by edge (relation) TextMessageConversationRelations attributes. """ filterEdge: TextMessageConversationRelationsFilterInput """Order Project relations by target Project attributes.""" orderBy: [ProjectOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationRelationsEntityConnection """Leads linked to this conversation.""" leadRelations( """Filter Lead relations by target Lead attributes.""" filter: LeadFilterInput """ Filter TextMessageConversationRelations relations by edge (relation) TextMessageConversationRelations attributes. """ filterEdge: TextMessageConversationRelationsFilterInput """Order Lead relations by target Lead attributes.""" orderBy: [LeadOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationRelationsEntityConnection """Opportunities linked to this conversation.""" opportunityRelations( """Filter Opportunity relations by target Opportunity attributes.""" filter: OpportunityFilterInput """ Filter TextMessageConversationRelations relations by edge (relation) TextMessageConversationRelations attributes. """ filterEdge: TextMessageConversationRelationsFilterInput """Order Opportunity relations by target Opportunity attributes.""" orderBy: [OpportunityOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationRelationsEntityConnection """Quotes linked to this conversation.""" quoteRelations( """Filter Quote relations by target Quote attributes.""" filter: QuoteFilterInput """ Filter TextMessageConversationRelations relations by edge (relation) TextMessageConversationRelations attributes. """ filterEdge: TextMessageConversationRelationsFilterInput """Order Quote relations by target Quote attributes.""" orderBy: [QuoteOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationRelationsEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of TextMessageConversationRelations records.""" type TextMessageConversationRelationsEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TextMessageConversationRelationsEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `TextMessageConversationRelationsEntity` and its cursor. """ type TextMessageConversationRelationsEntityEdge { """The item at the end of the edge""" node: TextMessageConversationRelationsEntity """A cursor for use in pagination""" cursor: String! } """ Link between a text message conversation and a record such as an account, contact, lead or opportunity. """ type TextMessageConversationRelationsEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account the conversation is linked to, or empty when not linked.""" account: AccountEntity """Contact the conversation is linked to, or empty when not linked.""" contact: ContactEntity """ Lead the conversation is linked to. Set when leadOpptyId resolves to a Lead. """ lead: LeadEntity """ Opportunity the conversation is linked to. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """Project the conversation is linked to.""" project: ProjectEntity """Quote the conversation is linked to.""" quote: QuoteEntity """Conversation this link belongs to.""" textMessageConversation: TextMessageConversationEntity """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project, or empty when not linked.""" projectId: ID """Id of the linked quote, or empty when not linked.""" quoteId: ID """Id of the text message conversation this link belongs to.""" textMessageConversationId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Structured content of an AI assistant message: example prompts or suggestions for a record. """ union AiMessageData = AiExampleData | AiSuggestionData """Content of an AI assistant message that proposes example prompts.""" type AiExampleData { """Example prompts proposed by the AI assistant.""" examples: [AiExample]! } """Example prompt proposed by the AI assistant.""" type AiExample { """Short title of the example.""" title: String! """Prompt the example sends to the AI assistant.""" prompt: String! } """ Content of an AI assistant message that lists suggestions for a record. """ type AiSuggestionData { """Suggestions the AI assistant made for the record.""" suggestions: [AiRecordSuggestion]! } """ Suggestion the AI assistant makes for a record, such as an alert, news or data enrichment, with the actions the user can take on it. """ type AiRecordSuggestion { """Unique identifier of the suggestion.""" id: ID! """Text of the suggestion.""" text: String! """Short title of the suggestion.""" title: String! """ Actions the user can take on the suggestion, such as creating a task or sending an email; empty when none are proposed. """ actions: [AiAssistantTaskAction]! """Kind of suggestion.""" type: AiRecordSuggestionType! } """ Action the user can take on an AI suggestion: create a record, update the record, send an email or add a note. """ union AiAssistantTaskAction = AiAssistantCreateRecordAction | AiAssistantUpdateFormAction | AiAssistantCreateEmailAction | AiAssistantCreateNoteAction """ Suggested action that creates a record, such as a task or appointment, pre-filled with values proposed by AI. """ type AiAssistantCreateRecordAction { """Entity of the record the action creates, such as Task or Appointment.""" entityName: EntityNameEnum! """ API name of the custom entity when entityName is CustomEntity; null otherwise. """ entityApiName: String """ Id of the action; pass it as actionId to aiAutoPrefill to get the record pre-filled with the values the AI proposes. """ id: ID! } """Suggested action that updates the record with values proposed by AI.""" type AiAssistantUpdateFormAction { """ Id of the action; pass it as actionId to aiAutoPrefill to get the record pre-filled with the values the AI proposes. """ id: ID! } """ Suggested action to send an email whose subject and body the AI assistant has drafted. """ type AiAssistantCreateEmailAction { """Subject of the email the AI proposes.""" subject: String! """Body of the email the AI proposes.""" body: String! } """Suggested action that adds a note with text proposed by AI.""" type AiAssistantCreateNoteAction { """Text of the note the AI proposes.""" note: String! } """Kind of AI suggestion shown for a record.""" enum AiRecordSuggestionType { """Recommended next action for the record.""" Alert """News relevant to the record.""" News """Proposed updates to the record's field values.""" DataEnrichment """Proposed changes to the account hierarchy.""" UpdateAccountHierarchy """Proposed changes to the organization chart of contacts.""" UpdateOrgChart """Proposed changes to the buying center.""" UpdateBuyingCenter } """ AI credits consumed to generate an AI assistant message, and whether the count is final. """ type AiCreditInfo { """Whether the AI work is finished and the credit count is final.""" status: AiCreditInfoStatus! """Number of AI credits consumed so far.""" value: Int } """Whether the AI credit usage reported for a request is final.""" enum AiCreditInfoStatus { """The AI work is still running; the credit count can still grow.""" InProgress """The AI work is done; the credit count is final.""" Finished } """Recording and transcription status of a call.""" enum AudioStatus { """The call has no recording.""" NoRecording """The recording is not available yet.""" Uploading """The recording is available; no transcription is in progress.""" Uploaded """The recording is being transcribed.""" TranscriptionInProgress """Transcription of the recording failed.""" TranscriptionError """The transcription is available.""" TranscriptionCompleted """A transcription was requested but the recording could not be obtained.""" UploadError """ The recording contained nothing to transcribe, for example because the call was too short. """ TranscriptionEmpty } """Paginated list of TaskSharingSalesUnitRelation records.""" type TaskSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TaskSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `TaskSharingSalesUnitRelationEntity` and its cursor. """ type TaskSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: TaskSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Share of a task with a sales unit, with the access level granted.""" type TaskSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Task being shared.""" task: TaskEntity """Sales unit the task is shared with.""" unit: SalesUnitEntity """ Access the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID! """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of TaskSharingClientRelation records.""" type TaskSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TaskSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `TaskSharingClientRelationEntity` and its cursor. """ type TaskSharingClientRelationEntityEdge { """The item at the end of the edge""" node: TaskSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """ Share of a task with an individual user, with the access level granted. """ type TaskSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the task is shared with.""" client: ClientEntity """Task being shared.""" task: TaskEntity """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Reminder a user set to be notified about a task at a given time.""" type TaskReminderEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who set this reminder. Reminders are per-user.""" owner: ClientEntity """Task this reminder belongs to.""" task: TaskEntity """Id of the user who set the reminder.""" ownerId: ID! """Timestamp when the reminder should fire.""" setDate: DateTime! """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Id of the task this reminder belongs to.""" taskId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Recurrence rule that defines when the next occurrences of a recurring task are created. """ type TaskRecurrenceEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Task this recurrence belongs to. Each recurrence is bound to exactly one task. """ task: TaskEntity """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date! """Id of the parent task.""" taskId: ID! """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ActivityComment records.""" type ActivityCommentEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ActivityCommentEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ActivityCommentEntity` and its cursor.""" type ActivityCommentEntityEdge { """The item at the end of the edge""" node: ActivityCommentEntity """A cursor for use in pagination""" cursor: String! } """Comment written by a user on a task or an appointment.""" type ActivityCommentEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment this comment belongs to. Set when activityId resolves to an Appointment; otherwise empty. """ appointment: AppointmentEntity """ Task this comment belongs to. Set when activityId resolves to a Task; otherwise empty. """ task: TaskEntity """User who authored the comment.""" owner: ClientEntity """Id of the appointment or task the comment belongs to.""" activityId: ID! """Free-form text body of the comment.""" comment: String! """Id of the comment author.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of ActivityComment records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ActivityCommentOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment this comment belongs to. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task this comment belongs to. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ User who authored the comment. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Id of the appointment or task the comment belongs to.""" activityId: OrderByEnum """Free-form text body of the comment.""" comment: OrderByEnum """Id of the comment author.""" ownerId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Appointment record. Set exactly one field in each item. """ input AppointmentOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the appointment type.""" activityTypeId: OrderByEnum """Id of the currency exchange rate list applied to this appointment.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the appointment.""" description: OrderByEnum """Duration of the appointment, derived from start/end dates.""" duration: OrderByEnum """End timestamp of the appointment.""" endDate: OrderByEnum """ True when invitees are allowed to edit the appointment. Defaults to false. """ inviteesCanEdit: OrderByEnum """Free-text physical location of the appointment.""" location: OrderByEnum """Id of the appointment owner.""" ownerId: OrderByEnum """Id of the master appointment.""" recurrenceMasterId: OrderByEnum """Id of the appointment schedule.""" scheduleId: OrderByEnum """Start timestamp of the appointment.""" startDate: OrderByEnum """Short summary line shown in calendars and lists.""" subject: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Current status of the appointment (NotStarted, InProgress, Completed, Canceled). Read-only; derived from the start/end times and the deleted flag. """ status: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related Task record. Set exactly one field in each item. """ input TaskOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the task type.""" activityTypeId: OrderByEnum """ Duration of the recorded call. Set automatically when the task is linked to a call log. """ callDuration: OrderByEnum """Id of the linked call record.""" callId: OrderByEnum """ Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). """ callOutcomeId: OrderByEnum """Id of the currency exchange rate list applied to this task.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of what the task entails.""" description: OrderByEnum """Date by which the task is expected to be completed.""" dueDate: OrderByEnum """ Estimated duration of the task. Stored as a duration value (days/hours/minutes). """ duration: OrderByEnum """Id of the task owner.""" ownerId: OrderByEnum """Priority level of the task: Low, Medium or High.""" priority: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: OrderByEnum """Date when work on the task is scheduled to begin.""" startDate: OrderByEnum """Short summary line shown in lists and notifications.""" subject: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """Paginated list of AppointmentContactInviteesRelation records.""" type AppointmentContactInviteesRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AppointmentContactInviteesRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AppointmentContactInviteesRelationEntity` and its cursor. """ type AppointmentContactInviteesRelationEntityEdge { """The item at the end of the edge""" node: AppointmentContactInviteesRelationEntity """A cursor for use in pagination""" cursor: String! } """ Invitation of an external person to an appointment, identified by email and matched to a contact when one exists, with their response. """ type AppointmentContactInviteesRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Appointment the contact has been invited to.""" appointment: AppointmentEntity """Coevera Contact record matching the invitee email, when one exists.""" contact: ContactEntity """Id of the appointment the contact has been invited to.""" appointmentId: ID! """Id of the matched contact.""" contactId: ID """ Email address of the invitee. Required and used as the natural key for the link. """ email: String! """Given name of the invitee, when supplied.""" firstName: String """ How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled). """ inviteeType: AppointmentInviteeTypeEnum """Family name of the invitee, when supplied.""" lastName: String """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of AppointmentContactInviteesRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AppointmentContactInviteesRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment the contact has been invited to. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Coevera Contact record matching the invitee email, when one exists. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """Id of the appointment the contact has been invited to.""" appointmentId: OrderByEnum """Id of the matched contact.""" contactId: OrderByEnum """ Email address of the invitee. Required and used as the natural key for the link. """ email: OrderByEnum """Given name of the invitee, when supplied.""" firstName: OrderByEnum """ How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled). """ inviteeType: OrderByEnum """Family name of the invitee, when supplied.""" lastName: OrderByEnum """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AppointmentClientInviteesRelation records.""" type AppointmentClientInviteesRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AppointmentClientInviteesRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AppointmentClientInviteesRelationEntity` and its cursor. """ type AppointmentClientInviteesRelationEntityEdge { """The item at the end of the edge""" node: AppointmentClientInviteesRelationEntity """A cursor for use in pagination""" cursor: String! } """ Invitation of a user of the space to an appointment, with their response. """ type AppointmentClientInviteesRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Appointment the user has been invited to.""" appointment: AppointmentEntity """Internal user invited to the appointment.""" client: ClientEntity """Id of the appointment the user has been invited to.""" appointmentId: ID! """Id of the user.""" clientId: ID! """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Reminder a user has set for an appointment, notifying them a given time before it starts. """ type AppointmentReminderEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Appointment this reminder belongs to.""" appointment: AppointmentEntity """User who set this reminder. Reminders are per-user.""" owner: ClientEntity """Id of the appointment this reminder belongs to.""" appointmentId: ID! """Seconds before the appointment start when the reminder should fire.""" endDateOffset: Int! """Id of the user who set the reminder.""" ownerId: ID! """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Recurrence of an appointment that belongs to a recurring series.""" type AppointmentRecurrence { """ Recurrence rule of the series in iCalendar (RFC 5545) RRULE format. Empty when the rule is not known. """ rrule: String! """ The recurrence rule as readable text in the language of the current user, e.g. "Every week on Monday". Empty when the rule cannot be read. """ rruleHumanReadable: String! """ Link to open the appointment in Outlook on the web, for series synchronized from Office 365. Empty otherwise. """ calendarUrl: String } """ Label that users attach to records such as accounts, contacts or opportunities to categorize them. """ type TagEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who created the tag.""" creator: ClientEntity """ For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction. """ allowedEntityTypeIds: [UUID] """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int! """Id of the creating user.""" creatorId: ID """ For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags. """ entityApiName: String """ When false, the tag is hidden in pickers and cannot be assigned to new records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: String! """ Bit flags of the entities the tag can be attached to, added together: Contact 1, Account 2, Opportunity 4, Lead 8, Project 16, Email 32, Process 64, Appointment 128, Task 256, Quote 512, CustomEntity 1024, Solution 2048. """ supportedEntities: Int """ When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Activity statistics of a solution for the selected period: counters per canvas node and their totals. Nodes whose record was deleted still count the activity recorded before deletion. """ type SolutionStats { """Sum of createRecordCount over all nodes.""" createRecordTotalCount: Int! """Sum of updateRecordCount over all nodes.""" updateRecordTotalCount: Int! """Sum of linkRecordCount over all nodes.""" linkRecordTotalCount: Int! """Sum of archiveRecordCount over all nodes.""" archiveRecordTotalCount: Int! """Sum of sendEmailCount over all nodes.""" sendEmailTotalCount: Int! """Sum of createResponseCount over all nodes.""" createResponseTotalCount: Int! """Counters of each canvas node, in canvas order.""" nodes: [SolutionNodeStats!]! } """ Activity counters of one canvas node for the selected period (0 when the counter does not apply to the node's type). """ type SolutionNodeStats { """Canvas node id the counters belong to.""" id: ID! """ Records created in the period by Automatizer create or copy actions, email-sequence steps (tasks, leads, text messages) or online-form submissions. """ createRecordCount: Int! """ Records updated in the period by Automatizer update, unarchive or owner-change actions, or by online-form submissions. """ updateRecordCount: Int! """Records linked in the period by Automatizer link actions.""" linkRecordCount: Int! """Records archived in the period by Automatizer archive actions.""" archiveRecordCount: Int! """ Emails sent in the period by Automatizer send-email actions or email-sequence steps. """ sendEmailCount: Int! """Records enrolled into the email sequence in the period.""" enrollCount: Int! """Enrollments that ended by unenrolling in the period.""" unenrollCount: Int! """Online-form submissions received in the period.""" createResponseCount: Int! } """Time window for solution statistics and activity logs.""" enum SolutionStatsPeriodEnum { """The whole history.""" All """The last 7 days.""" Last7Days """The last 30 days.""" Last30Days """The last 90 days.""" Last90Days } """ Paged activity of a solution's tools, newest first. Paging is forward-only (first/after) and stays stable while new runs arrive. """ type SolutionActivityLogConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [SolutionActivityLogEdge]! } """A Relay edge containing a `SolutionActivityLog` and its cursor.""" type SolutionActivityLogEdge { """The item at the end of the edge""" node: SolutionActivityLogEntity """A cursor for use in pagination""" cursor: String! } """ One entry in a solution's activity log: an Automatizer process run, an email-sequence run or an online-form submission. """ union SolutionActivityLogEntity = ProcessActivityLogEntity | EmailSequenceActivityLogEntity | OnlineFormEntity """Paginated list of OnlineForm records.""" type OnlineFormEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OnlineFormEntity` and its cursor.""" type OnlineFormEntityEdge { """The item at the end of the edge""" node: OnlineFormEntity """A cursor for use in pagination""" cursor: String! } """ Sorting of OnlineForm records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OnlineFormOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Currency exchange rate list applied to product line-items at submission time. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Email submitted with the response, used for identification or response notifications. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Online form definition this submission belongs to. Sorts by fields of the related record, listed in order of priority. """ onlineFormType: [OnlineFormTypeOrderByNestedInput!] """ Product price list selected by the respondent, when the form contains products. Sorts by fields of the related record, listed in order of priority. """ productPriceList: [ProductPriceListOrderByNestedInput!] """ Id of the currency exchange rate list applied to product line items at submission time. """ currencyExchangeRatesListId: OrderByEnum """Id of the linked email record, when available.""" emailId: OrderByEnum """Id of the online form definition.""" onlineFormTypeId: OrderByEnum """Id of the selected price list.""" productPriceListId: OrderByEnum """ Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. """ status: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format. """ recordName: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related Email record. Set exactly one field in each item. """ input EmailOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Comma-separated list of blind-carbon-copy recipients.""" bcc: OrderByEnum """ Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. """ bodySummary: OrderByEnum """Comma-separated list of carbon-copy recipients.""" cc: OrderByEnum """ Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmailId: OrderByEnum """ How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). """ contentShareMode: OrderByEnum """MIME content type of the body (e.g. text/html, text/plain).""" contentType: OrderByEnum """ Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. """ dateSent: OrderByEnum """Direction of the email (Incoming, Outgoing).""" direction: OrderByEnum """ Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmailId: OrderByEnum """ Numeric error code recorded when the email failed to send. Zero when no error occurred. """ errorCode: OrderByEnum """ True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. """ isDraft: OrderByEnum """ True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. """ isTracked: OrderByEnum """Id of the email owner.""" ownerId: OrderByEnum """Id of the parent (master) email.""" parentEmailId: OrderByEnum """ Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. """ sendAt: OrderByEnum """Sender address as it appeared on the email (free-text "From" header).""" sender: OrderByEnum """Id of the matched sender account.""" senderAccountId: OrderByEnum """Id of the matched sender user.""" senderClientId: OrderByEnum """Id of the matched sender contact.""" senderContactId: OrderByEnum """ Tone of the email (Negative, Neutral or Positive) as assessed by AI from its content; empty until assessed. Returned only to users with read permission on the email content. """ sentiment: OrderByEnum """ Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Name of the entity and its default text representation.""" subject: OrderByEnum """Id of the email template.""" templateId: OrderByEnum """Comma-separated list of primary recipients.""" to: OrderByEnum """ Whether the email is an individual email (Standard) or part of a mass email (Mass). """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related OnlineFormType record. Set exactly one field in each item. """ input OnlineFormTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. """ autoPrefillWithJavascript: OrderByEnum """Free-text description shown alongside the form definition in the UI.""" description: OrderByEnum """ API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. """ entityApiName: OrderByEnum """ When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. """ isEnabled: OrderByEnum """ True when the form is system-managed and its schema cannot be edited by users. """ isReadonly: OrderByEnum """Timestamp of the most recent change to formEdit (form schema).""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled.""" lastStatusChange: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Id of the form style.""" styleId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Minimum response count required for the form to be considered "responsive" in reports and notifications. Empty when no threshold is configured. """ responseAcceptanceThreshold: OrderByEnum """Total number of times the form link has been delivered to recipients.""" sentCount: OrderByEnum """Number of distinct recipients the form link has been delivered to.""" sentUniqueCount: OrderByEnum """Total number of submissions (responses) recorded for the form.""" responseCount: OrderByEnum """Fraction (0–1) of unique recipients who submitted a response.""" responseRate: OrderByEnum """ Timestamp of the most recent submission. Empty when the form has no responses. """ lastResponseDate: OrderByEnum """ Name or email address of the respondent on the most recent submission. Empty when the form has no responses or the respondent could not be identified. """ lastResponseBy: OrderByEnum """ Names of the solutions whose canvas contains this form, in name order. Empty when the form is on no solution canvas. """ solutions: OrderByEnum """ Overall state of the form: Inactive while it has no active configuration, Active while accepting responses, Completed once the configured end condition is met. """ status: OrderByEnum } """Paginated list of OnlineFormResponseSummary items.""" type OnlineFormResponseSummaryItemConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormResponseSummaryItemEdge]! """Total number of results in the view""" totalCount: Int! } """ A Relay edge containing a `OnlineFormResponseSummaryItem` and its cursor. """ type OnlineFormResponseSummaryItemEdge { """The item at the end of the edge""" node: OnlineFormResponseSummary """A cursor for use in pagination""" cursor: String! } """ A record the form was sent to or that responded to it, with dates and number of responses. """ type OnlineFormResponseSummary { """Id of the record.""" id: ID """Entity of the record.""" type: EntityNameEnum """ False when the record is not visible to the current user; name and pictureUrl are then null. """ isAvailable: Boolean """Display name of the record; null when isAvailable is false.""" name: String """ URL of the record's picture; null when the record has none or isAvailable is false. """ pictureUrl: String """Number of submissions of the form linked to the record.""" numberOfResponses: Int """List of onlineForm ids sorted by modified in ascending order.""" onlineFormIds: [ID!]! """When the form was last sent to the record; null when it was not sent.""" sentDate: DateTime """When the record last responded; null when it has not responded.""" responseDate: DateTime """ Value the submissions of the record contribute toward the response acceptance threshold of the form; null when no threshold is configured. """ summarizedResponseValue: Int } """Group of online-form recipients or respondents to list.""" enum ResponseSummaryRelationCategory { """Respondents who submitted a response.""" Responded """Records the form was sent to.""" Sent """Records the form was sent to that have not responded.""" SentAndNotResponded """Responses not linked to any record.""" UnknownRespondents } """What the recipient summary list of an online form is sorted by.""" enum OnlineFormTypeDetailGridSortBy { """Name of the recipient record.""" EntityName """Date of the latest response.""" ResponseDate """Date the form was sent.""" SentDate """Number of responses from the recipient.""" CountOfResponses """Response score used by the form's response acceptance threshold.""" ResponseValue } """Paginated list of OnlineFormResponse items.""" type OnlineFormResponseItemConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormResponseItemEdge]! """Total number of results in the view""" totalCount: Int! } """A Relay edge containing a `OnlineFormResponseItem` and its cursor.""" type OnlineFormResponseItemEdge { """The item at the end of the edge""" node: OnlineFormResponse """A cursor for use in pagination""" cursor: String! } """A submission of the online form with its answers.""" type OnlineFormResponse { """Entity of the record the submission is linked to.""" entityType: EntityNameEnum """ API name of the custom entity when entityType is CustomEntity; null otherwise. """ entityApiName: String """ Id of the record the submission is linked to; null when it is not linked to any record. """ entityId: ID """ False when the linked record is not visible to the current user; name and pictureUrl are then null. """ entityIsAvailable: Boolean """Name of the linked record.""" name: String """When the submission was received or last changed.""" created: DateTime! """Id of the submission.""" onlineFormId: ID! """URL of the picture of the linked record.""" pictureUrl: String """Answers of the submission, one per form field.""" answers: [OnlineFormFieldAnswer!]! } """ 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 FieldFilterParams { """How the filter boxes combine — And or Or.""" operator: FilterGroupOperator! """Optional boolean formula combining the filter boxes by their number.""" formula: String """Primary group of filter conditions.""" filterMainBox: MainFilterBoxParams! """Additional condition groups, combined per operator/formula.""" filterSiblingBoxes: [FilterBoxParams!]! """When false, the filter is ignored and all records match.""" isEnabled: Boolean! } """ Group of filter conditions evaluated on the main record type of a filter. """ input MainFilterBoxParams { """Identifier of this filter box within the filter tab.""" id: String! """ Name of the record type whose fields the conditions in this box are evaluated against. """ entity: String! """ 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. """ lookupFieldId: UUID """ Conditions evaluated on the main record type, each comparing one field against a set of values. """ filterFields: [FieldFilterRuleParams!]! } """Filter condition that compares one field with a set of values.""" input FieldFilterRuleParams { """ Identifier of this condition within the filter box. Used to reference the condition from the box formula. """ id: UUID """Identifier of the field this condition is evaluated against.""" field: String! """ Comparison applied between the field and the supplied values (for example Is, IsNot, Contains, Between, IsEmpty). """ operator: FieldOperator """ 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). """ values: [[String]] } """ Group of filter conditions evaluated on records related to the main record type, reached through a lookup field or a predefined relation. """ input FilterBoxParams { """Identifier of this filter box within the filter tab.""" id: String! """ Name of the record type whose fields the conditions in this box are evaluated against. """ entity: String! """ 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. """ lookupFieldId: UUID """ Predefined relationship linking this sibling box to the main record type. Null when the box is connected through a lookup field instead. """ relation: HardCodedRelationParams """ Conditions evaluated on this box, each comparing one field against a set of values. """ filterFields: [FieldFilterRuleParams!]! } """Predefined relation that links a filter box to the filtered records.""" input HardCodedRelationParams { """ Predefined relationship that links this filter box to the main record type (for example Primary, Aggregation, NextScheduledActivity). """ kind: SiblingRelationType! } """What the list of responses to an online form is sorted by.""" enum OnlineFormTypeDetailResponseGridSortBy { """Name of the responding record.""" EntityName """Date the response was submitted.""" ResponseDate """Answer to the form field given in sortByFieldId.""" ResponseValue } """ Files uploaded through the submissions of an online form type, with a request id for downloading them as a ZIP archive. """ type OnlineFormUploadedFiles { """ Id of the result holding the returned files; pass it as sessionId, e.g. to CloudObjectRepository.getBySession or to bulk operations. """ sessionId: String! """ Request id of a ZIP archive of the files, organized by form, record and field; poll getBulkDownloadStatus with it to get the download URL. Null when there are no files. """ downloadSessionId: String """Uploaded files, ordered by record, submission, field and file name.""" cloudObjects: [CloudObjectEntity!]! } """Width and height of an image file, in pixels.""" type CloudObjectDimensions { """Width of the image in pixels.""" width: Int! """Height of the image in pixels.""" height: Int! } """Paginated list of SalesUnitClientRelation records.""" type SalesUnitClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [SalesUnitClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `SalesUnitClientRelationEntity` and its cursor. """ type SalesUnitClientRelationEntityEdge { """The item at the end of the edge""" node: SalesUnitClientRelationEntity """A cursor for use in pagination""" cursor: String! } """Membership of a user in a sales unit, as a member or manager.""" type SalesUnitClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User belonging to the sales unit.""" client: ClientEntity """Sales unit the user belongs to.""" unit: SalesUnitEntity """Id of the user.""" clientId: ID! """Id of the sales unit.""" unitId: ID! """ Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit. """ unitRole: UnitRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of ClientFavorite records.""" type ClientFavoriteEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ClientFavoriteEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ClientFavoriteEntity` and its cursor.""" type ClientFavoriteEntityEdge { """The item at the end of the edge""" node: ClientFavoriteEntity """A cursor for use in pagination""" cursor: String! } """Record or screen profile that a user has marked as a favorite.""" type ClientFavoriteEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account marked as favorite, when this favorite points to an account.""" account: AccountEntity """ Appointment marked as favorite. Set when activityId resolves to an Appointment. """ appointment: AppointmentEntity """Task marked as favorite. Set when activityId resolves to a Task.""" task: TaskEntity """Contact marked as favorite, when this favorite points to a contact.""" contact: ContactEntity """ Custom entity record marked as favorite, when this favorite points to a custom entity. """ customEntity: CustomEntityEntity """Email marked as favorite, when this favorite points to an email.""" email: EmailEntity """Lead marked as favorite. Set when leadOpptyId resolves to a Lead.""" lead: LeadEntity """ Opportunity marked as favorite. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """User who marked the record as favorite.""" owner: ClientEntity """ Screen profile marked as favorite, when this favorite points to a profile. """ profile: ProfileEntity """Project marked as favorite, when this favorite points to a project.""" project: ProjectEntity """Quote marked as favorite, when this favorite points to a quote.""" quote: QuoteEntity """Report marked as favorite, when this favorite points to a report.""" report: ReportEntity """Id of the favorite account.""" accountId: ID """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: ID """Id of the favorite contact.""" contactId: ID """Id of the favorite custom entity record.""" customEntityId: ID """Id of the favorite email.""" emailId: ID """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the owning user.""" ownerId: ID! """Id of the favorite screen profile.""" profileId: ID """Id of the favorite project.""" projectId: ID """Id of the favorite quote.""" quoteId: ID """Id of the favorite report.""" reportId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of Appointment records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AppointmentOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment type that classifies this appointment. Drives form layout and icon. Sorts by fields of the related record, listed in order of priority. """ activityType: [AppointmentTypeOrderByNestedInput!] """ Currency exchange rate list used to convert monetary fields linked to this appointment. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Sales user who owns this appointment. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Master appointment of the recurring series this occurrence belongs to. Empty for standalone appointments and for the master itself. Sorts by fields of the related record, listed in order of priority. """ recurrenceMaster: [AppointmentOrderByNestedInput!] """ Appointment schedule (booking link) this appointment was created through, or empty for appointments created directly. Sorts by fields of the related record, listed in order of priority. """ schedule: [AppointmentScheduleOrderByNestedInput!] """ Sales unit this appointment is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the appointment type.""" activityTypeId: OrderByEnum """Id of the currency exchange rate list applied to this appointment.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the appointment.""" description: OrderByEnum """Duration of the appointment, derived from start/end dates.""" duration: OrderByEnum """End timestamp of the appointment.""" endDate: OrderByEnum """ True when invitees are allowed to edit the appointment. Defaults to false. """ inviteesCanEdit: OrderByEnum """Free-text physical location of the appointment.""" location: OrderByEnum """Id of the appointment owner.""" ownerId: OrderByEnum """Id of the master appointment.""" recurrenceMasterId: OrderByEnum """Id of the appointment schedule.""" scheduleId: OrderByEnum """Start timestamp of the appointment.""" startDate: OrderByEnum """Short summary line shown in calendars and lists.""" subject: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Current status of the appointment (NotStarted, InProgress, Completed, Canceled). Read-only; derived from the start/end times and the deleted flag. """ status: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: OrderByEnum """ Reminder set by the current authenticated user for this appointment. Per-user; empty when no reminder has been set. Sorts by fields of the related record, listed in order of priority. """ reminder: [AppointmentReminderOrderByNestedInput!] """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related AppointmentSchedule record. Set exactly one field in each item. """ input AppointmentScheduleOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Description applied to appointments booked through this schedule.""" appointmentDescription: OrderByEnum """Duration of each booked appointment.""" appointmentDuration: OrderByEnum """Location applied to appointments booked through this schedule.""" appointmentLocation: OrderByEnum """ Where booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. """ appointmentLocationType: OrderByEnum """Id of the user receiving the booking.""" appointmentOwnerId: OrderByEnum """Subject applied to appointments booked through this schedule.""" appointmentSubject: OrderByEnum """ When true, booked appointments use the scheduleName as their subject instead of appointmentSubject. """ appointmentSubjectUsesScheduleName: OrderByEnum """ Id of the appointment type used for appointments booked through the schedule. """ appointmentTypeId: OrderByEnum """ Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeAfter: OrderByEnum """ Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeBefore: OrderByEnum """ What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). """ confirmationPageType: OrderByEnum """ Custom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect. """ confirmationPageUrl: OrderByEnum """ Master switch for the schedule. Disabled schedules do not accept new bookings. """ isEnabled: OrderByEnum """ Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). """ minimumNoticeTime: OrderByEnum """ Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name. """ name: OrderByEnum """Id of the schedule owner.""" ownerId: OrderByEnum """ With Offset planning, how many days ahead the schedule remains bookable. """ planningDayOffset: OrderByEnum """With Period planning, first date bookings are accepted for.""" planningPeriodFrom: OrderByEnum """With Period planning, last date bookings are accepted for.""" planningPeriodTo: OrderByEnum """ Time window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period). """ planningType: OrderByEnum """ True when a reminder email is sent to invitees ahead of the booked appointment. """ reminderEmailEnabled: OrderByEnum """ Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType. """ reminderEmailOffset: OrderByEnum """Time unit of reminderEmailOffset: Minute, Hour, Day or Week.""" reminderEmailOffsetType: OrderByEnum """ Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmailId: OrderByEnum """ Public-facing name of the schedule, shown to bookers on the booking page. """ scheduleName: OrderByEnum """ Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). """ timeIncrement: OrderByEnum """ Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. """ type: OrderByEnum """Public URL slug of the schedule, used to share the booking page.""" url: OrderByEnum } """ Sorting by a field of the related AppointmentReminder record. Set exactly one field in each item. """ input AppointmentReminderOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the appointment this reminder belongs to.""" appointmentId: OrderByEnum """Seconds before the appointment start when the reminder should fire.""" endDateOffset: OrderByEnum """Id of the user who set the reminder.""" ownerId: OrderByEnum """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: OrderByEnum """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of Task records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TaskOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Task type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon. Sorts by fields of the related record, listed in order of priority. """ activityType: [TaskTypeOrderByNestedInput!] """ Call record associated with this task when the task represents a phone call. Sorts by fields of the related record, listed in order of priority. """ call: [CallOrderByNestedInput!] """ Configurable outcome of the call (e.g. Reached, Voicemail, No Answer). Sorts by fields of the related record, listed in order of priority. """ callOutcome: [DataOrderByNestedInput!] """ Currency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Sales user who owns this task. May be empty when the task is unassigned and available for take-over. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Sales unit this task is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the task type.""" activityTypeId: OrderByEnum """ Duration of the recorded call. Set automatically when the task is linked to a call log. """ callDuration: OrderByEnum """Id of the linked call record.""" callId: OrderByEnum """ Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). """ callOutcomeId: OrderByEnum """Id of the currency exchange rate list applied to this task.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of what the task entails.""" description: OrderByEnum """Date by which the task is expected to be completed.""" dueDate: OrderByEnum """ Estimated duration of the task. Stored as a duration value (days/hours/minutes). """ duration: OrderByEnum """Id of the task owner.""" ownerId: OrderByEnum """Priority level of the task: Low, Medium or High.""" priority: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: OrderByEnum """Date when work on the task is scheduled to begin.""" startDate: OrderByEnum """Short summary line shown in lists and notifications.""" subject: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: OrderByEnum """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: OrderByEnum """ Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. Sorts by fields of the related record, listed in order of priority. """ reminder: [TaskReminderOrderByNestedInput!] """ Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. Sorts by fields of the related record, listed in order of priority. """ taskRecurrence: [TaskRecurrenceOrderByNestedInput!] """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related Call record. Set exactly one field in each item. """ input CallOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the linked account.""" accountId: OrderByEnum """Id of the calling user.""" callerId: OrderByEnum """Id of the user the call was made with.""" clientId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: OrderByEnum """Id of the linked opportunity product line-item.""" opptyProductRelationId: OrderByEnum """External phone number called or received, in E.164 format.""" phoneNumber: OrderByEnum """Id of the linked product.""" productId: OrderByEnum """External transcription identifier from the calling provider.""" transcriptionId: OrderByEnum """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US"). """ transcriptionLanguage: OrderByEnum """AI-generated summary of the call transcription.""" transcriptionSummary: OrderByEnum } """ Sorting by a field of the related TaskReminder record. Set exactly one field in each item. """ input TaskReminderOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the user who set the reminder.""" ownerId: OrderByEnum """Timestamp when the reminder should fire.""" setDate: OrderByEnum """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: OrderByEnum """Id of the task this reminder belongs to.""" taskId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related TaskRecurrence record. Set exactly one field in each item. """ input TaskRecurrenceOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: OrderByEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: OrderByEnum """ Date information. The last date when no more other items should be created. """ endDate: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: OrderByEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: OrderByEnum """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: OrderByEnum """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: OrderByEnum """Id of the parent task.""" taskId: OrderByEnum """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting of Report records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ReportOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the report or dashboard. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Report folder this report is filed under (default folder when empty). Sorts by fields of the related record, listed in order of priority. """ reportsFolder: [ReportFolderOrderByNestedInput!] """ Specific record this report is synchronized to. Set only when syncEnabled is true. Sorts by fields of the related record, listed in order of priority. """ syncEntity: [ProfileOrderByNestedInput!] """ Public access token used in shareable report URLs. Empty when public sharing is not configured for the report. """ accessLink: OrderByEnum """Free-text description shown alongside the report.""" description: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Id of the parent report folder.""" reportsFolderId: OrderByEnum """ Who besides the owner can access the report: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit). """ shareMode: OrderByEnum """ When true, name and settings are kept in sync with the linked screen profile; when false, the report is detached from profile sync. """ syncEnabled: OrderByEnum """Id of the synchronized record.""" syncEntityId: OrderByEnum """ Kind of report: a table or pivot report, a dashboard, an opportunity forecast, or an advanced report built from several linked tables. """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ The calling user's scheduled email delivery of this report; empty when none is set. Set it with `setScheduleReport` and remove it with `removeScheduleReport`. Sorts by fields of the related record, listed in order of priority. """ schedule: [ReportScheduleOrderByNestedInput!] } """ Sorting by a field of the related ReportFolder record. Set exactly one field in each item. """ input ReportFolderOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the parent folder, or empty for top-level folders.""" parentReportFolderId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Profile record. Set exactly one field in each item. """ input ProfileOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity. """ entity: OrderByEnum """ API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty. """ entityApiName: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users. """ shareMode: OrderByEnum """ When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records. """ syncEnabled: OrderByEnum """Id of the synchronized record.""" syncEntityId: OrderByEnum """ When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ReportSchedule record. Set exactly one field in each item. """ input ReportScheduleOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Id of the scheduled report.""" reportId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """State of the recalculation of a user's record access.""" enum UserRecalculationStateEnum { """The user's access is up to date.""" NoRecalculation """Recalculation is running.""" InProgress """Recalculation is queued.""" Pending } """ Kind of parent-child relationship between accounts (e.g. parent company and subsidiary), with a label for each side. """ type ParentAccountRelationTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). """ childLabel: String! """ Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). """ parentLabel: String! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Social network profiles of an account, such as its LinkedIn, Twitter or Facebook pages. """ type AccountSocialRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity. Must match with Account id.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the account.""" angellistUrl: String """Crunchbase profile URL of the account.""" crunchbaseUrl: String """Disqus profile URL of the account.""" disqusUrl: String """Facebook page or profile id of the account.""" facebookId: String """Facebook profile URL of the account.""" facebookUrl: String """Flickr profile URL of the account.""" flickrUrl: String """Foursquare profile URL of the account.""" foursquareUrl: String """Google business or profile id of the account.""" googleId: String """Google+ profile URL of the account.""" googlePlusUrl: String """Gravatar profile URL of the account.""" gravatarUrl: String """Klout profile URL of the account.""" kloutUrl: String """LinkedIn company or profile id of the account.""" linkedinId: String """LinkedIn profile URL of the account.""" linkedinUrl: String """Pinterest profile URL of the account.""" pinterestUrl: String """Quora profile URL of the account.""" quoraUrl: String """Reddit profile URL of the account.""" redditUrl: String """Skype contact URL or username of the account.""" skypeUrl: String """SlideShare profile URL of the account.""" slideshareUrl: String """Twitter (X) user id of the account.""" twitterId: String """Twitter (X) profile URL of the account.""" twitterUrl: String """Vimeo profile URL of the account.""" vimeoUrl: String """WordPress site URL of the account.""" wordpressUrl: String """XING profile URL of the account.""" xingUrl: String """Yahoo profile URL of the account.""" yahooUrl: String """Yelp business URL of the account.""" yelpUrl: String """YouTube channel URL of the account.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of AccountSharingSalesUnitRelation records.""" type AccountSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AccountSharingSalesUnitRelationEntity` and its cursor. """ type AccountSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: AccountSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Sharing of an account with a sales unit, as a watcher or an editor.""" type AccountSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account being shared.""" account: AccountEntity """Sales unit the account is shared with.""" unit: SalesUnitEntity """Id of the shared account.""" accountId: ID! """ Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of AccountSharingClientRelation records.""" type AccountSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AccountSharingClientRelationEntity` and its cursor. """ type AccountSharingClientRelationEntityEdge { """The item at the end of the edge""" node: AccountSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """Sharing of an account with a user, as a watcher or an editor.""" type AccountSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account being shared.""" account: AccountEntity """User the account is shared with.""" client: ClientEntity """Id of the shared account.""" accountId: ID! """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Health of a record: its score, its trend and the result of each indicator rule. """ type EntityHealthResult { """ Health score of the record from 0 to 100: the share of the points of the met rules. -1 when a critical rule is not met. """ score: Int! """How the score changed compared with the previous calculation.""" trend: EntityHealthTrendEnum! """ Result of each health indicator rule, the rules that are not met first. """ indicators: [EntityHealthIndicator!]! """When the health of the record was last calculated.""" lastCalculation: DateTime! } """ How a record's health score changed compared with the previous calculation. """ enum EntityHealthTrendEnum { """The score went up.""" Increasing """The score went down.""" Decreasing """The score stayed the same, or there is no earlier score.""" NoChange """The score falls into the critical health category.""" Critical } """Result of one health indicator rule for a record.""" type EntityHealthIndicator { """Id of the health indicator rule.""" id: ID! """Health indicator rule that was evaluated.""" rule: EntityHealthFieldFilterRule! """Result of the rule for the record.""" indicator: EntityHealthIndicatorEnum! """ Value of the evaluated field on the record at the time of the calculation. """ value: JSONString } """Result of one health indicator rule for a record.""" enum EntityHealthIndicatorEnum { """The record meets the rule.""" Ok """The record does not meet the rule and loses its points.""" Error """ The record does not meet a critical rule, which puts it in the critical health category. """ Critical } """Paginated list of Account records.""" type AccountEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AccountEntity` and its cursor.""" type AccountEntityEdge { """The item at the end of the edge""" node: AccountEntity """A cursor for use in pagination""" cursor: String! } """ New, unsaved account pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in. """ type AccountAutoPrefill { """New account carrying the pre-filled values; it is not saved.""" entity: AccountEntity """Ids of the fields that were filled in.""" fieldIds: [UUID!]! } """Read operations for AccountDataExRelation records.""" type AccountDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Option selected in a multi-select checkbox field of an account; there is one link per selected option. """ type AccountDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account on which the option is selected.""" account: AccountEntity """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Id of the account on which the option is selected.""" accountId: ID! """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for AccountDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account on which the option is selected.""" accountId: EntityFilterStringField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account on which the option is selected. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput } """ Sorting of AccountDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """Id of the account on which the option is selected.""" accountId: OrderByEnum """Id of the selected option.""" dataId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AccountDataExRelation records.""" type AccountDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AccountDataExRelationEntity` and its cursor. """ type AccountDataExRelationEntityEdge { """The item at the end of the edge""" node: AccountDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for AccountKPI records.""" type AccountKPIRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountKPIEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountKPIEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountKPIFilterInput """Sorting of the returned records.""" orderBy: [AccountKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountKPIEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountKPIFilterInput """Sorting of the returned records.""" orderBy: [AccountKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountKPIEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Recorded KPI event of an account, such as its creation, archiving or the first and last email sent, used in KPI reports. """ type AccountKPIEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account this KPI event relates to.""" account: AccountEntity """ User who triggered the KPI event (e.g. created or archived the account, sent the first email). """ client: ClientEntity """Account owner at the time the KPI event occurred.""" owner: ClientEntity """Sales unit the triggering user belonged to at the time of the event.""" unit: SalesUnitEntity """Id of the account this KPI event relates to.""" accountId: ID! """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: AccountKpiEnum! """Id of the account owner at the time of the event.""" ownerId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of account event recorded as a KPI entry; each account keeps at most one entry per kind. """ enum AccountKpiEnum { """The account was created.""" CreateAccount """The most recent email was sent to the account.""" LastEmailSent """The first email was sent to the account.""" FirstEmailSent """The account was archived; the entry is removed when it is unarchived.""" Archive """The account was last modified.""" LastModified } """ Filter conditions for AccountKPI records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountKPIFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountKPIFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountKPIFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountKPIFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account this KPI event relates to.""" accountId: EntityFilterStringField """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: EntityFilterStringField """Id of the user who triggered the event.""" clientId: EntityFilterStringField """ KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: AccountKpiEnumFilterInput """Id of the account owner at the time of the event.""" ownerId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account this KPI event relates to. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ User who triggered the KPI event (e.g. created or archived the account, sent the first email). Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Account owner at the time the KPI event occurred. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales unit the triggering user belonged to at the time of the event. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccountKpiEnumFilterInput { """Matches any of the listed values.""" eq: [AccountKpiEnum!] """Matches values that do not meet this condition.""" NOT: AccountKpiEnumFilterInput } """ Sorting of AccountKPI records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountKPIOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account this KPI event relates to. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ User who triggered the KPI event (e.g. created or archived the account, sent the first email). Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Account owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Sales unit the triggering user belonged to at the time of the event. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the account this KPI event relates to.""" accountId: OrderByEnum """Id of the user who triggered the event.""" clientId: OrderByEnum """Id of the account owner at the time of the event.""" ownerId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AccountKPI records.""" type AccountKPIEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountKPIEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AccountKPIEntity` and its cursor.""" type AccountKPIEntityEdge { """The item at the end of the edge""" node: AccountKPIEntity """A cursor for use in pagination""" cursor: String! } """Read operations for AccountProductPricing records.""" type AccountProductPricingRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountProductPricingEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountProductPricingEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountProductPricingFilterInput """Sorting of the returned records.""" orderBy: [AccountProductPricingOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountProductPricingEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountProductPricingFilterInput """Sorting of the returned records.""" orderBy: [AccountProductPricingOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountProductPricingEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Special price of a product for one account, used instead of the regular price when the product is sold to that account. """ type AccountProductPricingEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account that this price override applies to.""" account: AccountEntity """Currency of the override price.""" currency: CurrencyEntity """Product whose price is overridden for this account.""" product: ProductEntity """Id of the account the price override applies to.""" accountId: ID! """Id of the currency the override price is expressed in.""" currencyId: ID! """ Price applied for this product when sold to this account, in the specified currency. """ price: Float """Id of the product whose price is overridden for the account.""" productId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for AccountProductPricing records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountProductPricingFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountProductPricingFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountProductPricingFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountProductPricingFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account the price override applies to.""" accountId: EntityFilterStringField """Id of the currency the override price is expressed in.""" currencyId: EntityFilterStringField """ Price applied for this product when sold to this account, in the specified currency. """ price: EntityFilterNumberField """Id of the product whose price is overridden for the account.""" productId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account that this price override applies to. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Currency of the override price. Matches records where a related record meets these conditions. """ currency: CurrencyFilterInput """ Product whose price is overridden for this account. Matches records where a related record meets these conditions. """ product: ProductFilterInput } """ Sorting of AccountProductPricing records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountProductPricingOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account that this price override applies to. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Currency of the override price. Sorts by fields of the related record, listed in order of priority. """ currency: [CurrencyOrderByNestedInput!] """ Product whose price is overridden for this account. Sorts by fields of the related record, listed in order of priority. """ product: [ProductOrderByNestedInput!] """Id of the account the price override applies to.""" accountId: OrderByEnum """Id of the currency the override price is expressed in.""" currencyId: OrderByEnum """ Price applied for this product when sold to this account, in the specified currency. """ price: OrderByEnum """Id of the product whose price is overridden for the account.""" productId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Currency record. Set exactly one field in each item. """ input CurrencyOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" code: OrderByEnum """ True for the space's base currency. There is exactly one base currency per space and it cannot be deleted. """ isBase: OrderByEnum """ Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI. """ symbol: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Product record. Set exactly one field in each item. """ input ProductOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: OrderByEnum """Free-form description of the product.""" description: OrderByEnum """Name of the product, shown in catalogues and pickers.""" name: OrderByEnum """ Id of the product category this product belongs to, or empty when it is not categorized. """ productCategoryId: OrderByEnum """Id of the product type that classifies this product.""" productTypeId: OrderByEnum """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: OrderByEnum """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """Paginated list of AccountProductPricing records.""" type AccountProductPricingEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountProductPricingEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AccountProductPricingEntity` and its cursor. """ type AccountProductPricingEntityEdge { """The item at the end of the edge""" node: AccountProductPricingEntity """A cursor for use in pagination""" cursor: String! } """Read operations for AccountRelation records.""" type AccountRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountRelationEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Link between two related accounts, such as partners or a supplier and its customer; its labels give the kind of relationship. """ type AccountRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """One side of the account-to-account relationship.""" account1: AccountEntity """Other side of the account-to-account relationship.""" account2: AccountEntity """Id of the first related account.""" account1Id: ID! """Id of the second related account.""" account2Id: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for AccountRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the first related account.""" account1Id: EntityFilterStringField """Id of the second related account.""" account2Id: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ One side of the account-to-account relationship. Matches records where a related record meets these conditions. """ account1: AccountFilterInput """ Other side of the account-to-account relationship. Matches records where a related record meets these conditions. """ account2: AccountFilterInput } """ Sorting of AccountRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ One side of the account-to-account relationship. Sorts by fields of the related record, listed in order of priority. """ account1: [AccountOrderByNestedInput!] """ Other side of the account-to-account relationship. Sorts by fields of the related record, listed in order of priority. """ account2: [AccountOrderByNestedInput!] """Id of the first related account.""" account1Id: OrderByEnum """Id of the second related account.""" account2Id: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AccountRelationLabel records.""" type AccountRelationLabelRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountRelationLabelEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountRelationLabelEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountRelationLabelFilterInput """Sorting of the returned records.""" orderBy: [AccountRelationLabelOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountRelationLabelEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountRelationLabelFilterInput """Sorting of the returned records.""" orderBy: [AccountRelationLabelOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountRelationLabelEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Relationship type assigned to a link between two accounts, such as Partner or Supplier. """ type AccountRelationLabelEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account relationship being labelled.""" accountRelation: AccountRelationEntity """Type of the relationship (e.g. partner, supplier).""" accountRelationType: AccountRelationTypeEntity """Id of the account relationship.""" accountRelationId: ID! """Id of the relationship type.""" accountRelationTypeId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of relationship that can be assigned to a link between two accounts, such as Partner or Supplier, with its display color. """ type AccountRelationTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """ Display label of the account-to-account relationship type (e.g. Partner, Supplier). """ label: String """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for AccountRelationLabel records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountRelationLabelFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountRelationLabelFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountRelationLabelFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountRelationLabelFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account relationship.""" accountRelationId: EntityFilterStringField """Id of the relationship type.""" accountRelationTypeId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account relationship being labelled. Matches records where a related record meets these conditions. """ accountRelation: AccountRelationFilterInput """ Type of the relationship (e.g. partner, supplier). Matches records where a related record meets these conditions. """ accountRelationType: AccountRelationTypeFilterInput } """ Filter conditions for AccountRelationType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input AccountRelationTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [AccountRelationTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [AccountRelationTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: AccountRelationTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """ Display label of the account-to-account relationship type (e.g. Partner, Supplier). """ label: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Sorting of AccountRelationLabel records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountRelationLabelOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account relationship being labelled. Sorts by fields of the related record, listed in order of priority. """ accountRelation: [AccountRelationOrderByNestedInput!] """ Type of the relationship (e.g. partner, supplier). Sorts by fields of the related record, listed in order of priority. """ accountRelationType: [AccountRelationTypeOrderByNestedInput!] """Id of the account relationship.""" accountRelationId: OrderByEnum """Id of the relationship type.""" accountRelationTypeId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related AccountRelation record. Set exactly one field in each item. """ input AccountRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the first related account.""" account1Id: OrderByEnum """Id of the second related account.""" account2Id: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related AccountRelationType record. Set exactly one field in each item. """ input AccountRelationTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """ Display label of the account-to-account relationship type (e.g. Partner, Supplier). """ label: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AccountRelationType records.""" type AccountRelationTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountRelationTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountRelationTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [AccountRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountRelationTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [AccountRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountRelationTypeEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AccountRelationType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountRelationTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """ Display label of the account-to-account relationship type (e.g. Partner, Supplier). """ label: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AccountRole records.""" type AccountRoleRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountRoleEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountRoleEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountRoleFilterInput """Sorting of the returned records.""" orderBy: [AccountRoleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountRoleEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountRoleFilterInput """Sorting of the returned records.""" orderBy: [AccountRoleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountRoleEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AccountRole records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountRoleOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" label: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AccountRole records.""" type AccountRoleEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountRoleEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AccountRoleEntity` and its cursor.""" type AccountRoleEntityEdge { """The item at the end of the edge""" node: AccountRoleEntity """A cursor for use in pagination""" cursor: String! } """Read operations for AccountSharingClientRelation records.""" type AccountSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AccountSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account being shared. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ User the account is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """Id of the shared account.""" accountId: OrderByEnum """Id of the user.""" clientId: OrderByEnum """ Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AccountSharingSalesUnitRelation records.""" type AccountSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AccountSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account being shared. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Sales unit the account is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared account.""" accountId: OrderByEnum """ Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AccountSocialRelation records.""" type AccountSocialRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountSocialRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountSocialRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountSocialRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountSocialRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountSocialRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountSocialRelationFilterInput """Sorting of the returned records.""" orderBy: [AccountSocialRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountSocialRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AccountSocialRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AccountSocialRelationOrderByInput { """Unique identifier of entity. Must match with Account id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """AngelList profile URL of the account.""" angellistUrl: OrderByEnum """Crunchbase profile URL of the account.""" crunchbaseUrl: OrderByEnum """Disqus profile URL of the account.""" disqusUrl: OrderByEnum """Facebook profile URL of the account.""" facebookUrl: OrderByEnum """Flickr profile URL of the account.""" flickrUrl: OrderByEnum """Foursquare profile URL of the account.""" foursquareUrl: OrderByEnum """Google+ profile URL of the account.""" googlePlusUrl: OrderByEnum """Gravatar profile URL of the account.""" gravatarUrl: OrderByEnum """Klout profile URL of the account.""" kloutUrl: OrderByEnum """LinkedIn profile URL of the account.""" linkedinUrl: OrderByEnum """Pinterest profile URL of the account.""" pinterestUrl: OrderByEnum """Quora profile URL of the account.""" quoraUrl: OrderByEnum """Reddit profile URL of the account.""" redditUrl: OrderByEnum """Skype contact URL or username of the account.""" skypeUrl: OrderByEnum """SlideShare profile URL of the account.""" slideshareUrl: OrderByEnum """Twitter (X) profile URL of the account.""" twitterUrl: OrderByEnum """Vimeo profile URL of the account.""" vimeoUrl: OrderByEnum """WordPress site URL of the account.""" wordpressUrl: OrderByEnum """XING profile URL of the account.""" xingUrl: OrderByEnum """Yahoo profile URL of the account.""" yahooUrl: OrderByEnum """Yelp business URL of the account.""" yelpUrl: OrderByEnum """YouTube channel URL of the account.""" youtubeUrl: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AccountSocialRelation records.""" type AccountSocialRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountSocialRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `AccountSocialRelationEntity` and its cursor. """ type AccountSocialRelationEntityEdge { """The item at the end of the edge""" node: AccountSocialRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for AccountType records.""" type AccountTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AccountTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AccountTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountTypeFilterInput """Sorting of the returned records.""" orderBy: [AccountTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AccountTypeFilterInput """Sorting of the returned records.""" orderBy: [AccountTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AccountTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AccountTypeFilterInput """Sorting of the returned records.""" orderBy: [AccountTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AccountTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: AccountTypeFilterInput """Sorting of the returned records.""" orderBy: [AccountTypeOrderByInput!] ): [AccountTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): AccountTypeEntity! } """Paginated list of AccountType records.""" type AccountTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AccountTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AccountTypeEntity` and its cursor.""" type AccountTypeEntityEdge { """The item at the end of the edge""" node: AccountTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Activity records.""" type ActivityRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ActivityEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ActivityEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ActivityFilterInput """Sorting of the returned records.""" orderBy: [ActivityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ActivityEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ActivityFilterInput """Sorting of the returned records.""" orderBy: [ActivityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Task or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern. """ type ActivityEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """ Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending. """ activeReminder: String """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! } """ Filter conditions for Activity records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ActivityFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ActivityFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ActivityFilterInput!] """Matches records that do not meet this filter.""" NOT: ActivityFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField } """ Sorting of Activity records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ActivityOrderByInput { """Unique identifier of entity.""" id: OrderByEnum } """Paginated list of Activity records.""" type ActivityEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ActivityEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ActivityEntity` and its cursor.""" type ActivityEntityEdge { """The item at the end of the edge""" node: ActivityEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ActivityComment records.""" type ActivityCommentRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ActivityCommentEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ActivityCommentEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ActivityCommentFilterInput """Sorting of the returned records.""" orderBy: [ActivityCommentOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ActivityCommentEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ActivityCommentFilterInput """Sorting of the returned records.""" orderBy: [ActivityCommentOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityCommentEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for ActivityDataExRelation records.""" type ActivityDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ActivityDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ActivityDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ActivityDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ActivityDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ActivityDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ActivityDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ActivityDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Option selected in a multi-select checkbox field of a task or an appointment; there is one link per selected option. """ type ActivityDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment on which the option is selected; empty when activityId is a task. """ appointment: AppointmentEntity """ Task on which the option is selected; empty when activityId is an appointment. """ task: TaskEntity """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Id of the appointment or task on which the option is selected.""" activityId: ID! """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ActivityDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ActivityDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ActivityDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ActivityDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ActivityDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment or task on which the option is selected.""" activityId: EntityFilterStringField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment on which the option is selected; empty when activityId is a task. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task on which the option is selected; empty when activityId is an appointment. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput } """ Sorting of ActivityDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ActivityDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment on which the option is selected; empty when activityId is a task. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task on which the option is selected; empty when activityId is an appointment. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """Id of the appointment or task on which the option is selected.""" activityId: OrderByEnum """Id of the selected option.""" dataId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ActivityDataExRelation records.""" type ActivityDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ActivityDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ActivityDataExRelationEntity` and its cursor. """ type ActivityDataExRelationEntityEdge { """The item at the end of the edge""" node: ActivityDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ActivityKPI records.""" type ActivityKPIRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ActivityKPIEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ActivityKPIEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ActivityKPIFilterInput """Sorting of the returned records.""" orderBy: [ActivityKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ActivityKPIEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ActivityKPIFilterInput """Sorting of the returned records.""" orderBy: [ActivityKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityKPIEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Recorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports. """ type ActivityKPIEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment this KPI event relates to. Set when activityId resolves to an Appointment; otherwise empty. """ appointment: AppointmentEntity """ Task this KPI event relates to. Set when activityId resolves to a Task; otherwise empty. """ task: TaskEntity """ User who triggered the KPI event (e.g. created or completed the activity). """ client: ClientEntity """Activity owner at the time the KPI event occurred.""" owner: ClientEntity """Sales unit the triggering user belonged to at the time of the event.""" unit: SalesUnitEntity """Id of the appointment or task the KPI event relates to.""" activityId: ID! """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified. """ kpi: ActivityKpiEnum! """Id of the activity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of activity event recorded as a KPI entry; each activity keeps at most one entry per kind. """ enum ActivityKpiEnum { """The activity was created.""" ActivityCreate """The activity was completed.""" ActivityCompleted """The activity was last modified.""" LastModified } """ Filter conditions for ActivityKPI records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ActivityKPIFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ActivityKPIFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ActivityKPIFilterInput!] """Matches records that do not meet this filter.""" NOT: ActivityKPIFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the appointment or task the KPI event relates to.""" activityId: EntityFilterStringField """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: EntityFilterStringField """Id of the user who triggered the event.""" clientId: EntityFilterStringField """ KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified. """ kpi: ActivityKpiEnumFilterInput """Id of the activity owner at the time of the event.""" ownerId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment this KPI event relates to. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task this KPI event relates to. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ User who triggered the KPI event (e.g. created or completed the activity). Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Activity owner at the time the KPI event occurred. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales unit the triggering user belonged to at the time of the event. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ActivityKpiEnumFilterInput { """Matches any of the listed values.""" eq: [ActivityKpiEnum!] """Matches values that do not meet this condition.""" NOT: ActivityKpiEnumFilterInput } """ Sorting of ActivityKPI records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ActivityKPIOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment this KPI event relates to. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task this KPI event relates to. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ User who triggered the KPI event (e.g. created or completed the activity). Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Activity owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Sales unit the triggering user belonged to at the time of the event. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the appointment or task the KPI event relates to.""" activityId: OrderByEnum """Id of the user who triggered the event.""" clientId: OrderByEnum """Id of the activity owner at the time of the event.""" ownerId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ActivityKPI records.""" type ActivityKPIEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ActivityKPIEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ActivityKPIEntity` and its cursor.""" type ActivityKPIEntityEdge { """The item at the end of the edge""" node: ActivityKPIEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ActivityRelation records.""" type ActivityRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ActivityRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ActivityRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ActivityRelationFilterInput """Sorting of the returned records.""" orderBy: [ActivityRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ActivityRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ActivityRelationFilterInput """Sorting of the returned records.""" orderBy: [ActivityRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ActivityRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ActivityRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ActivityRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the activity is linked to, or empty when not linked to an account. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Appointment side of the link. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task side of the link. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Contact the activity is linked to, or empty when not linked to a contact. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record the activity is linked to, or empty. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Lead the activity is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the activity is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Project the activity is linked to, or empty when not linked to a project. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Project objective the activity advances, or empty. Sorts by fields of the related record, listed in order of priority. """ projectObjective: [ProjectObjectiveOrderByNestedInput!] """ Quote the activity is linked to, or empty when not linked to a quote. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the appointment or task on this link.""" activityId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked custom entity record.""" customEntityId: OrderByEnum """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: OrderByEnum """Id of the linked project.""" projectId: OrderByEnum """ Id of the project objective the activity advances, or empty when it is not linked to one. """ projectObjectiveId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """ Display order of the activity within its project objective. Required only when projectId is set. """ sortOrder: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related CustomEntity record. Set exactly one field in each item. """ input CustomEntityOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the currency exchange rate list applied to this record.""" currencyExchangeRatesListId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the sales user who owns the custom entity record.""" ownerId: OrderByEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: OrderByEnum """Id of the custom entity type.""" typeId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related ProjectObjective record. Set exactly one field in each item. """ input ProjectObjectiveOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the project this objective belongs to. Set on create; cannot be changed afterwards. """ projectId: OrderByEnum """ Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. """ sortOrder: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AllowedAccountType records.""" type AllowedAccountTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedAccountTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedAccountTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedAccountTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedAccountTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedAccountTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedAccountTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedAccountTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedAccountTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedAccountType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedAccountTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account type the user role can use. Sorts by fields of the related record, listed in order of priority. """ accountType: [AccountTypeOrderByNestedInput!] """ User role granted access to the account type. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """Id of the account type the user role can use.""" accountTypeId: OrderByEnum """Id of the user role.""" masterRightId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AllowedAppointmentType records.""" type AllowedAppointmentTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedAppointmentTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedAppointmentTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedAppointmentTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedAppointmentTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedAppointmentTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedAppointmentTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedAppointmentTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedAppointmentTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedAppointmentType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedAppointmentTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment type the user role can use. Sorts by fields of the related record, listed in order of priority. """ appointmentType: [AppointmentTypeOrderByNestedInput!] """ User role granted access to the appointment type. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """Id of the appointment type the user role can use.""" appointmentTypeId: OrderByEnum """Id of the user role.""" masterRightId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AllowedCompanyEmail records.""" type AllowedCompanyEmailRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedCompanyEmailEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedCompanyEmailEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedCompanyEmailFilterInput """Sorting of the returned records.""" orderBy: [AllowedCompanyEmailOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedCompanyEmailEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedCompanyEmailFilterInput """Sorting of the returned records.""" orderBy: [AllowedCompanyEmailOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedCompanyEmailEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedCompanyEmail records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedCompanyEmailOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Company email address the user role can send from. Sorts by fields of the related record, listed in order of priority. """ companyEmail: [CompanyEmailOrderByNestedInput!] """ User role granted access to the company email address. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """Id of the company email address.""" companyEmailId: OrderByEnum """Id of the user role.""" masterRightId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related CompanyEmail record. Set exactly one field in each item. """ input CompanyEmailOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Email address of the company mailbox (the From address).""" email: OrderByEnum """ False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise. """ enabled: OrderByEnum """ Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration. """ errorCode: OrderByEnum """Display name of the company email account, shown in the UI.""" name: OrderByEnum """ URL of the avatar image used as the sender picture for emails sent from this account. """ pictureUrl: OrderByEnum """ Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid. """ serviceType: OrderByEnum } """Read operations for AllowedCompanyPhone records.""" type AllowedCompanyPhoneRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedCompanyPhoneEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedCompanyPhoneEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedCompanyPhoneFilterInput """Sorting of the returned records.""" orderBy: [AllowedCompanyPhoneOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedCompanyPhoneEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedCompanyPhoneFilterInput """Sorting of the returned records.""" orderBy: [AllowedCompanyPhoneOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedCompanyPhoneEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedCompanyPhone records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedCompanyPhoneOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User role granted access to the company phone. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """ Company phone the user role can use for calling/SMS. Sorts by fields of the related record, listed in order of priority. """ phone: [PhoneOrderByNestedInput!] """Id of the user role.""" masterRightId: OrderByEnum """Id of the company phone.""" phoneId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Phone record. Set exactly one field in each item. """ input PhoneOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy. """ errorCode: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the assigned user, or empty when the phone is a company-level resource. """ ownerId: OrderByEnum """Phone number in E.164 format (e.g. "+12025550123").""" phoneNumber: OrderByEnum """ External caller identifier from the calling provider (e.g. Twilio caller SID). """ twilioCallerSid: OrderByEnum """ Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ False when the user has disabled the calling/SMS integration on this phone (errorCode is set to indicate user disablement); true otherwise. """ enabled: OrderByEnum } """Read operations for AllowedContactType records.""" type AllowedContactTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedContactTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedContactTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedContactTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedContactTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedContactTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedContactTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedContactTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedContactTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedContactType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedContactTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact type the user role can use. Sorts by fields of the related record, listed in order of priority. """ contactType: [ContactTypeOrderByNestedInput!] """ User role granted access to the contact type. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """Id of the contact type the user role can use.""" contactTypeId: OrderByEnum """Id of the user role.""" masterRightId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AllowedLeadType records.""" type AllowedLeadTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedLeadTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedLeadTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedLeadTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedLeadTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedLeadTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedLeadTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedLeadTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedLeadTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedLeadType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedLeadTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead type the user role can use. Sorts by fields of the related record, listed in order of priority. """ leadType: [LeadTypeOrderByNestedInput!] """ User role granted access to the lead type. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """Id of the lead type the user role can use.""" leadTypeId: OrderByEnum """Id of the user role.""" masterRightId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AllowedPipeline records.""" type AllowedPipelineRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedPipelineEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedPipelineEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedPipelineFilterInput """Sorting of the returned records.""" orderBy: [AllowedPipelineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedPipelineEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedPipelineFilterInput """Sorting of the returned records.""" orderBy: [AllowedPipelineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedPipelineEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedPipeline records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedPipelineOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User role granted access to the pipeline. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """ Pipeline the user role can use. Sorts by fields of the related record, listed in order of priority. """ pipeline: [PipelineOrderByNestedInput!] """ When true, the user role can access documents attached to steps of this pipeline. """ accessStepDocuments: OrderByEnum """Id of the user role.""" masterRightId: OrderByEnum """Id of the pipeline the user role can use.""" pipelineId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Pipeline record. Set exactly one field in each item. """ input PipelineOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AllowedQuoteType records.""" type AllowedQuoteTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedQuoteTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedQuoteTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedQuoteTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedQuoteTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedQuoteTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedQuoteTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedQuoteTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedQuoteTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedQuoteType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedQuoteTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User role granted access to the quote type. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """ Quote type the user role can use. Sorts by fields of the related record, listed in order of priority. """ quoteType: [QuoteTypeOrderByNestedInput!] """Id of the user role.""" masterRightId: OrderByEnum """Id of the quote type the user role can use.""" quoteTypeId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AllowedTaskType records.""" type AllowedTaskTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AllowedTaskTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AllowedTaskTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AllowedTaskTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedTaskTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AllowedTaskTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AllowedTaskTypeFilterInput """Sorting of the returned records.""" orderBy: [AllowedTaskTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AllowedTaskTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AllowedTaskType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AllowedTaskTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User role granted access to the task type. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """ Task type the user role can use. Sorts by fields of the related record, listed in order of priority. """ taskType: [TaskTypeOrderByNestedInput!] """Id of the user role.""" masterRightId: OrderByEnum """Id of the task type the user role can use.""" taskTypeId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ApiAccess records.""" type ApiAccessRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ApiAccessEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ApiAccessEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApiAccessFilterInput """Sorting of the returned records.""" orderBy: [ApiAccessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ApiAccessEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ApiAccessFilterInput """Sorting of the returned records.""" orderBy: [ApiAccessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApiAccessEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns API accesses of the space for administration, leaving out accesses of hidden applications. """ getAllForAdmin( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApiAccessFilterInput """Sorting of the returned records.""" orderBy: [ApiAccessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ApiAccessEntity!]! } """ API credentials that an integration uses to access the space, with the parts of the API they may read or write. """ type ApiAccessEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity. Must match with Application id.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Contact email associated with this API access. Used for credential change notifications. """ email: String """ Whether this API access can authenticate. Set to false to disable the credentials without deleting the record; existing tokens stop working immediately. """ isActive: Boolean """ Timestamp of the most recent successful authentication using this API access. Updated automatically on each use; empty for credentials that have never been used. """ lastUsed: DateTime """ Per-section access permissions (records, administration, misc) granted to this API access. Determines which entities and operations the credentials can read or write. """ permissions: ApiAccessPermissions """ Authentication type of this API access (e.g. standard API key vs. OAuth client). Set automatically on create and cannot be changed. """ type: ApiAccessTypeEnum! """Name for the api access.""" name: String """Formerly API Access.""" username: String """ Formerly API Password. Only available during create or for migrated legacy access. Otherwise, it is null. """ plainPassword: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Access levels an API access grants, grouped into records, administration and other areas. """ type ApiAccessPermissions { """ Access levels to records, such as accounts, opportunities and custom entities. """ records: ApiAccessPermissionRecordsTab! """ Access levels to administration areas, such as users and units, pipelines, fields and products. """ administration: ApiAccessPermissionAdministrationTab! """Access levels to reports, webhooks, documents and the remaining areas.""" misc: ApiAccessPermissionMiscTab! } """ Access levels an API access grants to records, such as accounts, opportunities and custom entities. """ type ApiAccessPermissionRecordsTab { """ Access level to accounts, with their relations, sharing and statistics. """ accounts: ApiPermissionEnum! """ Access level to contacts, with their account relations, sharing and statistics. """ contacts: ApiPermissionEnum! """Access level to leads.""" leads: ApiPermissionEnum! """ Access level to opportunities, with their product lines, revenue schedules and recurrence, and to quotes. """ opportunities: ApiPermissionEnum! """Access level to tasks, with their reminders and recurrence.""" tasks: ApiPermissionEnum! """ Access level to appointments, with their invitees and reminders, and to appointment schedules. """ appointments: ApiPermissionEnum! """ Access level to emails, email labels, email templates and unsubscribed email addresses. """ emails: ApiPermissionEnum! """ Access level to memos and their comments, chat conversations and text messages. """ messages: ApiPermissionEnum! """Access level to projects and their objectives.""" projects: ApiPermissionEnum! """ Access level to the records of each custom entity of the space; a custom entity without its own entry has Write access. """ customEntities: [CustomEntityApiAccessPermission!]! } """Level of access an API access grants to an area of the space.""" enum ApiPermissionEnum { """Records in the area can be read and changed.""" Write """Records in the area can be read but not changed.""" Read """The area is not accessible.""" Disabled } """Access level an API access grants to the records of one custom entity.""" type CustomEntityApiAccessPermission { """Access level to the records of the custom entity.""" access: ApiPermissionEnum! """API name of the custom entity.""" entityApiName: String! } """ Access levels an API access grants to administration areas, such as users, pipelines, fields and products. """ type ApiAccessPermissionAdministrationTab { """ Access level to users, sales units and user roles, including the pipelines and record types each role may use. """ unitsAndRoles: ApiPermissionEnum! """ Access level to pipelines, lead processes, their steps and step checklists. """ pipelines: ApiPermissionEnum! """Access level to currencies and exchange rate lists.""" currencies: ApiPermissionEnum! """Access level to products, product categories and price lists.""" productsAndPrices: ApiPermissionEnum! """ Access level to the common lists: account hierarchy, account and contact relation types, account roles, sales roles and tags. """ commonList: ApiPermissionEnum! """ Access level to fields, forms, dropdown options, translations and record types, including online form types and health and scoring settings. """ fieldsAndForms: ApiPermissionEnum! """ Access level to the space settings and the company email addresses and phone numbers. """ settings: ApiPermissionEnum! """ Access level to the Automation Hub apps and their categories, and to the apps enabled in the space. These are read-only, so Write grants Read. """ automationHub: ApiPermissionEnum! """Access level to the audit log.""" security: ApiPermissionEnum! } """ Access levels an API access grants to reports, webhooks, documents and the remaining areas. """ type ApiAccessPermissionMiscTab { """ Access level to reports, report folders, report schedules and forecasts. """ reports: ApiPermissionEnum! """Access level to webhooks and their events.""" webhooks: ApiPermissionEnum! """ Access level for the Data area. Kept with the other levels, but no part of the API currently depends on it. """ data: ApiPermissionEnum! """Access level to files, document folders and document templates.""" documents: ApiPermissionEnum! """ Access level to the remaining areas: automation processes, approvals, email sequences, online form submissions, notes, targets, saved screen views, solutions and change and event logs. """ others: ApiPermissionEnum! } """How an API access authenticates.""" enum ApiAccessTypeEnum { """ Authenticates with an access key and secret sent as HTTP Basic credentials. """ Basic """Authenticates as an OAuth 2 application.""" OAuth } """ Filter conditions for ApiAccess records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ApiAccessFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ApiAccessFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ApiAccessFilterInput!] """Matches records that do not meet this filter.""" NOT: ApiAccessFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity. Must match with Application id.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Contact email associated with this API access. Used for credential change notifications. """ email: EntityFilterStringField """ Whether this API access can authenticate. Set to false to disable the credentials without deleting the record; existing tokens stop working immediately. """ isActive: Boolean """ Timestamp of the most recent successful authentication using this API access. Updated automatically on each use; empty for credentials that have never been used. """ lastUsed: EntityFilterDateTimeField """ Authentication type of this API access (e.g. standard API key vs. OAuth client). Set automatically on create and cannot be changed. """ type: ApiAccessTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ApiAccessTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ApiAccessTypeEnum!] """Matches values that do not meet this condition.""" NOT: ApiAccessTypeEnumFilterInput } """ Sorting of ApiAccess records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ApiAccessOrderByInput { """Unique identifier of entity. Must match with Application id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact email associated with this API access. Used for credential change notifications. """ email: OrderByEnum """ Whether this API access can authenticate. Set to false to disable the credentials without deleting the record; existing tokens stop working immediately. """ isActive: OrderByEnum """ Timestamp of the most recent successful authentication using this API access. Updated automatically on each use; empty for credentials that have never been used. """ lastUsed: OrderByEnum """ Authentication type of this API access (e.g. standard API key vs. OAuth client). Set automatically on create and cannot be changed. """ type: OrderByEnum } """Paginated list of ApiAccess records.""" type ApiAccessEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ApiAccessEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ApiAccessEntity` and its cursor.""" type ApiAccessEntityEdge { """The item at the end of the edge""" node: ApiAccessEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Application records.""" type ApplicationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ApplicationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ApplicationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApplicationFilterInput """Sorting of the returned records.""" orderBy: [ApplicationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ApplicationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ApplicationFilterInput """Sorting of the returned records.""" orderBy: [ApplicationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApplicationEntityConnection } """ Sorting of Application records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ApplicationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Identifier of the matching Automation Hub item, or empty for user-defined applications. Set automatically by Coevera when the application is registered through the Automation Hub. """ automationHubId: OrderByEnum """ True when this application can register webhooks. Set when the application is created and cannot be changed afterwards. """ isTrigger: OrderByEnum """ True when this application is shown in the Automation Hub UI. Hidden applications are still functional but excluded from end-user discovery. """ isVisible: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when this application can act on behalf of individual users (personal triggers). Set when the application is created and cannot be changed afterwards. """ usesImpersonation: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Application records.""" type ApplicationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ApplicationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ApplicationEntity` and its cursor.""" type ApplicationEntityEdge { """The item at the end of the edge""" node: ApplicationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Appointment records.""" type AppointmentRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AppointmentEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AppointmentEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AppointmentFilterInput """Sorting of the returned records.""" orderBy: [AppointmentOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AppointmentEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AppointmentFilterInput """Sorting of the returned records.""" orderBy: [AppointmentOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): AppointmentEntity! """ Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. """ aiAutoPrefill( """ Id of the suggested action, as returned by the AI record suggestions or AI chat. """ actionId: String! ): AppointmentAutoPrefill! """ Returns a new, unsaved appointment pre-filled from an email conversation: subject and description from the last sent email of the conversation that the user can read, the records linked to the conversation (including ones the user cannot open), its attachments as documents, and every From, To and CC address as an invitee except the address of the mailbox. Nothing is saved. """ autoPrefillFromEmail( """Id of any email of the conversation.""" emailId: UUID! """ Mailbox the conversation was opened in. Limits the conversation to that mailbox and leaves its own address out of the invitees; it must be a mailbox the user can use. """ mailboxId: UUID ): AppointmentAutoPrefill! } """Paginated list of Appointment records.""" type AppointmentEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AppointmentEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AppointmentEntity` and its cursor.""" type AppointmentEntityEdge { """The item at the end of the edge""" node: AppointmentEntity """A cursor for use in pagination""" cursor: String! } """ New, unsaved appointment pre-filled by AI or from an email conversation, with the ids of the fields that were filled in. """ type AppointmentAutoPrefill { """New appointment carrying the pre-filled values; it is not saved.""" entity: AppointmentEntity """Ids of the fields that were filled in.""" fieldIds: [UUID!]! } """Read operations for AppointmentClientInviteesRelation records.""" type AppointmentClientInviteesRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AppointmentClientInviteesRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AppointmentClientInviteesRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AppointmentClientInviteesRelationFilterInput """Sorting of the returned records.""" orderBy: [AppointmentClientInviteesRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AppointmentClientInviteesRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AppointmentClientInviteesRelationFilterInput """Sorting of the returned records.""" orderBy: [AppointmentClientInviteesRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentClientInviteesRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AppointmentClientInviteesRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AppointmentClientInviteesRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment the user has been invited to. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Internal user invited to the appointment. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """Id of the appointment the user has been invited to.""" appointmentId: OrderByEnum """Id of the user.""" clientId: OrderByEnum """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for AppointmentContactInviteesRelation records.""" type AppointmentContactInviteesRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AppointmentContactInviteesRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AppointmentContactInviteesRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AppointmentContactInviteesRelationFilterInput """Sorting of the returned records.""" orderBy: [AppointmentContactInviteesRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AppointmentContactInviteesRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AppointmentContactInviteesRelationFilterInput """Sorting of the returned records.""" orderBy: [AppointmentContactInviteesRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentContactInviteesRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for AppointmentReminder records.""" type AppointmentReminderRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AppointmentReminderEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AppointmentReminderEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AppointmentReminderFilterInput """Sorting of the returned records.""" orderBy: [AppointmentReminderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AppointmentReminderEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AppointmentReminderFilterInput """Sorting of the returned records.""" orderBy: [AppointmentReminderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentReminderEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AppointmentReminder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AppointmentReminderOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment this reminder belongs to. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ User who set this reminder. Reminders are per-user. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Id of the appointment this reminder belongs to.""" appointmentId: OrderByEnum """Seconds before the appointment start when the reminder should fire.""" endDateOffset: OrderByEnum """Id of the user who set the reminder.""" ownerId: OrderByEnum """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: OrderByEnum """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of AppointmentReminder records.""" type AppointmentReminderEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AppointmentReminderEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AppointmentReminderEntity` and its cursor.""" type AppointmentReminderEntityEdge { """The item at the end of the edge""" node: AppointmentReminderEntity """A cursor for use in pagination""" cursor: String! } """Read operations for AppointmentSchedule records.""" type AppointmentScheduleRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AppointmentScheduleEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AppointmentScheduleEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AppointmentScheduleFilterInput """Sorting of the returned records.""" orderBy: [AppointmentScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AppointmentScheduleEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AppointmentScheduleFilterInput """Sorting of the returned records.""" orderBy: [AppointmentScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentScheduleEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of AppointmentSchedule records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input AppointmentScheduleOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User assigned as the appointment owner when a booking is made through this schedule. Sorts by fields of the related record, listed in order of priority. """ appointmentOwner: [ClientOrderByNestedInput!] """ Appointment type used when a booking is created. Sorts by fields of the related record, listed in order of priority. """ appointmentType: [AppointmentTypeOrderByNestedInput!] """ Owner of the schedule (typically the team member whose availability is exposed). Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Sender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. Sorts by fields of the related record, listed in order of priority. """ replyCompanyEmail: [CompanyEmailOrderByNestedInput!] """Description applied to appointments booked through this schedule.""" appointmentDescription: OrderByEnum """Duration of each booked appointment.""" appointmentDuration: OrderByEnum """Location applied to appointments booked through this schedule.""" appointmentLocation: OrderByEnum """ Where booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. """ appointmentLocationType: OrderByEnum """Id of the user receiving the booking.""" appointmentOwnerId: OrderByEnum """Subject applied to appointments booked through this schedule.""" appointmentSubject: OrderByEnum """ When true, booked appointments use the scheduleName as their subject instead of appointmentSubject. """ appointmentSubjectUsesScheduleName: OrderByEnum """ Id of the appointment type used for appointments booked through the schedule. """ appointmentTypeId: OrderByEnum """ Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeAfter: OrderByEnum """ Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeBefore: OrderByEnum """ What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). """ confirmationPageType: OrderByEnum """ Custom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect. """ confirmationPageUrl: OrderByEnum """ Master switch for the schedule. Disabled schedules do not accept new bookings. """ isEnabled: OrderByEnum """ Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). """ minimumNoticeTime: OrderByEnum """ Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name. """ name: OrderByEnum """Id of the schedule owner.""" ownerId: OrderByEnum """ With Offset planning, how many days ahead the schedule remains bookable. """ planningDayOffset: OrderByEnum """With Period planning, first date bookings are accepted for.""" planningPeriodFrom: OrderByEnum """With Period planning, last date bookings are accepted for.""" planningPeriodTo: OrderByEnum """ Time window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period). """ planningType: OrderByEnum """ True when a reminder email is sent to invitees ahead of the booked appointment. """ reminderEmailEnabled: OrderByEnum """ Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType. """ reminderEmailOffset: OrderByEnum """Time unit of reminderEmailOffset: Minute, Hour, Day or Week.""" reminderEmailOffsetType: OrderByEnum """ Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmailId: OrderByEnum """ Public-facing name of the schedule, shown to bookers on the booking page. """ scheduleName: OrderByEnum """ Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). """ timeIncrement: OrderByEnum """ Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. """ type: OrderByEnum """Public URL slug of the schedule, used to share the booking page.""" url: OrderByEnum } """Paginated list of AppointmentSchedule records.""" type AppointmentScheduleEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AppointmentScheduleEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AppointmentScheduleEntity` and its cursor.""" type AppointmentScheduleEntityEdge { """The item at the end of the edge""" node: AppointmentScheduleEntity """A cursor for use in pagination""" cursor: String! } """Read operations for AppointmentType records.""" type AppointmentTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): AppointmentTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [AppointmentTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AppointmentTypeFilterInput """Sorting of the returned records.""" orderBy: [AppointmentTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AppointmentTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: AppointmentTypeFilterInput """Sorting of the returned records.""" orderBy: [AppointmentTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): AppointmentTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: AppointmentTypeFilterInput """Sorting of the returned records.""" orderBy: [AppointmentTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [AppointmentTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: AppointmentTypeFilterInput """Sorting of the returned records.""" orderBy: [AppointmentTypeOrderByInput!] ): [AppointmentTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): AppointmentTypeEntity! } """Paginated list of AppointmentType records.""" type AppointmentTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [AppointmentTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `AppointmentTypeEntity` and its cursor.""" type AppointmentTypeEntityEdge { """The item at the end of the edge""" node: AppointmentTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Approval records.""" type ApprovalRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ApprovalEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ApprovalEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApprovalFilterInput """Sorting of the returned records.""" orderBy: [ApprovalOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ApprovalEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ApprovalFilterInput """Sorting of the returned records.""" orderBy: [ApprovalOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Exports the approval log of an approval process to a zipped text file and returns a URL to download it. """ getDownloadUrl( """Id of the approval process.""" approvalProcessId: UUID! """Name of the export, used for the file name.""" name: String! """Conditions the exported approvals must meet.""" filter: ApprovalFilterInput """When set, only approvals created in the last N days are exported.""" days: Int ): String! """ Returns the completed approvals (approved or rejected) of a record, most recently decided first. """ getRecentApprovals( """Id of the record.""" entityId: UUID! """Type of the record: Account, Contact, Lead, Opportunity or Quote.""" entityName: EntityNameEnum! """Maximum number of records to return.""" limit: Int! ): [RecentApprovalItem!]! } """Completed approval of a record, with its outcome and approval process.""" type RecentApprovalItem { """Id of the approval.""" id: UUID! """Outcome of the approval: Approved or Rejected.""" status: ApprovalStatusEnum! """When the last approver responded.""" completedDatetime: DateTime! """Id of the approval process that raised the approval.""" approvalProcessId: UUID! """Name of the approval process that raised the approval.""" approvalProcessName: String! """Free-text description of the approval process; null when it has none.""" approvalProcessDescription: String } """Read operations for ApprovalApprover records.""" type ApprovalApproverRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ApprovalApproverEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ApprovalApproverEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApprovalApproverFilterInput """Sorting of the returned records.""" orderBy: [ApprovalApproverOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ApprovalApproverEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ApprovalApproverFilterInput """Sorting of the returned records.""" orderBy: [ApprovalApproverOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalApproverEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for ApprovalProcess records.""" type ApprovalProcessRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ApprovalProcessEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ApprovalProcessEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApprovalProcessFilterInput """Sorting of the returned records.""" orderBy: [ApprovalProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ApprovalProcessEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ApprovalProcessFilterInput """Sorting of the returned records.""" orderBy: [ApprovalProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalProcessEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of approval processes filtered by owner, enabled state and status, in addition to the regular filter. """ getByApprovalProcessCriteria( """Owner, active/inactive and status filters applied to the list.""" listingOptions: ProcessTabDataGridViewOptionsParams! """Conditions the returned records must meet.""" filter: ApprovalProcessFilterInput """Sorting of the returned records.""" orderBy: [ApprovalProcessOrderByInput!] """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalProcessEntityConnection """ Returns approval processes with a manual trigger that the current user is allowed to start, according to each trigger's allowed users and units. """ getApprovalProcessesWithManualTrigger( """ Maximum number of records to return. Limit and offset are applied before the allowed users and units are checked, so a page can hold fewer records. """ limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApprovalProcessFilterInput """Sorting of the returned records.""" orderBy: [ApprovalProcessOrderByInput!] ): [ApprovalProcessEntity!]! } """ Sorting of ApprovalProcess records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ApprovalProcessOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the approval process. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Free-text description shown alongside the approval process.""" description: OrderByEnum """ When true, the approval process actively raises approvals on matching record events; when false, the process is paused. """ isEnabled: OrderByEnum """Timestamp of the most recent change to settings.""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled.""" lastStatusChange: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Position of this process among approval processes for the same record-trigger entity type; lower values are evaluated first. Read-only; managed via update_priority. Null for manual-trigger approval processes. """ priority: OrderByEnum """ For record-change triggers, the entity whose records can raise an approval (e.g. "Quote"). Empty for manual triggers. """ triggerEntityName: OrderByEnum """ Overall status of the approval process, derived from the approvals it raised since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are none. """ status: OrderByEnum """ How approvals are raised: Manual (a user must initiate) or RecordChange (automatically when a record matching the trigger condition is created or updated). """ triggerType: OrderByEnum } """Paginated list of ApprovalProcess records.""" type ApprovalProcessEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ApprovalProcessEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ApprovalProcessEntity` and its cursor.""" type ApprovalProcessEntityEdge { """The item at the end of the edge""" node: ApprovalProcessEntity """A cursor for use in pagination""" cursor: String! } """Filters for listing processes by owner, active state, status and tags.""" input ProcessTabDataGridViewOptionsParams { """ Ids of the owners whose records are listed; null or an empty list turns the owner filter off. """ filterByOwnerId: [ID!] """ When true, the list includes active records. When both showActive and showInactive are false, the list is not filtered by state. """ showActive: Boolean! = true """When true, the list includes inactive records; see showActive.""" showInactive: Boolean! = true """ Statuses to include, such as Ok, Warning or Error; null or an empty list turns the status filter off. Ignored when both showActive and showInactive are false. """ filterByStatus: [ProcessStatusEnum!] """ Ids of tags; only records with at least one of them are listed. Null or an empty list turns the tag filter off. Only processes can be tagged, so for approval processes and email sequences any tag id returns an empty list. """ filterByTagIds: [ID!] } """Read operations for ApprovalProcessActivityLogLine records.""" type ApprovalProcessActivityLogLineRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ApprovalProcessActivityLogLineEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ApprovalProcessActivityLogLineEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ApprovalProcessActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [ApprovalProcessActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ApprovalProcessActivityLogLineEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ApprovalProcessActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [ApprovalProcessActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ApprovalProcessActivityLogLineEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for Call records.""" type CallRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CallEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CallEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CallFilterInput """Sorting of the returned records.""" orderBy: [CallOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CallEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CallFilterInput """Sorting of the returned records.""" orderBy: [CallOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CallEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the call with the given call SID assigned by the telephony provider. An error is returned when no such call exists. """ getBySid( """Call SID from the telephony provider.""" entitySid: String! ): CallEntity } """ Sorting of Call records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CallOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the call is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ User who initiated the call. Sorts by fields of the related record, listed in order of priority. """ caller: [ClientOrderByNestedInput!] """ User the call was made with, when the call was an internal user-to-user call. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Contact the call is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Lead the call is linked to, when the call is associated with a lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the call is linked to, when the call is associated with an opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Specific opportunity line-item discussed on the call, when applicable. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelation: [OpptyProductRelationOrderByNestedInput!] """ Product discussed on the call, when applicable. Sorts by fields of the related record, listed in order of priority. """ product: [ProductOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the calling user.""" callerId: OrderByEnum """Id of the user the call was made with.""" clientId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: OrderByEnum """Id of the linked opportunity product line-item.""" opptyProductRelationId: OrderByEnum """External phone number called or received, in E.164 format.""" phoneNumber: OrderByEnum """Id of the linked product.""" productId: OrderByEnum """External transcription identifier from the calling provider.""" transcriptionId: OrderByEnum """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US"). """ transcriptionLanguage: OrderByEnum """AI-generated summary of the call transcription.""" transcriptionSummary: OrderByEnum } """ Sorting by a field of the related OpptyProductRelation record. Set exactly one field in each item. """ input OpptyProductRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Total amount of the line item (price * quantity, with discounts applied). """ amount: OrderByEnum """Free-form note describing this line item.""" comment: OrderByEnum """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: OrderByEnum """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: OrderByEnum """ Id of the online form submission this line item came from, or empty when it was not created through a form. """ onlineFormId: OrderByEnum """Id of the opportunity.""" opptyId: OrderByEnum """Id of the line-item type.""" opptyProductRelationTypeId: OrderByEnum """Id of the paired line item.""" pairedOpptyProductRelationId: OrderByEnum """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: OrderByEnum """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: OrderByEnum """Number of product units on this line item.""" quantity: OrderByEnum """ Id of the quote this line item belongs to. Mutually exclusive with opptyId. """ quoteId: OrderByEnum """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Absolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountValue: OrderByEnum """ Percentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountPercentage: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """Paginated list of Call records.""" type CallEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CallEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CallEntity` and its cursor.""" type CallEntityEdge { """The item at the end of the edge""" node: CallEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ChatConversation records.""" type ChatConversationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ChatConversationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ChatConversationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ChatConversationFilterInput """Sorting of the returned records.""" orderBy: [ChatConversationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ChatConversationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ChatConversationFilterInput """Sorting of the returned records.""" orderBy: [ChatConversationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ChatConversationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the messages of the AI chat conversation that were added or changed after the given time, so a client can poll for new replies. """ pollMessages( """Id of the conversation and the time to return changes after.""" input: PollMessagesInput! ): [TextMessageEntity!]! } """ Sorting of ChatConversation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ChatConversationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the conversation belongs to. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Id of the owning user.""" ownerId: OrderByEnum """ Kind of AI chat: a general conversation with the AI assistant, or one about a specific record identified by context. """ type: OrderByEnum } """Paginated list of ChatConversation records.""" type ChatConversationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ChatConversationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ChatConversationEntity` and its cursor.""" type ChatConversationEntityEdge { """The item at the end of the edge""" node: ChatConversationEntity """A cursor for use in pagination""" cursor: String! } """ Request for the messages of a text message conversation added or changed since a given time. """ input PollMessagesInput { """Id of the conversation to poll.""" id: ID! """ Time after which added or changed messages are returned. Always set it: without it no messages are returned. """ since: DateTime } """Read operations for Client records.""" type ClientRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ClientEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ClientEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ClientFilterInput """Sorting of the returned records.""" orderBy: [ClientOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ClientEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ClientFilterInput """Sorting of the returned records.""" orderBy: [ClientOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the email addresses of all users in every space of the subscription the current space belongs to, sorted alphabetically. """ clientEmailsInSubscription: [String!]! """ Returns the current user's synchronization setting with the given name, or null when it does not exist. """ getEntitySyncSettings( """Name of the setting.""" name: String! ): EntitySyncSettings """ Returns the space-wide synchronization status entry with the given name, or null when it does not exist. Only names ending with "_status" are resolved. """ getEntitySyncSettingStatus( """Name of the status entry; must end with "_status".""" name: String! ): EntitySyncSettings """ Returns the current user's links between Coevera contacts and contacts in an external service (Exchange, Office 365 or Google) used by contact synchronization. """ getContactMappings( """ External service whose links are returned; only records linked in that service are included. """ serviceType: ServiceMappingType! """ When true, returns only links flagged for deletion; when false, only links not flagged. """ flagToDelete: Boolean! """ When 1, returns only Google links that still use the legacy Google Contacts id format. """ flagOldFormat: Int """Ids of records in the external service to limit the result to.""" foreignIds: [String!] ): [EntityMapping!]! """ Returns the current user's links between Coevera tasks and tasks in an external service (Exchange, Office 365 or Google) used by task synchronization. """ getTaskMappings( """ External service whose links are returned; only records linked in that service are included. """ serviceType: ServiceMappingType! """ When true, returns only links flagged for deletion; when false, only links not flagged. """ flagToDelete: Boolean! """Currently not used.""" flagOldFormat: Int """Ids of records in the external service to limit the result to.""" foreignIds: [String!] ): [EntityMapping!]! """ Returns the current user's links between Coevera appointments and events in an external service (Exchange, Office 365 or Google) used by calendar synchronization. """ getEventMappings( """ External service whose links are returned; only records linked in that service are included. """ serviceType: ServiceMappingType! """ When true, returns only links flagged for deletion; when false, only links not flagged. """ flagToDelete: Boolean! """Currently not used.""" flagOldFormat: Int """Ids of records in the external service to limit the result to.""" foreignIds: [String!] ): [EntityMapping!]! """ Returns the space user with the given email address, or null when there is none. The address is compared case-insensitively. """ getByEmail( """Email address of the user.""" email: String! ): ClientEntity """ Returns the support staff who can be invited to the space: customer support users and users of the subscription's partner. """ getSupportUsers( """ When true, support users already invited to the space are included. Defaults to false. """ invited: Boolean ): [SupportUser!]! } """Paginated list of Client records.""" type ClientEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ClientEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ClientEntity` and its cursor.""" type ClientEntityEdge { """The item at the end of the edge""" node: ClientEntity """A cursor for use in pagination""" cursor: String! } """Synchronization setting of the current user, as a name and a value.""" type EntitySyncSettings { """Name of the setting.""" name: String """Value of the setting, as a string.""" value: String """When the setting was first stored.""" created: DateTime """When the setting was last changed.""" modified: DateTime } """ Link between a Coevera record of the current user and its copy in Google, Exchange or Office 365, kept by synchronization. """ type EntityMapping { """Id of the Coevera record.""" pipelinerEntityId: UUID """Id of the linked record in Google; null when not linked there.""" googleEntityId: String """Id of the linked record in Exchange; null when not linked there.""" exchangeEntityId: String """Id of the linked record in Office 365; null when not linked there.""" o365EntityId: String """ True when the link is flagged for deletion, so the synchronization removes the copy in the external service, e.g. after the record changed owner. """ flagToDelete: Boolean """Error reported for this link; always null in mapping query results.""" error: BulkErrorResult } """An item of a bulk operation that failed.""" type BulkErrorResult { """Position of the failed item, starting at 0.""" index: Int! """Numeric error code.""" code: Int! """Error message.""" message: String! """Might be null on create.""" entityId: ID """Validation details when the item failed validation.""" apiError: EntityValidationError } """ Error returned when a record fails validation, with the errors of its fields and step checklist items. """ type EntityValidationError implements ApiErrorBase { """Numeric error code.""" code: Int! """Name of the error code, for example ERROR_FIELD_VALIDATION.""" name: String! """Human-readable description of the error.""" message: String """Id of the record that failed validation.""" entityId: UUID """ Position of the record, starting at 0, in the relation of its parent record; set when the record was saved as part of another record. """ entityIndex: Int """Entity of the record, for example Account.""" entityName: String """Errors of the record that do not belong to a single field.""" entityErrors: [FieldError] """Errors of the record, per field.""" fieldErrors: [FieldError] """ Step checklist items of the record that are not completed or not valid. """ stepChecklistErrors: [StepChecklistError] } """ Error returned for a failed operation, with its code, name and message. """ interface ApiErrorBase { """Numeric error code.""" code: Int! """Name of the error code, for example ERROR_FIELD_VALIDATION.""" name: String! """Human-readable description of the error.""" message: String } """ Validation error of one field of a record, or of the record as a whole. """ type FieldError implements ApiErrorBase { """Numeric error code.""" code: Int! """Name of the error code, for example ERROR_FIELD_VALIDATION.""" name: String! """Human-readable description of the error.""" message: String """Name of the field the error relates to.""" fieldName: String """Id of the field the error relates to.""" fieldId: UUID """The individual errors of the field.""" errors: [FieldError] } """ Error for a step checklist item of a record that is not completed or not valid. """ type StepChecklistError implements ApiErrorBase { """Numeric error code.""" code: Int! """Name of the error code, for example ERROR_FIELD_VALIDATION.""" name: String! """Human-readable description of the error.""" message: String """Id of the step checklist item that is not completed or not valid.""" stepChecklistId: UUID! } """ External calendar, contacts or task service whose synchronization mapping is requested. """ enum ServiceMappingType { """Microsoft Exchange.""" Exchange """Google.""" Google """Microsoft 365.""" O365 } """ Customer support or partner user who can be invited into the space to help its users. """ type SupportUser { """ URL of the profile picture of the support user; empty when none is set. """ pictureUrl: String """Full name of the support user.""" name: String! """Email address of the support user.""" email: String! """True when the support user is already a member of the space.""" invited: Boolean! } """Read operations for ClientExcludedOppty records.""" type ClientExcludedOpptyRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ClientExcludedOpptyEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ClientExcludedOpptyEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ClientExcludedOpptyFilterInput """Sorting of the returned records.""" orderBy: [ClientExcludedOpptyOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ClientExcludedOpptyEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ClientExcludedOpptyFilterInput """Sorting of the returned records.""" orderBy: [ClientExcludedOpptyOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientExcludedOpptyEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns true when the user has excluded the opportunity from their forecast and quota calculations. """ isOpptyExcluded( """Id of the opportunity.""" opptyId: UUID! """Id of the user; defaults to the current user.""" ownerId: UUID ): Boolean! } """ Choice of a user to exclude an opportunity from their forecast and quota calculations, or to include it again. """ type ClientExcludedOpptyEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Opportunity excluded from the user's forecast/quota calculations.""" oppty: OpportunityEntity """User who excluded the opportunity from their forecast/quota.""" owner: ClientEntity """ When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity. """ isExcluded: Boolean! """Id of the opportunity.""" opptyId: ID! """Id of the user.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ClientExcludedOppty records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ClientExcludedOpptyFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ClientExcludedOpptyFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ClientExcludedOpptyFilterInput!] """Matches records that do not meet this filter.""" NOT: ClientExcludedOpptyFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity. """ isExcluded: Boolean """Id of the opportunity.""" opptyId: EntityFilterStringField """Id of the user.""" ownerId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Opportunity excluded from the user's forecast/quota calculations. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ User who excluded the opportunity from their forecast/quota. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Sorting of ClientExcludedOppty records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ClientExcludedOpptyOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Opportunity excluded from the user's forecast/quota calculations. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ User who excluded the opportunity from their forecast/quota. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity. """ isExcluded: OrderByEnum """Id of the opportunity.""" opptyId: OrderByEnum """Id of the user.""" ownerId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ClientExcludedOppty records.""" type ClientExcludedOpptyEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ClientExcludedOpptyEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ClientExcludedOpptyEntity` and its cursor.""" type ClientExcludedOpptyEntityEdge { """The item at the end of the edge""" node: ClientExcludedOpptyEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ClientFavorite records.""" type ClientFavoriteRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ClientFavoriteEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ClientFavoriteEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ClientFavoriteFilterInput """Sorting of the returned records.""" orderBy: [ClientFavoriteOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ClientFavoriteEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ClientFavoriteFilterInput """Sorting of the returned records.""" orderBy: [ClientFavoriteOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientFavoriteEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns true when the record is marked as a favorite by the user. Exactly one record id must be given. """ isEntityFavorite( """Id of the user; defaults to the current user.""" ownerId: UUID """Id of the account to check.""" accountId: UUID """Id of the task or appointment to check.""" activityId: UUID """Id of the contact to check.""" contactId: UUID """Id of the lead or opportunity to check.""" leadOpptyId: UUID """Id of the screen profile to check.""" profileId: UUID """Id of the report to check.""" reportId: UUID """Id of the quote to check.""" quoteId: UUID ): Boolean! } """ Sorting of ClientFavorite records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ClientFavoriteOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account marked as favorite, when this favorite points to an account. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Appointment marked as favorite. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task marked as favorite. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Contact marked as favorite, when this favorite points to a contact. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record marked as favorite, when this favorite points to a custom entity. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Email marked as favorite, when this favorite points to an email. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Lead marked as favorite. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity marked as favorite. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ User who marked the record as favorite. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Screen profile marked as favorite, when this favorite points to a profile. Sorts by fields of the related record, listed in order of priority. """ profile: [ProfileOrderByNestedInput!] """ Project marked as favorite, when this favorite points to a project. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote marked as favorite, when this favorite points to a quote. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Report marked as favorite, when this favorite points to a report. Sorts by fields of the related record, listed in order of priority. """ report: [ReportOrderByNestedInput!] """Id of the favorite account.""" accountId: OrderByEnum """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: OrderByEnum """Id of the favorite contact.""" contactId: OrderByEnum """Id of the favorite custom entity record.""" customEntityId: OrderByEnum """Id of the favorite email.""" emailId: OrderByEnum """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Id of the favorite screen profile.""" profileId: OrderByEnum """Id of the favorite project.""" projectId: OrderByEnum """Id of the favorite quote.""" quoteId: OrderByEnum """Id of the favorite report.""" reportId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ClientSetting records.""" type ClientSettingRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ClientSettingEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ClientSettingEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ClientSettingFilterInput """Sorting of the returned records.""" orderBy: [ClientSettingOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ClientSettingEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ClientSettingFilterInput """Sorting of the returned records.""" orderBy: [ClientSettingOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientSettingEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the value of the current user's setting with the given name, or null when the setting does not exist. """ get( """Name of the setting.""" name: String! ): String } """Personal setting of a user, stored as a named value.""" type ClientSettingEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User the setting belongs to.""" owner: ClientEntity """Setting key (unique per user).""" name: String! """Id of the owning user.""" ownerId: ID! """Setting value, stored as a JSON document.""" value: JSONString! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ClientSetting records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ClientSettingFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ClientSettingFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ClientSettingFilterInput!] """Matches records that do not meet this filter.""" NOT: ClientSettingFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Setting key (unique per user).""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User the setting belongs to. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Sorting of ClientSetting records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ClientSettingOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the setting belongs to. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Id of the owning user.""" ownerId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ClientSetting records.""" type ClientSettingEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ClientSettingEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ClientSettingEntity` and its cursor.""" type ClientSettingEntityEdge { """The item at the end of the edge""" node: ClientSettingEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ClientStoryRead records.""" type ClientStoryReadRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ClientStoryReadEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ClientStoryReadEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ClientStoryReadFilterInput """Sorting of the returned records.""" orderBy: [ClientStoryReadOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ClientStoryReadEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ClientStoryReadFilterInput """Sorting of the returned records.""" orderBy: [ClientStoryReadOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ClientStoryReadEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Mark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it. """ type ClientStoryReadEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment that was read. Set when activityId resolves to an Appointment. """ appointment: AppointmentEntity """Task that was read. Set when activityId resolves to a Task.""" task: TaskEntity """Email that was read. Set when messageId resolves to an Email.""" email: EmailEntity """Memo that was read. Set when messageId resolves to a Memo.""" memo: MemoEntity """User who read the activity or message.""" owner: ClientEntity """ Id of the read appointment or task, or empty when this read points to a message. """ activityId: ID """ Id of the read email or memo, or empty when this read points to an activity. """ messageId: ID """When true, the user explicitly chose not to follow up on this item.""" noFollow: Boolean """Id of the reading user.""" ownerId: ID! """Timestamp the user marked the item as read.""" readAt: DateTime! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ClientStoryRead records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ClientStoryReadFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ClientStoryReadFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ClientStoryReadFilterInput!] """Matches records that do not meet this filter.""" NOT: ClientStoryReadFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the read appointment or task, or empty when this read points to a message. """ activityId: EntityFilterStringField """ Id of the read email or memo, or empty when this read points to an activity. """ messageId: EntityFilterStringField """When true, the user explicitly chose not to follow up on this item.""" noFollow: Boolean """Id of the reading user.""" ownerId: EntityFilterStringField """Timestamp the user marked the item as read.""" readAt: EntityFilterDateTimeField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment that was read. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task that was read. Set when activityId resolves to a Task. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Email that was read. Set when messageId resolves to an Email. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Memo that was read. Set when messageId resolves to a Memo. Matches records where a related record meets these conditions. """ memo: MemoFilterInput """ User who read the activity or message. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Sorting of ClientStoryRead records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ClientStoryReadOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment that was read. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task that was read. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Email that was read. Set when messageId resolves to an Email. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Memo that was read. Set when messageId resolves to a Memo. Sorts by fields of the related record, listed in order of priority. """ memo: [MemoOrderByNestedInput!] """ User who read the activity or message. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Id of the read appointment or task, or empty when this read points to a message. """ activityId: OrderByEnum """ Id of the read email or memo, or empty when this read points to an activity. """ messageId: OrderByEnum """When true, the user explicitly chose not to follow up on this item.""" noFollow: OrderByEnum """Id of the reading user.""" ownerId: OrderByEnum """Timestamp the user marked the item as read.""" readAt: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ClientStoryRead records.""" type ClientStoryReadEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ClientStoryReadEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ClientStoryReadEntity` and its cursor.""" type ClientStoryReadEntityEdge { """The item at the end of the edge""" node: ClientStoryReadEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CloudObject records.""" type CloudObjectRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CloudObjectEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CloudObjectEntity!]! """Returns the files that match the filter, paged with limit and offset.""" getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CloudObjectFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """ When true, also returns files the current user uploaded and images used in online forms or embedded in editors, even when no record visible to the user links to them. Defaults to false. """ includeOwned: Boolean ): [CloudObjectEntity!]! """ Returns the files that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CloudObjectFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """ When true, also returns files the current user uploaded and images used in online forms or embedded in editors, even when no record visible to the user links to them. Defaults to false. """ includeOwned: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns SignedUrl with public downloadable url link and their id.""" getSignedUrls( """List of urls to sign.""" urls: [String!]! """Seconds for url expiration.""" expireIn: Int ): [SignedUrl!]! """ Returns a URL of a PDF preview of an Office document (Word, Excel or PowerPoint file). When the preview cannot be produced, the URL is null and the error explains why. """ getDocumentPreviewUrl( """Id of the document.""" entityId: UUID! ): DocumentPreviewUrl! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectEntityConnection """ Returns those of the given files that are attached to the process or to any email template. Ids of other files are ignored. """ getByIdsForProcess( """Id of the process.""" processId: UUID! """Ids of the files to look up.""" entityIds: [UUID!]! ): [CloudObjectEntity!]! """ Returns those of the given files that are attached to the email sequence. Ids of files not attached to it are ignored. """ getByIdsForEmailSequence( """Id of the email sequence.""" emailSequenceId: UUID! """Ids of the files to look up.""" entityIds: [UUID!]! ): [CloudObjectEntity!]! """ Returns those of the given files that are attached to the report schedule. Ids of files not attached to it are ignored. """ getByIdsForReportSchedule( """Id of the report schedule.""" reportScheduleId: UUID! """Ids of the files to look up.""" entityIds: [UUID!]! ): [CloudObjectEntity!]! """ Returns those of the given files that are attached to the approval process. Ids of files not attached to it are ignored. """ getByIdsForApprovalProcess( """Id of the approval process.""" approvalProcessId: UUID! """Ids of the files to look up.""" entityIds: [UUID!]! ): [CloudObjectEntity!]! """ Returns those of the given files that are attached to the field mapping. Ids of files not attached to it are ignored. """ getByIdsForFieldMapping( """Id of the field mapping.""" fieldMappingId: UUID! """Ids of the files to look up.""" entityIds: [UUID!]! ): [CloudObjectEntity!]! """ Returns those of the given files that were uploaded with a submission of the online form. Ids of other files are ignored. """ getByIdsForOnlineFormType( """Id of the online form.""" onlineFormTypeId: UUID! """Ids of the files to look up.""" entityIds: [UUID!]! ): [CloudObjectEntity!]! } """Paginated list of CloudObject records.""" type CloudObjectEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CloudObjectEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CloudObjectEntity` and its cursor.""" type CloudObjectEntityEdge { """The item at the end of the edge""" node: CloudObjectEntity """A cursor for use in pagination""" cursor: String! } """Temporary signed download link for a file URL.""" type SignedUrl { """The requested URL that was signed.""" url: String! """ Signed link that downloads the file without further authentication until it expires. """ signedUrl: String! } """ PDF preview of an Office document, or the reason why it could not be produced. """ type DocumentPreviewUrl { """ Download URL of the PDF preview; null when the preview could not be produced. """ url: String """Why the preview could not be produced; null on success.""" error: String } """Read operations for CloudObjectFolder records.""" type CloudObjectFolderRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CloudObjectFolderEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CloudObjectFolderEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CloudObjectFolderFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectFolderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CloudObjectFolderEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CloudObjectFolderFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectFolderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectFolderEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of CloudObjectFolder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CloudObjectFolderOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Online form template this folder is associated with, when the folder stores form submissions. Sorts by fields of the related record, listed in order of priority. """ onlineFormType: [OnlineFormTypeOrderByNestedInput!] """ Parent folder, when this folder is nested. Empty for top-level folders. Sorts by fields of the related record, listed in order of priority. """ parentCloudObjectFolder: [CloudObjectFolderOrderByNestedInput!] """ API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. """ entityApiName: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the online form template, or empty when not associated with a form. """ onlineFormTypeId: OrderByEnum """Id of the parent folder, or empty for top-level folders.""" parentCloudObjectFolderId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Folder kind: Company for shared company folders, Record for folders attached to a specific record. """ type: OrderByEnum } """Paginated list of CloudObjectFolder records.""" type CloudObjectFolderEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CloudObjectFolderEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CloudObjectFolderEntity` and its cursor.""" type CloudObjectFolderEntityEdge { """The item at the end of the edge""" node: CloudObjectFolderEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CloudObjectRelation records.""" type CloudObjectRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CloudObjectRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CloudObjectRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CloudObjectRelationFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CloudObjectRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CloudObjectRelationFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of CloudObjectRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CloudObjectRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the file is attached to, or empty when not attached to an account. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Appointment the file is attached to. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task the file is attached to. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Approval process the file is attached to. Sorts by fields of the related record, listed in order of priority. """ approvalProcess: [ApprovalProcessOrderByNestedInput!] """ Call the file is attached to (e.g. a call recording). Sorts by fields of the related record, listed in order of priority. """ call: [CallOrderByNestedInput!] """ Folder the file is filed under within the parent record, or empty when stored at the record root. Sorts by fields of the related record, listed in order of priority. """ cloudObjectFolder: [CloudObjectFolderOrderByNestedInput!] """ Contact the file is attached to, or empty when not attached to a contact. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record the file is attached to. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Email sequence the file is attached to. Sorts by fields of the related record, listed in order of priority. """ emailSequence: [EmailSequenceOrderByNestedInput!] """ Email template the file is attached to as a template attachment. Sorts by fields of the related record, listed in order of priority. """ emailTemplate: [EmailTemplateOrderByNestedInput!] """ Field mapping the file is attached to (e.g. an import file). Sorts by fields of the related record, listed in order of priority. """ fieldMapping: [FieldMappingOrderByNestedInput!] """ Lead the file is attached to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the file is attached to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Media record the file is attached to. Sorts by fields of the related record, listed in order of priority. """ media: [MediaOrderByNestedInput!] """ Email the file is attached to (e.g. an email attachment). Set when messageId resolves to an Email. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Memo the file is attached to. Set when messageId resolves to a Memo. Sorts by fields of the related record, listed in order of priority. """ memo: [MemoOrderByNestedInput!] """ Online form field the file was uploaded into. Sorts by fields of the related record, listed in order of priority. """ onlineFormField: [FieldOrderByNestedInput!] """ Online form submission the file was uploaded with. Sorts by fields of the related record, listed in order of priority. """ onlineForm: [OnlineFormOrderByNestedInput!] """ Sales process the file is attached to. Sorts by fields of the related record, listed in order of priority. """ process: [ProcessOrderByNestedInput!] """ Sales process template the file is attached to. Sorts by fields of the related record, listed in order of priority. """ processTemplate: [ProcessTemplateOrderByNestedInput!] """ Project the file is attached to. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote the file is attached to. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Report schedule the file is attached to (e.g. an exported report). Sorts by fields of the related record, listed in order of priority. """ reportSchedule: [ReportScheduleOrderByNestedInput!] """ Text message (SMS/MMS) the file is attached to. Sorts by fields of the related record, listed in order of priority. """ textMessage: [TextMessageOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the linked appointment or task, or empty when not linked.""" activityId: OrderByEnum """Id of the linked approval process.""" approvalProcessId: OrderByEnum """Id of the linked call.""" callId: OrderByEnum """ Id of the folder within the parent record, or empty when stored at the record root. """ cloudObjectFolderId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked custom entity record.""" customEntityId: OrderByEnum """Id of the linked email sequence.""" emailSequenceId: OrderByEnum """Id of the linked email template.""" emailTemplateId: OrderByEnum """Id of the linked field mapping.""" fieldMappingId: OrderByEnum """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: OrderByEnum """Id of the linked media record.""" mediaId: OrderByEnum """Id of the linked email or memo, or empty when not linked.""" messageId: OrderByEnum """Id of the online form field the file was uploaded into.""" onlineFormFieldId: OrderByEnum """Id of the linked online form submission.""" onlineFormId: OrderByEnum """Id of the linked sales process.""" processId: OrderByEnum """Id of the linked sales process template.""" processTemplateId: OrderByEnum """Id of the linked project.""" projectId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """Id of the linked report schedule.""" reportScheduleId: OrderByEnum """Id of the linked text message.""" textMessageId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related FieldMapping record. Set exactly one field in each item. """ input FieldMappingOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the mapping is shipped by the platform and cannot be deleted by the user. """ isSystem: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Media record. Set exactly one field in each item. """ input MediaOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the linked appointment or task, or empty when not linked to an activity. """ activityId: OrderByEnum """Id of the linked call, or empty when not linked.""" callId: OrderByEnum """Free-text description of the media.""" description: OrderByEnum """ Error code reported by the calling/recording provider when processing failed; empty on success. """ errorCode: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ProcessTemplate record. Set exactly one field in each item. """ input ProcessTemplateOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text description of what the template does.""" description: OrderByEnum """ True when the platform recommends this template (highlighted in the template gallery). """ isRecommended: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template. """ triggerType: OrderByEnum """ For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: OrderByEnum } """ Sorting by a field of the related TextMessage record. Set exactly one field in each item. """ input TextMessageOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: OrderByEnum """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: OrderByEnum """Timestamp the message was sent.""" datetimeSent: OrderByEnum """Direction of the message (Incoming, Outgoing).""" direction: OrderByEnum """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: OrderByEnum """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: OrderByEnum """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for CloudObjectStepRelation records.""" type CloudObjectStepRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CloudObjectStepRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CloudObjectStepRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CloudObjectStepRelationFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectStepRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CloudObjectStepRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CloudObjectStepRelationFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectStepRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectStepRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the files attached to the pipeline step, in their display order. """ getByStepId( """Id of the pipeline step.""" stepId: UUID! ): [CloudObjectStepRelationEntity!]! } """ Sorting of CloudObjectStepRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CloudObjectStepRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Pipeline step the file is attached to. Sorts by fields of the related record, listed in order of priority. """ step: [StepOrderByNestedInput!] """Position of the file within the step's document list.""" sortOrder: OrderByEnum """Id of the pipeline step.""" stepId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for CloudObjectTemplate records.""" type CloudObjectTemplateRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CloudObjectTemplateEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CloudObjectTemplateEntity!]! """Returns the files that match the filter, paged with limit and offset.""" getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CloudObjectTemplateFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """ When true, also returns files the current user uploaded and images used in online forms or embedded in editors, even when no record visible to the user links to them. Defaults to false. """ includeOwned: Boolean ): [CloudObjectTemplateEntity!]! """ Returns the files that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CloudObjectTemplateFilterInput """Sorting of the returned records.""" orderBy: [CloudObjectTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """ When true, also returns files the current user uploaded and images used in online forms or embedded in editors, even when no record visible to the user links to them. Defaults to false. """ includeOwned: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CloudObjectTemplateEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns SignedUrl with public downloadable url link and their id.""" getSignedUrls( """List of urls to sign.""" urls: [String!]! """Seconds for url expiration.""" expireIn: Int ): [SignedUrl!]! """ Returns a URL of a PDF preview of an Office document (Word, Excel or PowerPoint file). When the preview cannot be produced, the URL is null and the error explains why. """ getDocumentPreviewUrl( """Id of the document.""" entityId: UUID! ): DocumentPreviewUrl! } """ Sorting of CloudObjectTemplate records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CloudObjectTemplateOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Application that produced the object (e.g. Online Forms). Sorts by fields of the related record, listed in order of priority. """ application: [ApplicationOrderByNestedInput!] """ Company-level folder that contains the object, when stored in the company document tree. Sorts by fields of the related record, listed in order of priority. """ companyCloudObjectFolder: [CloudObjectFolderOrderByNestedInput!] """ User who uploaded the object. Sorts by fields of the related record, listed in order of priority. """ creator: [ClientOrderByNestedInput!] """Id of the producing application.""" applicationId: OrderByEnum """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: OrderByEnum """Id of the uploading user.""" creatorId: OrderByEnum """File name (with extension) used when downloading the object.""" filename: OrderByEnum """When true, the object can be served via a public URL (see publicUrl).""" isPublic: OrderByEnum """Mime-type of the cloud object Is detected from content.""" mimeType: OrderByEnum """Size of the object in bytes.""" size: OrderByEnum """ Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. """ status: OrderByEnum """ Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. """ templateEntityName: OrderByEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. """ templateEntityApiName: OrderByEnum } """Paginated list of CloudObjectTemplate records.""" type CloudObjectTemplateEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CloudObjectTemplateEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CloudObjectTemplateEntity` and its cursor.""" type CloudObjectTemplateEntityEdge { """The item at the end of the edge""" node: CloudObjectTemplateEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CompanyEmail records.""" type CompanyEmailRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CompanyEmailEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CompanyEmailEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CompanyEmailFilterInput """Sorting of the returned records.""" orderBy: [CompanyEmailOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CompanyEmailEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CompanyEmailFilterInput """Sorting of the returned records.""" orderBy: [CompanyEmailOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CompanyEmailEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns all company email accounts of the space, including those shared with other users, for administration. """ getAllForAdmin( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CompanyEmailFilterInput """Sorting of the returned records.""" orderBy: [CompanyEmailOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CompanyEmailEntity!]! } """Paginated list of CompanyEmail records.""" type CompanyEmailEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CompanyEmailEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CompanyEmailEntity` and its cursor.""" type CompanyEmailEntityEdge { """The item at the end of the edge""" node: CompanyEmailEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Contact records.""" type ContactRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactFilterInput """Sorting of the returned records.""" orderBy: [ContactOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactFilterInput """Sorting of the returned records.""" orderBy: [ContactOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns the contacts linked to the given account, optionally narrowed by name. """ getRelatedToAccount( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactFilterInput """Sorting of the returned records.""" orderBy: [ContactOrderByInput!] """ Id of the account; when omitted, contacts are not limited to one account. """ accountId: UUID """Text the contact's full name must contain, case-insensitive.""" filterByName: String ): [ContactEntity!]! """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): ContactEntity! """ Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. """ aiAutoPrefill( """ Id of the suggested action, as returned by the AI record suggestions or AI chat. """ actionId: String! ): ContactAutoPrefill! } """Paginated list of Contact records.""" type ContactEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ContactEntity` and its cursor.""" type ContactEntityEdge { """The item at the end of the edge""" node: ContactEntity """A cursor for use in pagination""" cursor: String! } """ New, unsaved contact pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in. """ type ContactAutoPrefill { """New contact carrying the pre-filled values; it is not saved.""" entity: ContactEntity """Ids of the fields that were filled in.""" fieldIds: [UUID!]! } """Read operations for ContactAccountAccountRoleRelation records.""" type ContactAccountAccountRoleRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactAccountAccountRoleRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactAccountAccountRoleRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactAccountAccountRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactAccountAccountRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactAccountAccountRoleRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactAccountAccountRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactAccountAccountRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactAccountAccountRoleRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ContactAccountAccountRoleRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactAccountAccountRoleRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Role assigned to the contact at the account. Sorts by fields of the related record, listed in order of priority. """ accountRole: [AccountRoleOrderByNestedInput!] """ Contact-account link this role assignment belongs to. Sorts by fields of the related record, listed in order of priority. """ contactAccountRelation: [ContactAccountRelationOrderByNestedInput!] """Id of the role assigned to the contact at the account.""" accountRoleId: OrderByEnum """Id of the contact-account link.""" contactAccountRelationId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related AccountRole record. Set exactly one field in each item. """ input AccountRoleOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" label: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ContactAccountRelation record. Set exactly one field in each item. """ input ContactAccountRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the account the contact is linked to.""" accountId: OrderByEnum """Free-form note describing this contact-account link.""" comment: OrderByEnum """Id of the contact linked to the account.""" contactId: OrderByEnum """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: OrderByEnum """Job title or position the contact holds at the account.""" position: OrderByEnum """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ContactAccountAccountRoleRelation records.""" type ContactAccountAccountRoleRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactAccountAccountRoleRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ContactAccountAccountRoleRelationEntity` and its cursor. """ type ContactAccountAccountRoleRelationEntityEdge { """The item at the end of the edge""" node: ContactAccountAccountRoleRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ContactAccountRelation records.""" type ContactAccountRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactAccountRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactAccountRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactAccountRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactAccountRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ContactAccountRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactAccountRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the contact is linked to. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Contact linked to the account. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """Id of the account the contact is linked to.""" accountId: OrderByEnum """Free-form note describing this contact-account link.""" comment: OrderByEnum """Id of the contact linked to the account.""" contactId: OrderByEnum """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: OrderByEnum """Job title or position the contact holds at the account.""" position: OrderByEnum """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ContactDataExRelation records.""" type ContactDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Option selected in a multi-select checkbox field of a contact; there is one link per selected option. """ type ContactDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact on which the option is selected.""" contact: ContactEntity """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Id of the contact on which the option is selected.""" contactId: ID! """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ContactDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the contact on which the option is selected.""" contactId: EntityFilterStringField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Contact on which the option is selected. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput } """ Sorting of ContactDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """Id of the contact on which the option is selected.""" contactId: OrderByEnum """Id of the selected option.""" dataId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ContactDataExRelation records.""" type ContactDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ContactDataExRelationEntity` and its cursor. """ type ContactDataExRelationEntityEdge { """The item at the end of the edge""" node: ContactDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ContactKPI records.""" type ContactKPIRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactKPIEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactKPIEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactKPIFilterInput """Sorting of the returned records.""" orderBy: [ContactKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactKPIEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactKPIFilterInput """Sorting of the returned records.""" orderBy: [ContactKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactKPIEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Recorded KPI event of a contact, such as its creation, archiving or the first and last email sent, used in KPI reports. """ type ContactKPIEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ User who triggered the KPI event (e.g. created or archived the contact, sent the first email). """ client: ClientEntity """Contact this KPI event relates to.""" contact: ContactEntity """Contact owner at the time the KPI event occurred.""" owner: ClientEntity """Sales unit the triggering user belonged to at the time of the event.""" unit: SalesUnitEntity """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """Id of the contact this KPI event relates to.""" contactId: ID! """ KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: ContactKpiEnum! """Id of the contact owner at the time of the event.""" ownerId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of contact event recorded as a KPI entry; each contact keeps at most one entry per kind. """ enum ContactKpiEnum { """The contact was created.""" CreateContact """The most recent email was sent to the contact.""" LastEmailSent """The first email was sent to the contact.""" FirstEmailSent """The contact was archived; the entry is removed when it is unarchived.""" Archive """The contact was last modified.""" LastModified } """ Filter conditions for ContactKPI records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactKPIFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactKPIFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactKPIFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactKPIFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: EntityFilterStringField """Id of the user who triggered the event.""" clientId: EntityFilterStringField """Id of the contact this KPI event relates to.""" contactId: EntityFilterStringField """ KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: ContactKpiEnumFilterInput """Id of the contact owner at the time of the event.""" ownerId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who triggered the KPI event (e.g. created or archived the contact, sent the first email). Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Contact this KPI event relates to. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Contact owner at the time the KPI event occurred. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales unit the triggering user belonged to at the time of the event. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ContactKpiEnumFilterInput { """Matches any of the listed values.""" eq: [ContactKpiEnum!] """Matches values that do not meet this condition.""" NOT: ContactKpiEnumFilterInput } """ Sorting of ContactKPI records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactKPIOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who triggered the KPI event (e.g. created or archived the contact, sent the first email). Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Contact this KPI event relates to. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Contact owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Sales unit the triggering user belonged to at the time of the event. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the user who triggered the event.""" clientId: OrderByEnum """Id of the contact this KPI event relates to.""" contactId: OrderByEnum """Id of the contact owner at the time of the event.""" ownerId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ContactKPI records.""" type ContactKPIEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactKPIEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ContactKPIEntity` and its cursor.""" type ContactKPIEntityEdge { """The item at the end of the edge""" node: ContactKPIEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ContactRelation records.""" type ContactRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactRelationEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Link between two related contacts, such as colleagues or family members; its labels give the kind of relationship. """ type ContactRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """One side of the contact-to-contact relationship.""" contact1: ContactEntity """Other side of the contact-to-contact relationship.""" contact2: ContactEntity """Id of the first related contact.""" contact1Id: ID! """Id of the second related contact.""" contact2Id: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ContactRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the first related contact.""" contact1Id: EntityFilterStringField """Id of the second related contact.""" contact2Id: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ One side of the contact-to-contact relationship. Matches records where a related record meets these conditions. """ contact1: ContactFilterInput """ Other side of the contact-to-contact relationship. Matches records where a related record meets these conditions. """ contact2: ContactFilterInput } """ Sorting of ContactRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ One side of the contact-to-contact relationship. Sorts by fields of the related record, listed in order of priority. """ contact1: [ContactOrderByNestedInput!] """ Other side of the contact-to-contact relationship. Sorts by fields of the related record, listed in order of priority. """ contact2: [ContactOrderByNestedInput!] """Id of the first related contact.""" contact1Id: OrderByEnum """Id of the second related contact.""" contact2Id: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ContactRelationLabel records.""" type ContactRelationLabelRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactRelationLabelEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactRelationLabelEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactRelationLabelFilterInput """Sorting of the returned records.""" orderBy: [ContactRelationLabelOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactRelationLabelEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactRelationLabelFilterInput """Sorting of the returned records.""" orderBy: [ContactRelationLabelOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactRelationLabelEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Relationship type assigned to a link between two contacts, such as Spouse or Colleague. """ type ContactRelationLabelEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact relationship being labelled.""" contactRelation: ContactRelationEntity """Type of the relationship (e.g. spouse, colleague).""" contactRelationType: ContactRelationTypeEntity """Id of the contact relationship.""" contactRelationId: ID! """Id of the relationship type.""" contactRelationTypeId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of relationship that can be assigned to a link between two contacts, such as Spouse or Colleague, with its display color. """ type ContactRelationTypeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """ Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). """ label: String """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ContactRelationLabel records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactRelationLabelFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactRelationLabelFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactRelationLabelFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactRelationLabelFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the contact relationship.""" contactRelationId: EntityFilterStringField """Id of the relationship type.""" contactRelationTypeId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Contact relationship being labelled. Matches records where a related record meets these conditions. """ contactRelation: ContactRelationFilterInput """ Type of the relationship (e.g. spouse, colleague). Matches records where a related record meets these conditions. """ contactRelationType: ContactRelationTypeFilterInput } """ Filter conditions for ContactRelationType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ContactRelationTypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ContactRelationTypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ContactRelationTypeFilterInput!] """Matches records that do not meet this filter.""" NOT: ContactRelationTypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: EntityFilterNumberField """ Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). """ label: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Sorting of ContactRelationLabel records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactRelationLabelOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact relationship being labelled. Sorts by fields of the related record, listed in order of priority. """ contactRelation: [ContactRelationOrderByNestedInput!] """ Type of the relationship (e.g. spouse, colleague). Sorts by fields of the related record, listed in order of priority. """ contactRelationType: [ContactRelationTypeOrderByNestedInput!] """Id of the contact relationship.""" contactRelationId: OrderByEnum """Id of the relationship type.""" contactRelationTypeId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ContactRelation record. Set exactly one field in each item. """ input ContactRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the first related contact.""" contact1Id: OrderByEnum """Id of the second related contact.""" contact2Id: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related ContactRelationType record. Set exactly one field in each item. """ input ContactRelationTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """ Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). """ label: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ContactRelationType records.""" type ContactRelationTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactRelationTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactRelationTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [ContactRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactRelationTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [ContactRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactRelationTypeEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ContactRelationType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactRelationTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """ Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). """ label: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ContactSharingClientRelation records.""" type ContactSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ContactSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the contact is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Contact being shared. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the shared contact.""" contactId: OrderByEnum """ Access the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ContactSharingSalesUnitRelation records.""" type ContactSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ContactSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact being shared. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Sales unit the contact is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared contact.""" contactId: OrderByEnum """ Access the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ContactSocialRelation records.""" type ContactSocialRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactSocialRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactSocialRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactSocialRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactSocialRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactSocialRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactSocialRelationFilterInput """Sorting of the returned records.""" orderBy: [ContactSocialRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactSocialRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ContactSocialRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ContactSocialRelationOrderByInput { """Unique identifier of entity. Must match with Contact id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """AngelList profile URL of the contact.""" angellistUrl: OrderByEnum """Crunchbase profile URL of the contact.""" crunchbaseUrl: OrderByEnum """Disqus profile URL of the contact.""" disqusUrl: OrderByEnum """Facebook profile URL of the contact.""" facebookUrl: OrderByEnum """Flickr profile URL of the contact.""" flickrUrl: OrderByEnum """Foursquare profile URL of the contact.""" foursquareUrl: OrderByEnum """Google+ profile URL of the contact.""" googlePlusUrl: OrderByEnum """Gravatar profile URL of the contact.""" gravatarUrl: OrderByEnum """Klout profile URL of the contact.""" kloutUrl: OrderByEnum """LinkedIn profile URL of the contact.""" linkedinUrl: OrderByEnum """Pinterest profile URL of the contact.""" pinterestUrl: OrderByEnum """Quora profile URL of the contact.""" quoraUrl: OrderByEnum """Reddit profile URL of the contact.""" redditUrl: OrderByEnum """Skype contact URL or username of the contact.""" skypeUrl: OrderByEnum """SlideShare profile URL of the contact.""" slideshareUrl: OrderByEnum """Twitter (X) profile URL of the contact.""" twitterUrl: OrderByEnum """Vimeo profile URL of the contact.""" vimeoUrl: OrderByEnum """WordPress site URL of the contact.""" wordpressUrl: OrderByEnum """XING profile URL of the contact.""" xingUrl: OrderByEnum """Yahoo profile URL of the contact.""" yahooUrl: OrderByEnum """Yelp profile URL of the contact.""" yelpUrl: OrderByEnum """YouTube channel URL of the contact.""" youtubeUrl: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ContactSocialRelation records.""" type ContactSocialRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactSocialRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ContactSocialRelationEntity` and its cursor. """ type ContactSocialRelationEntityEdge { """The item at the end of the edge""" node: ContactSocialRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ContactType records.""" type ContactTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ContactTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ContactTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactTypeFilterInput """Sorting of the returned records.""" orderBy: [ContactTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ContactTypeFilterInput """Sorting of the returned records.""" orderBy: [ContactTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ContactTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ContactTypeFilterInput """Sorting of the returned records.""" orderBy: [ContactTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ContactTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: ContactTypeFilterInput """Sorting of the returned records.""" orderBy: [ContactTypeOrderByInput!] ): [ContactTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): ContactTypeEntity! } """Paginated list of ContactType records.""" type ContactTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ContactTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ContactTypeEntity` and its cursor.""" type ContactTypeEntityEdge { """The item at the end of the edge""" node: ContactTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CountryCrm records.""" type CountryCrmRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CountryCrmEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CountryCrmEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CountryCrmFilterInput """Sorting of the returned records.""" orderBy: [CountryCrmOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CountryCrmEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CountryCrmFilterInput """Sorting of the returned records.""" orderBy: [CountryCrmOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CountryCrmEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Country offered in address fields; a new country value on a record must match one of these countries. """ type CountryCrmEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """ Whether the country name is a localization key to be translated into the user language rather than displayed verbatim. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for CountryCrm records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CountryCrmFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CountryCrmFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CountryCrmFilterInput!] """Matches records that do not meet this filter.""" NOT: CountryCrmFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Whether the country name is a localization key to be translated into the user language rather than displayed verbatim. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Sorting of CountryCrm records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CountryCrmOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Whether the country name is a localization key to be translated into the user language rather than displayed verbatim. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of CountryCrm records.""" type CountryCrmEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CountryCrmEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CountryCrmEntity` and its cursor.""" type CountryCrmEntityEdge { """The item at the end of the edge""" node: CountryCrmEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Currency records.""" type CurrencyRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CurrencyEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CurrencyEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CurrencyFilterInput """Sorting of the returned records.""" orderBy: [CurrencyOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CurrencyEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CurrencyFilterInput """Sorting of the returned records.""" orderBy: [CurrencyOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CurrencyEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the base currency of the space, in which amounts are converted and reported. """ getBase: CurrencyEntity! } """Paginated list of Currency records.""" type CurrencyEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CurrencyEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CurrencyEntity` and its cursor.""" type CurrencyEntityEdge { """The item at the end of the edge""" node: CurrencyEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CurrencyExchangeRate records.""" type CurrencyExchangeRateRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CurrencyExchangeRateEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CurrencyExchangeRateEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CurrencyExchangeRateFilterInput """Sorting of the returned records.""" orderBy: [CurrencyExchangeRateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CurrencyExchangeRateEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CurrencyExchangeRateFilterInput """Sorting of the returned records.""" orderBy: [CurrencyExchangeRateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CurrencyExchangeRateEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of CurrencyExchangeRate records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CurrencyExchangeRateOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Effective period (exchange rate list) this rate belongs to. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRateList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Currency the exchange rate applies to. Cannot be the base currency. Sorts by fields of the related record, listed in order of priority. """ currency: [CurrencyOrderByNestedInput!] """Id of the exchange rate list (effective period) this rate belongs to.""" currencyExchangeRateListId: OrderByEnum """ Id of the currency the exchange rate applies to. Cannot be the base currency. """ currencyId: OrderByEnum """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for CurrencyExchangeRatesList records.""" type CurrencyExchangeRatesListRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CurrencyExchangeRatesListEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CurrencyExchangeRatesListEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CurrencyExchangeRatesListFilterInput """Sorting of the returned records.""" orderBy: [CurrencyExchangeRatesListOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CurrencyExchangeRatesListEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CurrencyExchangeRatesListFilterInput """Sorting of the returned records.""" orderBy: [CurrencyExchangeRatesListOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CurrencyExchangeRatesListEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Paginated list of CurrencyExchangeRatesList records.""" type CurrencyExchangeRatesListEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CurrencyExchangeRatesListEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `CurrencyExchangeRatesListEntity` and its cursor. """ type CurrencyExchangeRatesListEntityEdge { """The item at the end of the edge""" node: CurrencyExchangeRatesListEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CustomEntity records.""" type CustomEntityRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CustomEntityEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CustomEntityEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntityFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntityEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CustomEntityFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntityEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntityEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): CustomEntityEntity! } """Paginated list of CustomEntity records.""" type CustomEntityEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CustomEntityEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CustomEntityEntity` and its cursor.""" type CustomEntityEntityEdge { """The item at the end of the edge""" node: CustomEntityEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CustomEntityDataExRelation records.""" type CustomEntityDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CustomEntityDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CustomEntityDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntityDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntityDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CustomEntityDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntityDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Option selected in a multi-select checkbox field of a custom entity record; there is one link per selected option. """ type CustomEntityDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Custom entity record on which the option is selected.""" customEntity: CustomEntityEntity """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Id of the custom entity record on which the option is selected.""" customEntityId: ID! """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for CustomEntityDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CustomEntityDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CustomEntityDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CustomEntityDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: CustomEntityDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the custom entity record on which the option is selected.""" customEntityId: EntityFilterStringField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Custom entity record on which the option is selected. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput } """ Sorting of CustomEntityDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CustomEntityDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Custom entity record on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """Id of the custom entity record on which the option is selected.""" customEntityId: OrderByEnum """Id of the selected option.""" dataId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of CustomEntityDataExRelation records.""" type CustomEntityDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CustomEntityDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `CustomEntityDataExRelationEntity` and its cursor. """ type CustomEntityDataExRelationEntityEdge { """The item at the end of the edge""" node: CustomEntityDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CustomEntityRelation records.""" type CustomEntityRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CustomEntityRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CustomEntityRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntityRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntityRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CustomEntityRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntityRelationEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntityRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntityRelationEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: CustomEntityRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityRelationOrderByInput!] ): [CustomEntityRelationEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): CustomEntityRelationEntity! } """ Custom relation that links records of two entities through a pair of relation fields, one on each side. """ type CustomEntityRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Lookup field on the first side of the custom relation: the lookup field the relation was created from. """ field1: FieldEntity """ Lookup field on the second side of the custom relation, created automatically on the linked entity. """ field2: FieldEntity """ Condition limiting which records of the field_1 entity can be selected in field_2, as a JSON object conforming to the `FieldFilter` type; empty for no restriction. """ entityFilter1: JSONString """ Condition limiting which records of the field_2 entity can be selected in field_1, as a JSON object conforming to the `FieldFilter` type; empty for no restriction. """ entityFilter2: JSONString """Id of the lookup field on the first side of the custom relation.""" field1Id: ID! """Id of the lookup field on the second side of the custom relation.""" field2Id: ID! """ When true, one of the records linked through the relation can be marked as primary. Cannot be switched back to false once enabled. """ hasIsPrimary: Boolean """ When true, field2 offers only records related to the record being edited. Not supported yet; must be false. """ showRelated1: Boolean """ When true, field1 offers only records related to the record being edited (e.g. the contacts of its account). """ showRelated2: Boolean """ When true, the records linked through field1 are shown in a tab named tabName1. """ showTab1: Boolean! """ When true, the records linked through field2 are shown in a tab named tabName2. """ showTab2: Boolean! """Name of the tab that shows the records linked through field1.""" tabName1: String! """Name of the tab that shows the records linked through field2.""" tabName2: String! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for CustomEntityRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CustomEntityRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CustomEntityRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CustomEntityRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: CustomEntityRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the lookup field on the first side of the custom relation.""" field1Id: EntityFilterStringField """Id of the lookup field on the second side of the custom relation.""" field2Id: EntityFilterStringField """ When true, one of the records linked through the relation can be marked as primary. Cannot be switched back to false once enabled. """ hasIsPrimary: Boolean """ When true, field2 offers only records related to the record being edited. Not supported yet; must be false. """ showRelated1: Boolean """ When true, field1 offers only records related to the record being edited (e.g. the contacts of its account). """ showRelated2: Boolean """ When true, the records linked through field1 are shown in a tab named tabName1. """ showTab1: Boolean """ When true, the records linked through field2 are shown in a tab named tabName2. """ showTab2: Boolean """Name of the tab that shows the records linked through field1.""" tabName1: EntityFilterStringField """Name of the tab that shows the records linked through field2.""" tabName2: EntityFilterStringField """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Lookup field on the first side of the custom relation: the lookup field the relation was created from. Matches records where a related record meets these conditions. """ field1: FieldFilterInput """ Lookup field on the second side of the custom relation, created automatically on the linked entity. Matches records where a related record meets these conditions. """ field2: FieldFilterInput } """ Sorting of CustomEntityRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CustomEntityRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lookup field on the first side of the custom relation: the lookup field the relation was created from. Sorts by fields of the related record, listed in order of priority. """ field1: [FieldOrderByNestedInput!] """ Lookup field on the second side of the custom relation, created automatically on the linked entity. Sorts by fields of the related record, listed in order of priority. """ field2: [FieldOrderByNestedInput!] """Id of the lookup field on the first side of the custom relation.""" field1Id: OrderByEnum """Id of the lookup field on the second side of the custom relation.""" field2Id: OrderByEnum """ When true, one of the records linked through the relation can be marked as primary. Cannot be switched back to false once enabled. """ hasIsPrimary: OrderByEnum """ When true, field2 offers only records related to the record being edited. Not supported yet; must be false. """ showRelated1: OrderByEnum """ When true, field1 offers only records related to the record being edited (e.g. the contacts of its account). """ showRelated2: OrderByEnum """ When true, the records linked through field1 are shown in a tab named tabName1. """ showTab1: OrderByEnum """ When true, the records linked through field2 are shown in a tab named tabName2. """ showTab2: OrderByEnum """Name of the tab that shows the records linked through field1.""" tabName1: OrderByEnum """Name of the tab that shows the records linked through field2.""" tabName2: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of CustomEntityRelation records.""" type CustomEntityRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CustomEntityRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CustomEntityRelationEntity` and its cursor.""" type CustomEntityRelationEntityEdge { """The item at the end of the edge""" node: CustomEntityRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CustomEntityRelationData records.""" type CustomEntityRelationDataRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CustomEntityRelationDataEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CustomEntityRelationDataEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntityRelationDataFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityRelationDataOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntityRelationDataEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CustomEntityRelationDataFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityRelationDataOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntityRelationDataEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Link between two records made through a custom relation, such as an account linked to a custom entity record. """ type CustomEntityRelationDataEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account on the field1 side of this custom relation link; empty when that record is of another type. """ account1: AccountEntity """ Account on the field2 side of this custom relation link; empty when that record is of another type. """ account2: AccountEntity """ Appointment on the field1 side of this custom relation link; empty when that record is of another type. """ appointment1: AppointmentEntity """ Task on the field1 side of this custom relation link; empty when that record is of another type. """ task1: TaskEntity """ Appointment on the field2 side of this custom relation link; empty when that record is of another type. """ appointment2: AppointmentEntity """ Task on the field2 side of this custom relation link; empty when that record is of another type. """ task2: TaskEntity """ User on the field1 side of this custom relation link; empty when that record is of another type. """ client1: ClientEntity """ User on the field2 side of this custom relation link; empty when that record is of another type. """ client2: ClientEntity """ Contact on the field1 side of this custom relation link; empty when that record is of another type. """ contact1: ContactEntity """ Contact on the field2 side of this custom relation link; empty when that record is of another type. """ contact2: ContactEntity """ Custom entity record on the field1 side of this custom relation link; empty when that record is of another type. """ customEntity1: CustomEntityEntity """ Custom entity record on the field2 side of this custom relation link; empty when that record is of another type. """ customEntity2: CustomEntityEntity """Custom relation (pair of lookup fields) this link belongs to.""" customEntityRelation: CustomEntityRelationEntity """ Lead on the field1 side of this custom relation link; empty when that record is of another type. """ lead1: LeadEntity """ Opportunity on the field1 side of this custom relation link; empty when that record is of another type. """ oppty1: OpportunityEntity """ Lead on the field2 side of this custom relation link; empty when that record is of another type. """ lead2: LeadEntity """ Opportunity on the field2 side of this custom relation link; empty when that record is of another type. """ oppty2: OpportunityEntity """ Opportunity product line on the field1 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation1: OpptyProductRelationEntity """ Opportunity product line on the field2 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation2: OpptyProductRelationEntity """ Product on the field1 side of this custom relation link; empty when that record is of another type. """ product1: ProductEntity """ Product on the field2 side of this custom relation link; empty when that record is of another type. """ product2: ProductEntity """ Project on the field1 side of this custom relation link; empty when that record is of another type. """ project1: ProjectEntity """ Project on the field2 side of this custom relation link; empty when that record is of another type. """ project2: ProjectEntity """ Quote on the field1 side of this custom relation link; empty when that record is of another type. """ quote1: QuoteEntity """ Quote on the field2 side of this custom relation link; empty when that record is of another type. """ quote2: QuoteEntity """ Id of the account on the field1 side of this custom relation link; empty when that record is of another type. """ account1Id: ID """ Id of the account on the field2 side of this custom relation link; empty when that record is of another type. """ account2Id: ID """ Id of the appointment or task on the field1 side of this custom relation link; empty when that record is of another type. """ activity1Id: ID """ Id of the appointment or task on the field2 side of this custom relation link; empty when that record is of another type. """ activity2Id: ID """ Id of the user on the field1 side of this custom relation link; empty when that record is of another type. """ client1Id: ID """ Id of the user on the field2 side of this custom relation link; empty when that record is of another type. """ client2Id: ID """ Id of the contact on the field1 side of this custom relation link; empty when that record is of another type. """ contact1Id: ID """ Id of the contact on the field2 side of this custom relation link; empty when that record is of another type. """ contact2Id: ID """ Id of the custom entity record on the field1 side of this custom relation link; empty when that record is of another type. """ customEntity1Id: ID """ Id of the custom entity record on the field2 side of this custom relation link; empty when that record is of another type. """ customEntity2Id: ID """Id of the custom relation this link belongs to.""" customEntityRelationId: ID! """ True when the linked record is the primary one among the records linked through the same lookup field; used when the custom relation has hasIsPrimary enabled. """ isPrimary: Boolean """ Id of the lead or opportunity on the field1 side of this custom relation link; empty when that record is of another type. """ leadOppty1Id: ID """ Id of the lead or opportunity on the field2 side of this custom relation link; empty when that record is of another type. """ leadOppty2Id: ID """ Id of the opportunity product line on the field1 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation1Id: ID """ Id of the opportunity product line on the field2 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation2Id: ID """ Id of the product on the field1 side of this custom relation link; empty when that record is of another type. """ product1Id: ID """ Id of the product on the field2 side of this custom relation link; empty when that record is of another type. """ product2Id: ID """ Id of the project on the field1 side of this custom relation link; empty when that record is of another type. """ project1Id: ID """ Id of the project on the field2 side of this custom relation link; empty when that record is of another type. """ project2Id: ID """ Id of the quote on the field1 side of this custom relation link; empty when that record is of another type. """ quote1Id: ID """ Id of the quote on the field2 side of this custom relation link; empty when that record is of another type. """ quote2Id: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for CustomEntityRelationData records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input CustomEntityRelationDataFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [CustomEntityRelationDataFilterInput!] """Matches records that meet all of the listed filters.""" AND: [CustomEntityRelationDataFilterInput!] """Matches records that do not meet this filter.""" NOT: CustomEntityRelationDataFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the account on the field1 side of this custom relation link; empty when that record is of another type. """ account1Id: EntityFilterStringField """ Id of the account on the field2 side of this custom relation link; empty when that record is of another type. """ account2Id: EntityFilterStringField """ Id of the appointment or task on the field1 side of this custom relation link; empty when that record is of another type. """ activity1Id: EntityFilterStringField """ Id of the appointment or task on the field2 side of this custom relation link; empty when that record is of another type. """ activity2Id: EntityFilterStringField """ Id of the user on the field1 side of this custom relation link; empty when that record is of another type. """ client1Id: EntityFilterStringField """ Id of the user on the field2 side of this custom relation link; empty when that record is of another type. """ client2Id: EntityFilterStringField """ Id of the contact on the field1 side of this custom relation link; empty when that record is of another type. """ contact1Id: EntityFilterStringField """ Id of the contact on the field2 side of this custom relation link; empty when that record is of another type. """ contact2Id: EntityFilterStringField """ Id of the custom entity record on the field1 side of this custom relation link; empty when that record is of another type. """ customEntity1Id: EntityFilterStringField """ Id of the custom entity record on the field2 side of this custom relation link; empty when that record is of another type. """ customEntity2Id: EntityFilterStringField """Id of the custom relation this link belongs to.""" customEntityRelationId: EntityFilterStringField """ True when the linked record is the primary one among the records linked through the same lookup field; used when the custom relation has hasIsPrimary enabled. """ isPrimary: Boolean """ Id of the lead or opportunity on the field1 side of this custom relation link; empty when that record is of another type. """ leadOppty1Id: EntityFilterStringField """ Id of the lead or opportunity on the field2 side of this custom relation link; empty when that record is of another type. """ leadOppty2Id: EntityFilterStringField """ Id of the opportunity product line on the field1 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation1Id: EntityFilterStringField """ Id of the opportunity product line on the field2 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation2Id: EntityFilterStringField """ Id of the product on the field1 side of this custom relation link; empty when that record is of another type. """ product1Id: EntityFilterStringField """ Id of the product on the field2 side of this custom relation link; empty when that record is of another type. """ product2Id: EntityFilterStringField """ Id of the project on the field1 side of this custom relation link; empty when that record is of another type. """ project1Id: EntityFilterStringField """ Id of the project on the field2 side of this custom relation link; empty when that record is of another type. """ project2Id: EntityFilterStringField """ Id of the quote on the field1 side of this custom relation link; empty when that record is of another type. """ quote1Id: EntityFilterStringField """ Id of the quote on the field2 side of this custom relation link; empty when that record is of another type. """ quote2Id: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ account1: AccountFilterInput """ Account on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ account2: AccountFilterInput """ Appointment on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ appointment1: AppointmentFilterInput """ Task on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ task1: TaskFilterInput """ Appointment on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ appointment2: AppointmentFilterInput """ Task on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ task2: TaskFilterInput """ User on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ client1: ClientFilterInput """ User on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ client2: ClientFilterInput """ Contact on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ contact1: ContactFilterInput """ Contact on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ contact2: ContactFilterInput """ Custom entity record on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ customEntity1: CustomEntityFilterInput """ Custom entity record on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ customEntity2: CustomEntityFilterInput """ Custom relation (pair of lookup fields) this link belongs to. Matches records where a related record meets these conditions. """ customEntityRelation: CustomEntityRelationFilterInput """ Lead on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ lead1: LeadFilterInput """ Opportunity on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ oppty1: OpportunityFilterInput """ Lead on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ lead2: LeadFilterInput """ Opportunity on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ oppty2: OpportunityFilterInput """ Opportunity product line on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ opptyProductRelation1: OpptyProductRelationFilterInput """ Opportunity product line on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ opptyProductRelation2: OpptyProductRelationFilterInput """ Product on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ product1: ProductFilterInput """ Product on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ product2: ProductFilterInput """ Project on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ project1: ProjectFilterInput """ Project on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ project2: ProjectFilterInput """ Quote on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ quote1: QuoteFilterInput """ Quote on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions. """ quote2: QuoteFilterInput } """ Sorting of CustomEntityRelationData records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CustomEntityRelationDataOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ account1: [AccountOrderByNestedInput!] """ Account on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ account2: [AccountOrderByNestedInput!] """ Appointment on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ appointment1: [AppointmentOrderByNestedInput!] """ Task on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ task1: [TaskOrderByNestedInput!] """ Appointment on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ appointment2: [AppointmentOrderByNestedInput!] """ Task on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ task2: [TaskOrderByNestedInput!] """ User on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ client1: [ClientOrderByNestedInput!] """ User on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ client2: [ClientOrderByNestedInput!] """ Contact on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ contact1: [ContactOrderByNestedInput!] """ Contact on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ contact2: [ContactOrderByNestedInput!] """ Custom entity record on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ customEntity1: [CustomEntityOrderByNestedInput!] """ Custom entity record on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ customEntity2: [CustomEntityOrderByNestedInput!] """ Custom relation (pair of lookup fields) this link belongs to. Sorts by fields of the related record, listed in order of priority. """ customEntityRelation: [CustomEntityRelationOrderByNestedInput!] """ Lead on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ lead1: [LeadOrderByNestedInput!] """ Opportunity on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ oppty1: [OpportunityOrderByNestedInput!] """ Lead on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ lead2: [LeadOrderByNestedInput!] """ Opportunity on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ oppty2: [OpportunityOrderByNestedInput!] """ Opportunity product line on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelation1: [OpptyProductRelationOrderByNestedInput!] """ Opportunity product line on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelation2: [OpptyProductRelationOrderByNestedInput!] """ Product on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ product1: [ProductOrderByNestedInput!] """ Product on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ product2: [ProductOrderByNestedInput!] """ Project on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ project1: [ProjectOrderByNestedInput!] """ Project on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ project2: [ProjectOrderByNestedInput!] """ Quote on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ quote1: [QuoteOrderByNestedInput!] """ Quote on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority. """ quote2: [QuoteOrderByNestedInput!] """ Id of the account on the field1 side of this custom relation link; empty when that record is of another type. """ account1Id: OrderByEnum """ Id of the account on the field2 side of this custom relation link; empty when that record is of another type. """ account2Id: OrderByEnum """ Id of the appointment or task on the field1 side of this custom relation link; empty when that record is of another type. """ activity1Id: OrderByEnum """ Id of the appointment or task on the field2 side of this custom relation link; empty when that record is of another type. """ activity2Id: OrderByEnum """ Id of the user on the field1 side of this custom relation link; empty when that record is of another type. """ client1Id: OrderByEnum """ Id of the user on the field2 side of this custom relation link; empty when that record is of another type. """ client2Id: OrderByEnum """ Id of the contact on the field1 side of this custom relation link; empty when that record is of another type. """ contact1Id: OrderByEnum """ Id of the contact on the field2 side of this custom relation link; empty when that record is of another type. """ contact2Id: OrderByEnum """ Id of the custom entity record on the field1 side of this custom relation link; empty when that record is of another type. """ customEntity1Id: OrderByEnum """ Id of the custom entity record on the field2 side of this custom relation link; empty when that record is of another type. """ customEntity2Id: OrderByEnum """Id of the custom relation this link belongs to.""" customEntityRelationId: OrderByEnum """ True when the linked record is the primary one among the records linked through the same lookup field; used when the custom relation has hasIsPrimary enabled. """ isPrimary: OrderByEnum """ Id of the lead or opportunity on the field1 side of this custom relation link; empty when that record is of another type. """ leadOppty1Id: OrderByEnum """ Id of the lead or opportunity on the field2 side of this custom relation link; empty when that record is of another type. """ leadOppty2Id: OrderByEnum """ Id of the opportunity product line on the field1 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation1Id: OrderByEnum """ Id of the opportunity product line on the field2 side of this custom relation link; empty when that record is of another type. """ opptyProductRelation2Id: OrderByEnum """ Id of the product on the field1 side of this custom relation link; empty when that record is of another type. """ product1Id: OrderByEnum """ Id of the product on the field2 side of this custom relation link; empty when that record is of another type. """ product2Id: OrderByEnum """ Id of the project on the field1 side of this custom relation link; empty when that record is of another type. """ project1Id: OrderByEnum """ Id of the project on the field2 side of this custom relation link; empty when that record is of another type. """ project2Id: OrderByEnum """ Id of the quote on the field1 side of this custom relation link; empty when that record is of another type. """ quote1Id: OrderByEnum """ Id of the quote on the field2 side of this custom relation link; empty when that record is of another type. """ quote2Id: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related CustomEntityRelation record. Set exactly one field in each item. """ input CustomEntityRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the lookup field on the first side of the custom relation.""" field1Id: OrderByEnum """Id of the lookup field on the second side of the custom relation.""" field2Id: OrderByEnum """ When true, one of the records linked through the relation can be marked as primary. Cannot be switched back to false once enabled. """ hasIsPrimary: OrderByEnum """ When true, field2 offers only records related to the record being edited. Not supported yet; must be false. """ showRelated1: OrderByEnum """ When true, field1 offers only records related to the record being edited (e.g. the contacts of its account). """ showRelated2: OrderByEnum """ When true, the records linked through field1 are shown in a tab named tabName1. """ showTab1: OrderByEnum """ When true, the records linked through field2 are shown in a tab named tabName2. """ showTab2: OrderByEnum """Name of the tab that shows the records linked through field1.""" tabName1: OrderByEnum """Name of the tab that shows the records linked through field2.""" tabName2: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of CustomEntityRelationData records.""" type CustomEntityRelationDataEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CustomEntityRelationDataEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `CustomEntityRelationDataEntity` and its cursor. """ type CustomEntityRelationDataEntityEdge { """The item at the end of the edge""" node: CustomEntityRelationDataEntity """A cursor for use in pagination""" cursor: String! } """Read operations for CustomEntitySharingClientRelation records.""" type CustomEntitySharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CustomEntitySharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CustomEntitySharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntitySharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntitySharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntitySharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CustomEntitySharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntitySharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntitySharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of CustomEntitySharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CustomEntitySharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the custom entity record is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Custom entity record being shared. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the shared custom entity record.""" customEntityId: OrderByEnum """ Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for CustomEntitySharingSalesUnitRelation records.""" type CustomEntitySharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CustomEntitySharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CustomEntitySharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntitySharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntitySharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntitySharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CustomEntitySharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [CustomEntitySharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntitySharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of CustomEntitySharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CustomEntitySharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Custom entity record being shared. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Sales unit the custom entity record is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared custom entity record.""" customEntityId: OrderByEnum """ Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for CustomEntityType records.""" type CustomEntityTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): CustomEntityTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [CustomEntityTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntityTypeFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntityTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: CustomEntityTypeFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): CustomEntityTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: CustomEntityTypeFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [CustomEntityTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: CustomEntityTypeFilterInput """Sorting of the returned records.""" orderBy: [CustomEntityTypeOrderByInput!] ): [CustomEntityTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): CustomEntityTypeEntity! } """ Sorting of CustomEntityType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input CustomEntityTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the custom entity type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum } """Paginated list of CustomEntityType records.""" type CustomEntityTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [CustomEntityTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `CustomEntityTypeEntity` and its cursor.""" type CustomEntityTypeEntityEdge { """The item at the end of the edge""" node: CustomEntityTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Data records.""" type DataRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): DataEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [DataEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: DataFilterInput """Sorting of the returned records.""" orderBy: [DataOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [DataEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: DataFilterInput """Sorting of the returned records.""" orderBy: [DataOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): DataEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: DataFilterInput """Sorting of the returned records.""" orderBy: [DataOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [DataEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: DataFilterInput """Sorting of the returned records.""" orderBy: [DataOrderByInput!] ): [DataEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): DataEntity! } """ Sorting of Data records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input DataOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option). """ calcValue: OrderByEnum """Name of the entity and its default text representation.""" optionName: OrderByEnum """Position of the option within its data set; lower values appear first.""" sortOrder: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Data records.""" type DataEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [DataEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `DataEntity` and its cursor.""" type DataEntityEdge { """The item at the end of the edge""" node: DataEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Email records.""" type EmailRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailFilterInput """Sorting of the returned records.""" orderBy: [EmailOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailFilterInput """Sorting of the returned records.""" orderBy: [EmailOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the recipients from the given list who have unsubscribed from emails, so they can be removed before sending. """ checkForUnsubscribed( """ Recipients to check, identified by address or by linked account/contact. """ recipients: [SendEmailRecipientParams!]! ): [SendEmailRecipient!]! """ Returns the saved draft replying to the given email in the given mailbox, or null when there is none. """ getDraftByParentAndMailbox( """Id of the email the draft replies to.""" parentId: UUID! """Id of the mailbox the draft belongs to.""" mailboxId: UUID! ): EmailEntity """ Returns the records (accounts, contacts, opportunities, projects, quotes, custom entities) linked to the email's conversation thread. """ getLinkedItems( """Id of the email.""" emailId: UUID! """When set, only emails of the thread in this mailbox are considered.""" mailboxId: UUID ): [EmailLinkedItem!]! } """ Sorting of Email records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Configured company email used as the From / Reply-To. Empty when sent from the user mailbox. Sorts by fields of the related record, listed in order of priority. """ companyEmail: [CompanyEmailOrderByNestedInput!] """ The original email a draft was started from (reply/forward source), or empty for a standalone draft. Sorts by fields of the related record, listed in order of priority. """ draftParentEmail: [EmailOrderByNestedInput!] """ Sales user who owns this email. May be empty for unassigned emails. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ For mass emails: the master email this copy was generated from. Empty for the master and for non-mass emails. Sorts by fields of the related record, listed in order of priority. """ parentEmail: [EmailOrderByNestedInput!] """ Account record matched as the sender, or empty when the sender does not match an existing Account. Sorts by fields of the related record, listed in order of priority. """ senderAccount: [AccountOrderByNestedInput!] """ Internal user matched as the sender, or empty when the sender is external. Sorts by fields of the related record, listed in order of priority. """ senderClient: [ClientOrderByNestedInput!] """ Contact record matched as the sender, or empty when the sender does not match an existing Contact. Sorts by fields of the related record, listed in order of priority. """ senderContact: [ContactOrderByNestedInput!] """ Email template used to compose this email, or empty when none was used. Sorts by fields of the related record, listed in order of priority. """ template: [EmailTemplateOrderByNestedInput!] """Comma-separated list of blind-carbon-copy recipients.""" bcc: OrderByEnum """ Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. """ bodySummary: OrderByEnum """Comma-separated list of carbon-copy recipients.""" cc: OrderByEnum """ Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmailId: OrderByEnum """ How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). """ contentShareMode: OrderByEnum """MIME content type of the body (e.g. text/html, text/plain).""" contentType: OrderByEnum """ Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. """ dateSent: OrderByEnum """Direction of the email (Incoming, Outgoing).""" direction: OrderByEnum """ Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmailId: OrderByEnum """ Numeric error code recorded when the email failed to send. Zero when no error occurred. """ errorCode: OrderByEnum """ True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. """ isDraft: OrderByEnum """ True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. """ isTracked: OrderByEnum """Id of the email owner.""" ownerId: OrderByEnum """Id of the parent (master) email.""" parentEmailId: OrderByEnum """ Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. """ sendAt: OrderByEnum """Sender address as it appeared on the email (free-text "From" header).""" sender: OrderByEnum """Id of the matched sender account.""" senderAccountId: OrderByEnum """Id of the matched sender user.""" senderClientId: OrderByEnum """Id of the matched sender contact.""" senderContactId: OrderByEnum """ Tone of the email (Negative, Neutral or Positive) as assessed by AI from its content; empty until assessed. Returned only to users with read permission on the email content. """ sentiment: OrderByEnum """ Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: OrderByEnum """Name of the entity and its default text representation.""" subject: OrderByEnum """Id of the email template.""" templateId: OrderByEnum """Comma-separated list of primary recipients.""" to: OrderByEnum """ Whether the email is an individual email (Standard) or part of a mass email (Mass). """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Email records.""" type EmailEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EmailEntity` and its cursor.""" type EmailEntityEdge { """The item at the end of the edge""" node: EmailEntity """A cursor for use in pagination""" cursor: String! } """ Recipient of an email: the address and the records it represents, which the sent email is linked to and whose data fill its placeholders. """ input SendEmailRecipientParams { """ Which linked record (e.g. Contact or Account) this recipient primarily represents, used when linking the sent email to a record. """ primary: EntityLacotaType """ Opportunity this recipient is associated with, when sending in the context of an opportunity. """ opportunityId: UUID """Contact this recipient corresponds to, when known.""" contactId: UUID """Account this recipient corresponds to, when known.""" accountId: UUID """ Lead this recipient is associated with, when sending in the context of a lead. """ leadId: UUID """ Project this recipient is associated with, when sending in the context of a project. """ projectId: UUID """ Quote this recipient is associated with, when sending in the context of a quote. """ quoteId: UUID """ Custom entity records this recipient is associated with, each given as a `CustomEntityID`. """ customEntityIds: [CustomEntityIDParams] """Email address the message is sent to.""" address: String! } """ Reference to a custom entity record: the API name of its custom entity and its id. """ input CustomEntityIDParams { """API name of the custom entity type the referenced record belongs to.""" entityApiName: String! """Identifier of the referenced custom entity record.""" id: UUID! } """ Record an email is linked to, such as an account, contact, opportunity or project. """ type EmailLinkedItem { """Id of the linked record.""" id: ID! """Name of the linked record; empty when `isAvailable` is false.""" name: String """Type of the linked record.""" entityType: EntityNameEnum! """API name of the custom entity when the record is a custom entity.""" entityApiName: String """False when the caller cannot see the linked record.""" isAvailable: Boolean! """True when the linked record has been deleted.""" isDeleted: Boolean! """ False for an account or contact linked to a mass email or to one of its individual emails; such a link cannot be removed. """ isEditable: Boolean! } """Read operations for EmailContentSharingClientRelation records.""" type EmailContentSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailContentSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailContentSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailContentSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailContentSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailContentSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailContentSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailContentSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailContentSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of EmailContentSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailContentSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User granted access to the email body. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Email whose body is being shared. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the email whose body is shared with the user.""" emailId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for EmailContentSharingSalesUnitRelation records.""" type EmailContentSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailContentSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailContentSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailContentSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailContentSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailContentSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailContentSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailContentSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailContentSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of EmailContentSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailContentSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Email whose body is being shared. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Sales unit granted access to the email body. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the email whose body is shared with the sales unit.""" emailId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for EmailEvent records.""" type EmailEventRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailEventEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailEventEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailEventFilterInput """Sorting of the returned records.""" orderBy: [EmailEventOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailEventEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailEventFilterInput """Sorting of the returned records.""" orderBy: [EmailEventOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailEventEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Tracking event reported for a sent email, such as an open, a link click, a reply or an unsubscribe. """ type EmailEventEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Email message the event was reported for.""" email: EmailEntity """ Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. """ additionalData: JSONString """Id of the email message.""" emailId: ID! """ Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce. """ type: EmailEventTypeEnum """ URL the recipient interacted with. Set for click events; empty for other event types. """ url: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Type of a tracked event on a sent email.""" enum EmailEventTypeEnum { """The recipient opened the email.""" Open """The recipient clicked a link in the email.""" Click """The recipient unsubscribed through the email.""" Unsubscribe """The email bounced permanently (hard bounce).""" Bounce """The recipient replied to the email.""" Reply """Delivery failed temporarily or was delayed (soft bounce).""" BounceSoft } """ Filter conditions for EmailEvent records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailEventFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailEventFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailEventFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailEventFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the email message.""" emailId: EntityFilterStringField """ Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce. """ type: EmailEventTypeEnumFilterInput """ URL the recipient interacted with. Set for click events; empty for other event types. """ url: EntityFilterStringField """ Email message the event was reported for. Matches records where a related record meets these conditions. """ email: EmailFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailEventTypeEnumFilterInput { """Matches any of the listed values.""" eq: [EmailEventTypeEnum!] """Matches values that do not meet this condition.""" NOT: EmailEventTypeEnumFilterInput } """ Sorting of EmailEvent records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailEventOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Email message the event was reported for. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """Id of the email message.""" emailId: OrderByEnum """ Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce. """ type: OrderByEnum """ URL the recipient interacted with. Set for click events; empty for other event types. """ url: OrderByEnum } """Read operations for EmailLabel records.""" type EmailLabelRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailLabelEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailLabelEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailLabelFilterInput """Sorting of the returned records.""" orderBy: [EmailLabelOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailLabelEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailLabelFilterInput """Sorting of the returned records.""" orderBy: [EmailLabelOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailLabelEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Filter conditions for EmailLabel records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailLabelFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailLabelFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailLabelFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailLabelFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Color the label is displayed with, as a packed RGB integer.""" color: EntityFilterNumberField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the client who created this label.""" ownerId: EntityFilterStringField """ Id of the parent label this one is nested under, or empty for a top-level label. """ parentEmailLabelId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Client who created this label; labels are personal and not shared with teammates. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Parent label this one is nested under, or empty for a top-level label. Matches records where a related record meets these conditions. """ parentEmailLabel: EmailLabelFilterInput } """ Sorting of EmailLabel records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailLabelOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Client who created this label; labels are personal and not shared with teammates. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Parent label this one is nested under, or empty for a top-level label. Sorts by fields of the related record, listed in order of priority. """ parentEmailLabel: [EmailLabelOrderByNestedInput!] """Color the label is displayed with, as a packed RGB integer.""" color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the client who created this label.""" ownerId: OrderByEnum """ Id of the parent label this one is nested under, or empty for a top-level label. """ parentEmailLabelId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related EmailLabel record. Set exactly one field in each item. """ input EmailLabelOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Color the label is displayed with, as a packed RGB integer.""" color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the client who created this label.""" ownerId: OrderByEnum """ Id of the parent label this one is nested under, or empty for a top-level label. """ parentEmailLabelId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of EmailLabel records.""" type EmailLabelEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailLabelEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EmailLabelEntity` and its cursor.""" type EmailLabelEntityEdge { """The item at the end of the edge""" node: EmailLabelEntity """A cursor for use in pagination""" cursor: String! } """Read operations for EmailLabelRelation records.""" type EmailLabelRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailLabelRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailLabelRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailLabelRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailLabelRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailLabelRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailLabelRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailLabelRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailLabelRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Filter conditions for EmailLabelRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailLabelRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailLabelRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailLabelRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailLabelRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the applied label.""" emailLabelId: EntityFilterStringField """ Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes. """ mailboxId: EntityFilterStringField """Id of the relation owner.""" ownerId: EntityFilterStringField """ Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label. """ threadId: EntityFilterStringField """ Label applied to the thread by this relation. Matches records where a related record meets these conditions. """ emailLabel: EmailLabelFilterInput """ Sales user who owns this relation. Derived from the label's owner on write. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Sorting of EmailLabelRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailLabelRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Label applied to the thread by this relation. Sorts by fields of the related record, listed in order of priority. """ emailLabel: [EmailLabelOrderByNestedInput!] """ Sales user who owns this relation. Derived from the label's owner on write. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Id of the applied label.""" emailLabelId: OrderByEnum """Id of the relation owner.""" ownerId: OrderByEnum } """Read operations for EmailMailboxRelation records.""" type EmailMailboxRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailMailboxRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailMailboxRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailMailboxRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailMailboxRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailMailboxRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailMailboxRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailMailboxRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailMailboxRelationEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Link between an email and a mailbox the email belongs to.""" type EmailMailboxRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Email that belongs to the mailbox.""" email: EmailEntity """ Direction of the email relative to this mailbox: outgoing for the mailbox that sent it, incoming for a mailbox that received it. The same email can therefore be outgoing in one mailbox and incoming in another. Defaults to the email direction when not set. """ direction: EmailDirectionEnum """Creation time.""" emailCreated: DateTime """Id of the email that belongs to the mailbox.""" emailId: ID! """ True when the related email has been deleted from this mailbox; such links are hidden from the inbox view. """ emailIsDeleted: Boolean """ Error code for the email in this mailbox; 0 means the email was processed without error. """ errorCode: Int """ Tracking events recorded so far for the related email (opens, clicks, replies, bounces, unsubscribes); several can be combined. Read-only; kept in sync with the email's EmailEvent records. """ eventTypes: EmailEventTypeFlagEnum """ Copy of the related email's draft flag; true when the email is an unsent draft, which shows it in the mailbox Drafts. """ isDraft: Boolean """ Whether the email is scheduled to be sent at a future time and has not been sent yet. """ isScheduled: Boolean """ Ids of the labels applied to this conversation in this mailbox. Read-only copy of the EmailLabelRelation records; manage labels via that entity rather than writing here. """ labelIds: JSONString """Id of the mailbox (connected email account) the email belongs to.""" mailboxId: ID! """ Time when the email was sent, or its scheduled send time if it has not been sent yet. """ sentOrScheduledAt: DateTime """ Id of the email thread, or the id of the email itself when it does not belong to a thread. """ threadOrId: ID """ Copy of the related email's type: an individual email or part of a mass email. Read-only; kept in sync with the email. """ type: EmailTypeEnum """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Set of tracked events recorded for an email in a mailbox; several flags can be combined. """ enum EmailEventTypeFlagEnum { """The recipient opened the email.""" Open """The recipient clicked a link in the email.""" Click """The recipient unsubscribed through the email.""" Unsubscribe """The email bounced permanently (hard bounce).""" Bounce """The recipient replied to the email.""" Reply """Delivery failed temporarily or was delayed (soft bounce).""" BounceSoft } """ Filter conditions for EmailMailboxRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailMailboxRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailMailboxRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailMailboxRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailMailboxRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Direction of the email relative to this mailbox: outgoing for the mailbox that sent it, incoming for a mailbox that received it. The same email can therefore be outgoing in one mailbox and incoming in another. Defaults to the email direction when not set. """ direction: EmailDirectionEnumFilterInput """Creation time.""" emailCreated: EntityFilterDateTimeField """Id of the email that belongs to the mailbox.""" emailId: EntityFilterStringField """ True when the related email has been deleted from this mailbox; such links are hidden from the inbox view. """ emailIsDeleted: Boolean """ Error code for the email in this mailbox; 0 means the email was processed without error. """ errorCode: EntityFilterNumberField """ Tracking events recorded so far for the related email (opens, clicks, replies, bounces, unsubscribes); several can be combined. Read-only; kept in sync with the email's EmailEvent records. """ eventTypes: EmailEventTypeFlagEnumFilterInput """ Copy of the related email's draft flag; true when the email is an unsent draft, which shows it in the mailbox Drafts. """ isDraft: Boolean """ Whether the email is scheduled to be sent at a future time and has not been sent yet. """ isScheduled: Boolean """Id of the mailbox (connected email account) the email belongs to.""" mailboxId: EntityFilterStringField """ Time when the email was sent, or its scheduled send time if it has not been sent yet. """ sentOrScheduledAt: EntityFilterDateTimeField """ Id of the email thread, or the id of the email itself when it does not belong to a thread. """ threadOrId: EntityFilterStringField """ Copy of the related email's type: an individual email or part of a mass email. Read-only; kept in sync with the email. """ type: EmailTypeEnumFilterInput """ Email that belongs to the mailbox. Matches records where a related record meets these conditions. """ email: EmailFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EmailEventTypeFlagEnumFilterInput { """Matches any of the listed values.""" eq: [EmailEventTypeFlagEnum!] """Matches values that do not meet this condition.""" NOT: EmailEventTypeFlagEnumFilterInput } """ Sorting of EmailMailboxRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailMailboxRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Email that belongs to the mailbox. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Direction of the email relative to this mailbox: outgoing for the mailbox that sent it, incoming for a mailbox that received it. The same email can therefore be outgoing in one mailbox and incoming in another. Defaults to the email direction when not set. """ direction: OrderByEnum """Creation time.""" emailCreated: OrderByEnum """Id of the email that belongs to the mailbox.""" emailId: OrderByEnum """ Error code for the email in this mailbox; 0 means the email was processed without error. """ errorCode: OrderByEnum """ Copy of the related email's draft flag; true when the email is an unsent draft, which shows it in the mailbox Drafts. """ isDraft: OrderByEnum """ Whether the email is scheduled to be sent at a future time and has not been sent yet. """ isScheduled: OrderByEnum """ Time when the email was sent, or its scheduled send time if it has not been sent yet. """ sentOrScheduledAt: OrderByEnum """ Copy of the related email's type: an individual email or part of a mass email. Read-only; kept in sync with the email. """ type: OrderByEnum } """Read operations for EmailSequence records.""" type EmailSequenceRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailSequenceEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailSequenceEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailSequenceFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailSequenceEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailSequenceFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of email sequences filtered by owner, enabled state and status, in addition to the regular filter. """ getByEmailSequenceCriteria( """Owner, active/inactive and status filters applied to the list.""" listingOptions: EmailSequenceTabDataGridViewOptionsParams! """Conditions the returned records must meet.""" filter: EmailSequenceFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceOrderByInput!] """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceEntityConnection """ Returns the email sequences in which any of the selected records is currently enrolled, so they can be offered for unenrollment. """ getEmailSequencesForUnenroll( """Selection of records: explicit ids, a list result, and ids to exclude.""" bulkFilter: BulkOperationInput! ): [EmailSequenceEntity!]! } """ Sorting of EmailSequence records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailSequenceOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns this email sequence. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Reason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only. """ deactivationReason: OrderByEnum """Free-form description of the sequence.""" description: OrderByEnum """ Master switch for the sequence. Read-only on this surface — change it via the enable / disable mutations. """ isEnabled: OrderByEnum """Timestamp of the most recent change to settings. Read-only.""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled. Read-only.""" lastStatusChange: OrderByEnum """Display name of the email sequence.""" name: OrderByEnum """Id of the email sequence owner.""" ownerId: OrderByEnum """ Process category of the sequence (e.g. EmailSequence vs other process types). """ type: OrderByEnum """ Effective status of the sequence (e.g. Scheduled, Running, Expired, Error). Read-only; derived from the active-from / active-to settings and the most recent activity log status. """ status: OrderByEnum """ Timestamp the sequence last produced a run (delivered or attempted a step). """ lastEmailSequenceRun: OrderByEnum """ Fraction of delivered emails (0–1) where at least one tracked link was clicked. """ clickRate: OrderByEnum """ Fraction of sent emails (0–1) that bounced (the recipient mailserver rejected them). """ bounceRate: OrderByEnum """ Fraction of delivered emails (0–1) that recorded at least one open event. """ openRate: OrderByEnum """Fraction of delivered emails (0–1) where the recipient replied.""" replyRate: OrderByEnum """Fraction of delivered emails (0–1) where the recipient unsubscribed.""" unsubscribeRate: OrderByEnum """ Total number of emails produced (queued) by the sequence across all steps. """ createdCount: OrderByEnum """ Total number of emails actually delivered by the sequence across all steps. """ sentCount: OrderByEnum """ Number of records (Accounts/Contacts/Leads/Opportunities) currently enrolled in this sequence. """ enrollCount: OrderByEnum """ Names of the solutions whose canvas contains this sequence, in name order. Empty when the sequence is on no solution canvas. """ solutions: OrderByEnum """ Entity name whose records trigger automatic enrollment into this sequence (e.g. "Lead", "Contact"). Empty when the sequence is manually enrolled only. """ triggerEntityName: OrderByEnum """ Id of the field on the trigger entity whose value change drives enrollment (e.g. a step field on a Lead). Empty when no field-based trigger is configured. """ triggerFieldId: OrderByEnum """Number of steps configured in the sequence.""" stepCount: OrderByEnum } """Paginated list of EmailSequence records.""" type EmailSequenceEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailSequenceEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EmailSequenceEntity` and its cursor.""" type EmailSequenceEntityEdge { """The item at the end of the edge""" node: EmailSequenceEntity """A cursor for use in pagination""" cursor: String! } """ Options that narrow a list of email sequences by owner, active state, status and tags. """ input EmailSequenceTabDataGridViewOptionsParams { """ Ids of the owners whose records are listed; null or an empty list turns the owner filter off. """ filterByOwnerId: [ID!] """ When true, the list includes active records. When both showActive and showInactive are false, the list is not filtered by state. """ showActive: Boolean! = true """When true, the list includes inactive records; see showActive.""" showInactive: Boolean! = true """ Statuses to include, such as Ok, Warning or Error; null or an empty list turns the status filter off. Ignored when both showActive and showInactive are false. """ filterByStatus: [ProcessStatusEnum!] """ Ids of tags; only records with at least one of them are listed. Null or an empty list turns the tag filter off. Only processes can be tagged, so for approval processes and email sequences any tag id returns an empty list. """ filterByTagIds: [ID!] } """ Records a bulk operation works on: the records of sessionId plus includedIds, minus excludedIds. """ input BulkOperationInput { """ Ids left out of the selection, even when listed in includedIds or sessionId. """ excludedIds: [UUID] """Ids of the records to process.""" includedIds: [UUID] """ Id of an open list view whose records are added to the selection. Integrations can leave it empty. """ sessionId: String } """Read operations for EmailSequenceActivityLog records.""" type EmailSequenceActivityLogRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailSequenceActivityLogEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailSequenceActivityLogEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailSequenceActivityLogFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceActivityLogOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailSequenceActivityLogEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailSequenceActivityLogFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceActivityLogOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceActivityLogEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Exports the activity log of an email sequence to a zipped text file and returns a URL to download it. """ getDownloadUrl( """Id of the email sequence.""" emailSequenceId: UUID! """Name of the export, used for the file name.""" name: String! """Conditions the exported log entries must meet.""" filter: EmailSequenceActivityLogFilterInput """When set, only runs started in the last N days are exported.""" days: Int ): String! } """Read operations for EmailSequenceActivityLogLine records.""" type EmailSequenceActivityLogLineRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailSequenceActivityLogLineEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailSequenceActivityLogLineEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailSequenceActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailSequenceActivityLogLineEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailSequenceActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceActivityLogLineEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for EmailSequenceEnrolled records.""" type EmailSequenceEnrolledRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailSequenceEnrolledEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailSequenceEnrolledEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailSequenceEnrolledFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceEnrolledOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailSequenceEnrolledEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailSequenceEnrolledFilterInput """Sorting of the returned records.""" orderBy: [EmailSequenceEnrolledOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailSequenceEnrolledEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the email sequence enrollments of a record, one per sequence, with the most recently updated first. When the record was enrolled in a sequence more than once, the active enrollment is preferred, otherwise the latest one. """ getEnrolledEmailSequences( """Id of the enrolled record.""" entityId: UUID! """Maximum number of records to return.""" limit: Int ): [EmailSequenceEnrolledEntity!]! } """Read operations for EmailTemplate records.""" type EmailTemplateRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailTemplateEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailTemplateEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailTemplateFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailTemplateEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailTemplateFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailTemplateEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Assigns properties of a living entity to a non-living template from its id. """ previewPersonifiedRecordsById( """Source template entity id to personify.""" entityId: ID! """ Records whose data fill the placeholders of the template, such as its contact, account or opportunity. """ personificationEntityData: [PersonificationEntityDataParams!]! ): EmailTemplatePersonificationResult! """ Assigns properties of a living entity to a non-living template from input object. """ previewPersonifiedRecords( """ Source template entity. It will not create this entity, just use its data to preview. """ entity: CreateEmailTemplateInput! """ Records whose data fill the placeholders of the template, such as its contact, account or opportunity. """ personificationEntityData: [PersonificationEntityDataParams!]! ): EmailTemplatePersonificationResult! """ Returns the processes that send the given email template, so the caller can see which processes a change to the template affects. """ getAffectedProcesses( """Id of the email template.""" entityId: UUID! """ Planned change to the template (save, delete or sharing). Currently ignored: every process that sends the template is returned for any operation. """ operation: AffectedProcessesOperationType! """ Planned new sharing of the template, when the change is a sharing change. Currently ignored. """ sharing: AffectedProcessesSharing ): [AffectedProcessesProcessOutput!]! """ Returns the email sequences that send the given email template, so the caller can see which sequences a change to the template affects. """ getAffectedEmailSequences( """Id of the email template.""" entityId: UUID! """ Planned change to the template (save, delete or sharing). Currently ignored: every email sequence that sends the template is returned for any operation. """ operation: AffectedProcessesOperationType! """ Planned new sharing of the template, when the change is a sharing change. Currently ignored. """ sharing: AffectedProcessesSharing ): [AffectedProcessesProcessOutput!]! """ Returns an email template's content and attachments, with a status telling whether a process can still use it. The status is Deleted for a deleted template, and Unavailable when the caller cannot open the template but the given process uses it. """ getStatusInProcess( """Id of the email template.""" entityId: UUID! """Id of the process that uses the template.""" processId: UUID ): StatusInProcessOutput! """ Returns an email template's content and attachments, with a status telling whether an email sequence can still use it. The status is Deleted for a deleted template, and Unavailable when the caller cannot open the template but the given sequence uses it. """ getStatusInEmailSequence( """Id of the email template.""" entityId: UUID! """Id of the email sequence that uses the template.""" emailSequenceId: UUID ): StatusInProcessOutput! """ Converts an email template body built in the visual (WYSIWYG) editor from MJML markup into HTML ready to be sent. """ convertWysiwygTemplateToHtml( """Template body in MJML markup.""" body: String! ): String! } """ Sorting of EmailTemplate records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailTemplateOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Folder in the template hierarchy that the template belongs to. Empty for templates at the root level. Sorts by fields of the related record, listed in order of priority. """ emailTemplateFolder: [EmailTemplateFolderOrderByNestedInput!] """ User who owns the template. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Id of the folder the template belongs to. Empty for templates at the root level. """ emailTemplateFolderId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the template owner.""" ownerId: OrderByEnum """ Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). """ shareMode: OrderByEnum """ When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. """ sharingUrlIsEnabled: OrderByEnum """ Subject line of emails composed from this template. Supports merge-field placeholders. """ subject: OrderByEnum """ Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Names of the solutions whose canvas contains this template, in name order. Empty when the template is on no solution canvas. """ solutions: OrderByEnum } """ Sorting by a field of the related EmailTemplateFolder record. Set exactly one field in each item. """ input EmailTemplateFolderOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the parent folder in the template hierarchy. Empty for top-level folders. """ parentEmailTemplateFolderId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of EmailTemplate records.""" type EmailTemplateEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailTemplateEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EmailTemplateEntity` and its cursor.""" type EmailTemplateEntityEdge { """The item at the end of the edge""" node: EmailTemplateEntity """A cursor for use in pagination""" cursor: String! } """ Copies of the EmailTemplate with its placeholders filled from the given records, and the records and fields that could not be used. """ type EmailTemplatePersonificationResult { """Ids of requested records that could not be loaded.""" missingRecordsIds: [UUID!]! """ Ids of fields used in the template whose values the caller is not allowed to read. """ disallowedFieldsIds: [UUID!]! """ Ids of fields used in the template that do not exist or do not belong to any of the given records. """ missingFieldsIds: [UUID!]! """ Copies of the template with the placeholders filled, one for each requested set of records, in request order. """ results: [EmailTemplateEntity!]! } """ Records whose data fill the placeholders of an email or text message, such as its contact, account or opportunity. """ input PersonificationEntityDataParams { """ Which of the given records, such as the Contact or the Account, the message is primarily addressed to. """ primary: EntityLacotaType """Opportunity whose data fills the opportunity placeholders.""" opportunityId: UUID """Contact whose data fills the contact placeholders.""" contactId: UUID """Account whose data fills the account placeholders.""" accountId: UUID """Lead whose data fills the lead placeholders.""" leadId: UUID """Project whose data fills the project placeholders.""" projectId: UUID """Quote whose data fills the quote placeholders.""" quoteId: UUID """ Custom entity records whose data fill the custom entity placeholders, each given as a `CustomEntityID`. """ customEntityIds: [CustomEntityIDParams] } """Field values of a new EmailTemplate record.""" input CreateEmailTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. """ body: String """ Id of the folder the template belongs to. Empty for templates at the root level. """ emailTemplateFolderId: ID """Name of the entity and its default text representation.""" name: String! """Id of the template owner.""" ownerId: ID! """ Colors recently used in the editor of the template body, as integer color values. """ recentColors: [Int!] """ Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). """ shareMode: ShareModeEnum """ When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. """ sharingUrlIsEnabled: Boolean """ Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured. """ sharingUrlSettings: JSONString """ Subject line of emails composed from this template. Supports merge-field placeholders. """ subject: String! """ Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). """ type: EmailTemplateTypeEnum! """Revision when entity was lastly changed.""" revision: Int """ Sales units granted shared access to this template (custom share mode). """ sharingUnits: [CreateEmailTemplateSharingSalesUnitRelationNoEmailTemplateBackrefInput!] """Users granted shared access to this template (custom share mode).""" sharingClients: [CreateEmailTemplateSharingClientRelationNoEmailTemplateBackrefInput!] """Files attached to the template (used as default attachments).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """ Field values of a new EmailTemplateSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateEmailTemplateSharingSalesUnitRelationNoEmailTemplateBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new EmailTemplateSharingClientRelation record, created together with the record it belongs to. """ input CreateEmailTemplateSharingClientRelationNoEmailTemplateBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new CloudObjectRelation record, created together with the record it belongs to. """ input CreateCloudObjectRelationNoBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Cloud object (file) being linked.""" cloudObject: CreateCloudObjectInput """Id of the linked call.""" callId: ID """ Id of the folder within the parent record, or empty when stored at the record root. """ cloudObjectFolderId: ID """Id of the linked file.""" cloudObjectId: ID """Id of the linked media record.""" mediaId: ID """Id of the online form field the file was uploaded into.""" onlineFormFieldId: ID """Revision when entity was lastly changed.""" revision: Int } """Field values of a new CloudObject record.""" input CreateCloudObjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String! """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """Mime-type of the cloud object Is detected from content.""" mimeType: String """ Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. """ params: JSONString """ Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. """ type: CloudObjectTypeEnum! """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: String """Revision when entity was lastly changed.""" revision: Int """Data content of the object.""" content: Base64 } """Binary data encoded as a Base64 string.""" scalar Base64 """Process or email sequence that uses an email template.""" type AffectedProcessesProcessOutput { """Name of the process or email sequence.""" name: String! """Id of the process or email sequence that uses the template.""" id: UUID! } """ Planned change to an email template when listing the processes or email sequences that use it. """ enum AffectedProcessesOperationType { """The template content is being changed.""" save """The template is being deleted.""" delete """The template's sharing is being changed.""" sharing } """ Planned sharing of an email template, used to find the processes and email sequences that the change affects. """ input AffectedProcessesSharing { """Planned share mode of the email template.""" mode: ShareModeEnum! """Users the template is to be shared with, each with a sharing role.""" clients: [SharingRecord!] """ Sales units the template is to be shared with, each with a sharing role. """ units: [SharingRecord!] } """ User or sales unit an email template is to be shared with, and the sharing role it gets. """ input SharingRecord { """Id of the user or sales unit.""" id: UUID! """ Access the user or sales unit gets: Watcher (can view) or Editor (can view and edit). """ role: SharingRoleEnum! } """ Email template as used by a process or email sequence, with whether it can still use it. """ type StatusInProcessOutput { """Id of the email template.""" id: UUID! """Name of the email template.""" name: String! """Format of the email template.""" type: EmailTemplateTypeEnum! """ Whether the process or email sequence can still use the template: Ok, Deleted or Unavailable. """ status: TemplateStatusInProcess! """Files attached to the email template.""" documents: [CloudObjectEntity] """Subject of the email template.""" subject: String """Content of the email template.""" body: String } """ Whether an email template used by a process or email sequence can still be used. """ enum TemplateStatusInProcess { """ The template exists but the caller cannot open it; the given process or sequence still uses it. """ Unavailable """The template has been deleted.""" Deleted """The template is available.""" Ok } """Read operations for EmailTemplateFolder records.""" type EmailTemplateFolderRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailTemplateFolderEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailTemplateFolderEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailTemplateFolderFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateFolderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailTemplateFolderEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailTemplateFolderFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateFolderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailTemplateFolderEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of EmailTemplateFolder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailTemplateFolderOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Parent folder in the template hierarchy. Empty for top-level folders. Sorts by fields of the related record, listed in order of priority. """ parentEmailTemplateFolder: [EmailTemplateFolderOrderByNestedInput!] """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the parent folder in the template hierarchy. Empty for top-level folders. """ parentEmailTemplateFolderId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of EmailTemplateFolder records.""" type EmailTemplateFolderEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EmailTemplateFolderEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EmailTemplateFolderEntity` and its cursor.""" type EmailTemplateFolderEntityEdge { """The item at the end of the edge""" node: EmailTemplateFolderEntity """A cursor for use in pagination""" cursor: String! } """Read operations for EmailTemplateSharingClientRelation records.""" type EmailTemplateSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailTemplateSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailTemplateSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailTemplateSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailTemplateSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailTemplateSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailTemplateSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of EmailTemplateSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailTemplateSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the template is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Email template being shared. Sorts by fields of the related record, listed in order of priority. """ emailTemplate: [EmailTemplateOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the email template shared with the user.""" emailTemplateId: OrderByEnum """ Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for EmailTemplateSharingSalesUnitRelation records.""" type EmailTemplateSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailTemplateSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailTemplateSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailTemplateSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailTemplateSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailTemplateSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [EmailTemplateSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EmailTemplateSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of EmailTemplateSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailTemplateSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Email template being shared. Sorts by fields of the related record, listed in order of priority. """ emailTemplate: [EmailTemplateOrderByNestedInput!] """ Sales unit the template is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the email template shared with the sales unit.""" emailTemplateId: OrderByEnum """ Access the sharing gives the sales unit on the template: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for EmailThreadMailboxClientReadState records.""" type EmailThreadMailboxClientReadStateRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EmailThreadMailboxClientReadStateEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EmailThreadMailboxClientReadStateEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EmailThreadMailboxClientReadStateFilterInput """Sorting of the returned records.""" orderBy: [EmailThreadMailboxClientReadStateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailThreadMailboxClientReadStateEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EmailThreadMailboxClientReadStateFilterInput """Sorting of the returned records.""" orderBy: [EmailThreadMailboxClientReadStateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EmailThreadMailboxClientReadStateEntity!]! """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Time a user last read an email conversation in a mailbox, telling which conversations have unread emails. """ type EmailThreadMailboxClientReadStateEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User whose read state of the email thread is tracked.""" client: ClientEntity """Id of the user whose read state of the email thread is tracked.""" clientId: ID! """Time when the user last read the email thread in the mailbox.""" lastReadAt: DateTime """ Id of the mailbox (connected email account) the email thread belongs to. """ mailboxId: ID! """ Id of the email thread, or the id of the email itself when it does not belong to a thread. """ threadOrId: ID! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for EmailThreadMailboxClientReadState records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EmailThreadMailboxClientReadStateFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EmailThreadMailboxClientReadStateFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EmailThreadMailboxClientReadStateFilterInput!] """Matches records that do not meet this filter.""" NOT: EmailThreadMailboxClientReadStateFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user whose read state of the email thread is tracked.""" clientId: EntityFilterStringField """Time when the user last read the email thread in the mailbox.""" lastReadAt: EntityFilterDateTimeField """ Id of the mailbox (connected email account) the email thread belongs to. """ mailboxId: EntityFilterStringField """ Id of the email thread, or the id of the email itself when it does not belong to a thread. """ threadOrId: EntityFilterStringField """ User whose read state of the email thread is tracked. Matches records where a related record meets these conditions. """ client: ClientFilterInput } """ Sorting of EmailThreadMailboxClientReadState records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EmailThreadMailboxClientReadStateOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User whose read state of the email thread is tracked. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """Id of the user whose read state of the email thread is tracked.""" clientId: OrderByEnum } """Read operations for Entity records.""" type EntityRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EntityEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EntityEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EntityFilterInput """Sorting of the returned records.""" orderBy: [EntityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntityEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EntityFilterInput """Sorting of the returned records.""" orderBy: [EntityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EntityEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Kind of record in the space, such as Account, Lead or a custom entity, with its display names and behavior. """ type EntityEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """ Stable identifier of the entity (e.g. "Account", "Lead", "Opportunity"). """ entityName: String """Storage identifier of the entity. Read-only.""" tableName: String """Storage identifier of the entity's custom-field data. Read-only.""" tableEx: String """Storage identifier of the entity's option relation data. Read-only.""" tableDataEx: String """ Id of the field used as the default display label for records of this entity. """ defaultViewFieldId: ID! """ For sub-entities (e.g. Lead/Opportunity sharing a LeadOppty parent), the entity name of the parent abstract entity. Empty for stand-alone entities. """ abstractEntityId: ID! """ Kind of the entity in the platform: business entity, system schema, custom entity, etc. """ entityType: Int! """ Display order used to sort entities in pickers and navigation lists; lower values appear first. """ preferenceOrder: Int! """ True when records of this entity can be linked to multiple records of the same other entity through the same relation. """ allowsMultipleRelation: Boolean """ True when records of this entity support drafts (changes go through a draft before being published). """ hasDraft: Boolean! """ Access scope of records of this entity: shared across the entire space, scoped to a sales unit, or owner-only. """ accessMode: Int! """Numeric icon identifier used to render the entity in the UI.""" icon: Int! """ True when the entity is marked as deleted (soft-delete). Read-only at the entity-metadata level. """ isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Optional space-level configuration for the entity (e.g. UI/feature flags). Empty when no overrides are set. """ settings: JSONString """Display name of the entity in singular form (e.g. "Account").""" nameSingular: String """Display name of the entity in plural form (e.g. "Accounts").""" namePlural: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for Entity records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EntityFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EntityFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EntityFilterInput!] """Matches records that do not meet this filter.""" NOT: EntityFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """ Stable identifier of the entity (e.g. "Account", "Lead", "Opportunity"). """ entityName: EntityFilterStringField """Storage identifier of the entity. Read-only.""" tableName: EntityFilterStringField """Storage identifier of the entity's custom-field data. Read-only.""" tableEx: EntityFilterStringField """Storage identifier of the entity's option relation data. Read-only.""" tableDataEx: EntityFilterStringField """ Id of the field used as the default display label for records of this entity. """ defaultViewFieldId: EntityFilterStringField """ For sub-entities (e.g. Lead/Opportunity sharing a LeadOppty parent), the entity name of the parent abstract entity. Empty for stand-alone entities. """ abstractEntityId: EntityFilterStringField """ Kind of the entity in the platform: business entity, system schema, custom entity, etc. """ entityType: EntityFilterNumberField """ Display order used to sort entities in pickers and navigation lists; lower values appear first. """ preferenceOrder: EntityFilterNumberField """ True when records of this entity can be linked to multiple records of the same other entity through the same relation. """ allowsMultipleRelation: Boolean """ True when records of this entity support drafts (changes go through a draft before being published). """ hasDraft: Boolean """ Access scope of records of this entity: shared across the entire space, scoped to a sales unit, or owner-only. """ accessMode: EntityFilterNumberField """Numeric icon identifier used to render the entity in the UI.""" icon: EntityFilterNumberField """ True when the entity is marked as deleted (soft-delete). Read-only at the entity-metadata level. """ isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Display name of the entity in singular form (e.g. "Account").""" nameSingular: EntityFilterStringField """Display name of the entity in plural form (e.g. "Accounts").""" namePlural: EntityFilterStringField } """ Sorting of Entity records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EntityOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """ Stable identifier of the entity (e.g. "Account", "Lead", "Opportunity"). """ entityName: OrderByEnum """Storage identifier of the entity. Read-only.""" tableName: OrderByEnum """Storage identifier of the entity's custom-field data. Read-only.""" tableEx: OrderByEnum """Storage identifier of the entity's option relation data. Read-only.""" tableDataEx: OrderByEnum """ Id of the field used as the default display label for records of this entity. """ defaultViewFieldId: OrderByEnum """ For sub-entities (e.g. Lead/Opportunity sharing a LeadOppty parent), the entity name of the parent abstract entity. Empty for stand-alone entities. """ abstractEntityId: OrderByEnum """ Kind of the entity in the platform: business entity, system schema, custom entity, etc. """ entityType: OrderByEnum """ Display order used to sort entities in pickers and navigation lists; lower values appear first. """ preferenceOrder: OrderByEnum """ True when records of this entity can be linked to multiple records of the same other entity through the same relation. """ allowsMultipleRelation: OrderByEnum """ True when records of this entity support drafts (changes go through a draft before being published). """ hasDraft: OrderByEnum """ Access scope of records of this entity: shared across the entire space, scoped to a sales unit, or owner-only. """ accessMode: OrderByEnum """Numeric icon identifier used to render the entity in the UI.""" icon: OrderByEnum """ True when the entity is marked as deleted (soft-delete). Read-only at the entity-metadata level. """ isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Display name of the entity in singular form (e.g. "Account").""" nameSingular: OrderByEnum """Display name of the entity in plural form (e.g. "Accounts").""" namePlural: OrderByEnum } """Paginated list of Entity records.""" type EntityEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EntityEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EntityEntity` and its cursor.""" type EntityEntityEdge { """The item at the end of the edge""" node: EntityEntity """A cursor for use in pagination""" cursor: String! } """Read operations for EntityFitness records.""" type EntityFitnessRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EntityFitnessEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EntityFitnessEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EntityFitnessFilterInput """Sorting of the returned records.""" orderBy: [EntityFitnessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntityFitnessEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EntityFitnessFilterInput """Sorting of the returned records.""" orderBy: [EntityFitnessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EntityFitnessEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns the fitness configuration of a lead type or opportunity type.""" getByEntityType( """ Lead or Opportunity (or LeadType / OpportunityType); other values are rejected. """ entityType: EntityNameEnum! """Id of the lead type or opportunity type.""" entityTypeId: UUID! ): EntityFitnessEntity! } """ Sorting of EntityFitness records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EntityFitnessOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead type this fitness configuration applies to. Set when configuring fitness for leads. Sorts by fields of the related record, listed in order of priority. """ leadType: [LeadTypeOrderByNestedInput!] """ Opportunity type this fitness configuration applies to. Set when configuring fitness for opportunities. Sorts by fields of the related record, listed in order of priority. """ opptyType: [OpportunityTypeOrderByNestedInput!] """ Id of the lead type this fitness configuration applies to. Set when configuring fitness for leads. """ leadTypeId: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of EntityFitness records.""" type EntityFitnessEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EntityFitnessEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EntityFitnessEntity` and its cursor.""" type EntityFitnessEntityEdge { """The item at the end of the edge""" node: EntityFitnessEntity """A cursor for use in pagination""" cursor: String! } """Read operations for EntityFitnessIndicator records.""" type EntityFitnessIndicatorRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EntityFitnessIndicatorEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EntityFitnessIndicatorEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EntityFitnessIndicatorFilterInput """Sorting of the returned records.""" orderBy: [EntityFitnessIndicatorOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntityFitnessIndicatorEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EntityFitnessIndicatorFilterInput """Sorting of the returned records.""" orderBy: [EntityFitnessIndicatorOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EntityFitnessIndicatorEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for EntityHealth records.""" type EntityHealthRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EntityHealthEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EntityHealthEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EntityHealthFilterInput """Sorting of the returned records.""" orderBy: [EntityHealthOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntityHealthEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EntityHealthFilterInput """Sorting of the returned records.""" orderBy: [EntityHealthOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EntityHealthEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns the account health configuration for the given account type.""" getByTypeId( """Id of the account type.""" typeId: UUID! """ When true (default), an error is returned if the account type has no health configuration. """ strict: Boolean ): EntityHealthEntity! } """ Health configuration of an account type, defining when accounts of that type are healthy or in critical health. """ type EntityHealthEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account type this health configuration applies to.""" type: AccountTypeEntity """ Entity whose records the health configuration evaluates; currently always Account. Read-only. """ entityType: BaseEntityTypeEnum! """ When false, health is configured but not evaluated for records of this type. """ isEnabled: Boolean! """ Timestamp of the last full health recalculation across all matching records. """ lastRecalculation: DateTime """Id of the account type.""" typeId: ID! """Revision when entity was lastly changed.""" revision: Int """ Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry. This payload conforms to the `EntityHealthSettings` JSON Schema: GET /api/v100/rest/schemas/EntityHealthSettings.json on your region's API host """ settings: EntityHealthSettings! """ Progress of the in-flight health recalculation as a percentage (0-100). Null when no recalculation has been queued. """ calculationProgress: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for EntityHealth records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EntityHealthFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EntityHealthFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EntityHealthFilterInput!] """Matches records that do not meet this filter.""" NOT: EntityHealthFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Entity whose records the health configuration evaluates; currently always Account. Read-only. """ entityType: BaseEntityTypeEnumFilterInput """ When false, health is configured but not evaluated for records of this type. """ isEnabled: Boolean """ Timestamp of the last full health recalculation across all matching records. """ lastRecalculation: EntityFilterDateTimeField """Id of the account type.""" typeId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account type this health configuration applies to. Matches records where a related record meets these conditions. """ type: AccountTypeFilterInput } """ Sorting of EntityHealth records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EntityHealthOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account type this health configuration applies to. Sorts by fields of the related record, listed in order of priority. """ type: [AccountTypeOrderByNestedInput!] """ When false, health is configured but not evaluated for records of this type. """ isEnabled: OrderByEnum """ Timestamp of the last full health recalculation across all matching records. """ lastRecalculation: OrderByEnum """Id of the account type.""" typeId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of EntityHealth records.""" type EntityHealthEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EntityHealthEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EntityHealthEntity` and its cursor.""" type EntityHealthEntityEdge { """The item at the end of the edge""" node: EntityHealthEntity """A cursor for use in pagination""" cursor: String! } """Read operations for EntityScoring records.""" type EntityScoringRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EntityScoringEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EntityScoringEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EntityScoringFilterInput """Sorting of the returned records.""" orderBy: [EntityScoringOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntityScoringEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EntityScoringFilterInput """Sorting of the returned records.""" orderBy: [EntityScoringOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): EntityScoringEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the progress of the score recalculation for the given record type and when scores were last recalculated. Both values are null when no scoring is enabled for the type. """ getRecalculationStatus( """Record type the scoring applies to.""" entityType: BaseEntityTypeEnum! ): EntityScoringRecalculationStatus! """ Returns the scoring definitions for the given record type, in their configured order. """ getByEntityType( """Record type the scoring applies to.""" entityType: BaseEntityTypeEnum! ): [EntityScoringEntity!]! } """ Lead scoring configuration: rules that give leads a score, so that the most promising ones stand out. """ type EntityScoringEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Entity whose records the scoring configuration scores; currently only Lead is supported. Set on create and cannot be changed. """ entityType: BaseEntityTypeEnum! """ When false, the scoring configuration is defined but not evaluated for records. """ isEnabled: Boolean! """Name of the entity and its default text representation.""" name: String! """ Entity scoring definition in json format. This payload conforms to the `EntityScoringSettings` JSON Schema: GET /api/v100/rest/schemas/EntityScoringSettings.json on your region's API host """ settings: EntityScoringSettings! """ Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches. """ sortOrder: Int! """ When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for EntityScoring records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EntityScoringFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EntityScoringFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EntityScoringFilterInput!] """Matches records that do not meet this filter.""" NOT: EntityScoringFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Entity whose records the scoring configuration scores; currently only Lead is supported. Set on create and cannot be changed. """ entityType: BaseEntityTypeEnumFilterInput """ When false, the scoring configuration is defined but not evaluated for records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """ Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches. """ sortOrder: EntityFilterNumberField """ When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Sorting of EntityScoring records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EntityScoringOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ When false, the scoring configuration is defined but not evaluated for records. """ isEnabled: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches. """ sortOrder: OrderByEnum """ When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of EntityScoring records.""" type EntityScoringEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [EntityScoringEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `EntityScoringEntity` and its cursor.""" type EntityScoringEntityEdge { """The item at the end of the edge""" node: EntityScoringEntity """A cursor for use in pagination""" cursor: String! } """ Progress of the score recalculation of a record type, and when scores were last recalculated. """ type EntityScoringRecalculationStatus { """ When the scores were last recalculated; null when no scoring is enabled for the record type. """ lastRecalculation: DateTime """ Progress of the running recalculation in percent (0-100); null when nothing is queued. """ calculationProgress: Int } """Read operations for EntitySettings records.""" type EntitySettingsRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): EntitySettingsEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [EntitySettingsEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EntitySettingsFilterInput """Sorting of the returned records.""" orderBy: [EntitySettingsOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntitySettingsEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: EntitySettingsFilterInput """Sorting of the returned records.""" orderBy: [EntitySettingsOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntitySettingsEntity!]! """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: EntitySettingsFilterInput """Sorting of the returned records.""" orderBy: [EntitySettingsOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [EntitySettingsEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: EntitySettingsFilterInput """Sorting of the returned records.""" orderBy: [EntitySettingsOrderByInput!] ): [EntitySettingsEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): EntitySettingsEntity! """ Returns the settings of the given record type (e.g. list and detail layout options). """ getForEntity( """Record type.""" entity: EntityNameEnum! """API name of the custom entity; required when entity is CustomEntity.""" entityApiName: String ): EntitySettingsEntity } """ Space-wide settings of an entity, such as the default columns of its lists. """ type EntitySettingsEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users). """ defaultListColumns: EntitySettingsDefaultListColumns! """ For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them). """ entityApiName: String """ True when the settings are published; false while they exist only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name). """ entityName: EntityNameEnum! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Default column layout of the record list of an entity, optionally applied to existing users. """ type EntitySettingsDefaultListColumns { """ When true, publishing the settings resets the column layout of existing users to these defaults; the flag is then cleared. """ applyToExistingUsers: Boolean! """Default columns of the list, in display order.""" columns: [EntityListColumn!]! } """ Column of a record list: the field shown, its relative width and whether it is frozen. """ type EntityListColumn { """Id of the field shown in the column.""" fieldId: String! """Relative width of the column.""" width: Float! """ When true, the column is pinned to the left edge and stays visible while the list scrolls horizontally. """ frozen: Boolean! } """ Filter conditions for EntitySettings records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input EntitySettingsFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [EntitySettingsFilterInput!] """Matches records that meet all of the listed filters.""" AND: [EntitySettingsFilterInput!] """Matches records that do not meet this filter.""" NOT: EntitySettingsFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them). """ entityApiName: String """ True when the settings are published; false while they exist only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name). """ entityName: EntityNameEnum } """ Sorting of EntitySettings records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input EntitySettingsOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them). """ entityApiName: OrderByEnum """ True when the settings are published; false while they exist only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name). """ entityName: OrderByEnum } """Read operations for Field records.""" type FieldRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): FieldEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [FieldEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FieldFilterInput """Sorting of the returned records.""" orderBy: [FieldOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FieldEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: FieldFilterInput """Sorting of the returned records.""" orderBy: [FieldOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FieldEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FieldFilterInput """Sorting of the returned records.""" orderBy: [FieldOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FieldEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: FieldFilterInput """Sorting of the returned records.""" orderBy: [FieldOrderByInput!] ): [FieldEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): FieldEntity! } """ Sorting of Field records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input FieldOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """True when the field is marked as deleted (soft-delete).""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: 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. """ entityName: OrderByEnum """Immutable and generated name. This name is used for integrations.""" apiName: OrderByEnum """User friendly name for field.""" name: OrderByEnum """ When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown. """ useLang: OrderByEnum """ Storage column name for the field; used as the filter key in API queries. """ columnName: OrderByEnum """ Storage origin of the field: on the main entity record, on the custom-field data record, or computed. """ columnSource: OrderByEnum """ For relation-typed fields, identifier of the relation kind that connects this entity to the related entity. Empty for non-relation fields. """ relationId: OrderByEnum """ For relation-typed fields, the entity the field points to (e.g. Contact, Account). Empty for non-relation fields. """ relationWithEntityId: 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. """ sharedWithFieldId: OrderByEnum """ Whether the field is System (built-in, immutable), Protected (built-in, limited changes), or Custom (user-created). """ systemType: 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 """ typeId: 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. """ compositeFieldId: OrderByEnum """Optional custom data set id can be set.""" dataSetId: OrderByEnum """ For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. """ parentOptionsFieldId: OrderByEnum """Calculated formula used for fields which supports calculation.""" calcFormula: 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. """ defaultValue: OrderByEnum """ True when the field cannot be made optional (enforced by the platform). """ systemRequired: OrderByEnum """ True when the field configuration is published; false while the field exists only as an unpublished draft. """ isPublished: OrderByEnum """ True when the field cannot be made writable (enforced by the platform). """ systemReadonly: OrderByEnum """If this field is allowed in global search.""" useInGlobalSearch: OrderByEnum """ If true, then there will be an API validation if value of entity is unique. """ isUnique: OrderByEnum """ Deprecated - previously returned sequence pattern used for sequence type of field. """ sequencePattern: OrderByEnum } """Paginated list of Field records.""" type FieldEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [FieldEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `FieldEntity` and its cursor.""" type FieldEntityEdge { """The item at the end of the edge""" node: FieldEntity """A cursor for use in pagination""" cursor: String! } """Read operations for FieldMapping records.""" type FieldMappingRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): FieldMappingEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [FieldMappingEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FieldMappingFilterInput """Sorting of the returned records.""" orderBy: [FieldMappingOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FieldMappingEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: FieldMappingFilterInput """Sorting of the returned records.""" orderBy: [FieldMappingOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FieldMappingEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the field mappings whose source is the given record type, i.e. the mappings used to pre-fill records created from it. """ getForEntity( """Source record type.""" entity: EntityNameEnum! """API name of the custom entity; required when entity is CustomEntity.""" entityApiName: String ): [FieldMappingEntity!]! } """ Sorting of FieldMapping records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input FieldMappingOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the mapping is shipped by the platform and cannot be deleted by the user. """ isSystem: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of FieldMapping records.""" type FieldMappingEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [FieldMappingEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `FieldMappingEntity` and its cursor.""" type FieldMappingEntityEdge { """The item at the end of the edge""" node: FieldMappingEntity """A cursor for use in pagination""" cursor: String! } """Read operations for FieldPermission records.""" type FieldPermissionRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): FieldPermissionEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [FieldPermissionEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FieldPermissionFilterInput """Sorting of the returned records.""" orderBy: [FieldPermissionOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FieldPermissionEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: FieldPermissionFilterInput """Sorting of the returned records.""" orderBy: [FieldPermissionOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FieldPermissionEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FieldPermissionFilterInput """Sorting of the returned records.""" orderBy: [FieldPermissionOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FieldPermissionEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: FieldPermissionFilterInput """Sorting of the returned records.""" orderBy: [FieldPermissionOrderByInput!] ): [FieldPermissionEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): FieldPermissionEntity! } """ Filter conditions for FieldPermission records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input FieldPermissionFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [FieldPermissionFilterInput!] """Matches records that meet all of the listed filters.""" AND: [FieldPermissionFilterInput!] """Matches records that do not meet this filter.""" NOT: FieldPermissionFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the custom field.""" fieldId: EntityFilterStringField """Id of the user role.""" masterRightId: EntityFilterStringField """ Access the user role gets to the custom field: full access (view and edit), read-only, or hidden. """ permissionLevel: AccessLevelFieldEnumFilterInput """ True when the permission override is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Name of an entity, for example Account. Matches field permissions for fields of that entity. """ entityName: String """ Custom field this permission applies to. Matches records where a related record meets these conditions. """ field: FieldFilterInput """ User role granted (or restricted) on the field. Matches records where a related record meets these conditions. """ masterRight: MasterRightFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input AccessLevelFieldEnumFilterInput { """Matches any of the listed values.""" eq: [AccessLevelFieldEnum!] """Matches values that do not meet this condition.""" NOT: AccessLevelFieldEnumFilterInput } """ Sorting of FieldPermission records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input FieldPermissionOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Custom field this permission applies to. Sorts by fields of the related record, listed in order of priority. """ field: [FieldOrderByNestedInput!] """ User role granted (or restricted) on the field. Sorts by fields of the related record, listed in order of priority. """ masterRight: [MasterRightOrderByNestedInput!] """Id of the custom field.""" fieldId: OrderByEnum """Id of the user role.""" masterRightId: OrderByEnum """ Access the user role gets to the custom field: full access (view and edit), read-only, or hidden. """ permissionLevel: OrderByEnum """ True when the permission override is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of FieldPermission records.""" type FieldPermissionEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [FieldPermissionEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `FieldPermissionEntity` and its cursor.""" type FieldPermissionEntityEdge { """The item at the end of the edge""" node: FieldPermissionEntity """A cursor for use in pagination""" cursor: String! } """Read operations for FieldSequence records.""" type FieldSequenceRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): FieldSequenceEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [FieldSequenceEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FieldSequenceFilterInput """Sorting of the returned records.""" orderBy: [FieldSequenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FieldSequenceEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: FieldSequenceFilterInput """Sorting of the returned records.""" orderBy: [FieldSequenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FieldSequenceEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FieldSequenceFilterInput """Sorting of the returned records.""" orderBy: [FieldSequenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FieldSequenceEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: FieldSequenceFilterInput """Sorting of the returned records.""" orderBy: [FieldSequenceOrderByInput!] ): [FieldSequenceEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): FieldSequenceEntity! } """ Numbering pattern of an auto-number field, used to generate its values for records that match the filter of the sequence. """ type FieldSequenceEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Optional filter restricting which records this sequence applies to. Empty means the sequence applies to all records. """ filter: JSONString """ Pattern template used to generate auto-numbered values (e.g. "{prefix}{year}-{####}"). """ pattern: String! """ Identifier grouping all sequences (across entity types) that share the same auto-numbering pattern. """ sequenceSetId: ID! """ Position of this sequence within its sequence set; sequences are evaluated in this order, the first whose filter matches is used. """ sortOrder: Int """ True when the sequence is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for FieldSequence records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input FieldSequenceFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [FieldSequenceFilterInput!] """Matches records that meet all of the listed filters.""" AND: [FieldSequenceFilterInput!] """Matches records that do not meet this filter.""" NOT: FieldSequenceFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Pattern template used to generate auto-numbered values (e.g. "{prefix}{year}-{####}"). """ pattern: EntityFilterStringField """ Identifier grouping all sequences (across entity types) that share the same auto-numbering pattern. """ sequenceSetId: EntityFilterStringField """ Position of this sequence within its sequence set; sequences are evaluated in this order, the first whose filter matches is used. """ sortOrder: EntityFilterNumberField """ True when the sequence is published; false while it exists only as an unpublished draft. """ isPublished: Boolean } """ Sorting of FieldSequence records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input FieldSequenceOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Position of this sequence within its sequence set; sequences are evaluated in this order, the first whose filter matches is used. """ sortOrder: OrderByEnum """ True when the sequence is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum } """Paginated list of FieldSequence records.""" type FieldSequenceEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [FieldSequenceEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `FieldSequenceEntity` and its cursor.""" type FieldSequenceEntityEdge { """The item at the end of the edge""" node: FieldSequenceEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Forecast records.""" type ForecastRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ForecastEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ForecastEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ForecastFilterInput """Sorting of the returned records.""" orderBy: [ForecastOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ForecastEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ForecastFilterInput """Sorting of the returned records.""" orderBy: [ForecastOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ForecastEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users. """ type ForecastEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Field whose value is summed when computing forecast amounts (typically a currency field on Opportunity). """ field: FieldEntity """User who owns the forecast.""" owner: ClientEntity """Pipeline whose opportunities the forecast aggregates.""" pipeline: PipelineEntity """Free-text description shown alongside the forecast.""" description: String """Last date covered by the forecast period.""" endDate: Date! """Id of the aggregation field.""" fieldId: ID! """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """Id of the pipeline whose opportunities the forecast aggregates.""" pipelineId: ID! """ Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/b/#BetterForecastSchema This payload conforms to the `BetterForecastSchema` JSON Schema: GET /api/v100/rest/schemas/BetterForecastSchema.json on your region's API host """ settings: BetterForecastSchema! """ Who besides the owner can access the forecast. Updating it to AllEdit shares the forecast with the users and sales units it covers (see sharedClients and sharedUnits) and stores the mode as Standard. """ shareMode: ShareModeEnum """ Legacy additional sharing options; kept with the record but no longer applied. """ shareModeParams: Int """First date covered by the forecast period.""" startDate: Date! """ Order of forecast levels as a JSON array (e.g. ["Units", "Users"]). Each level adds a grouping dimension to the breakdown. """ type: JSONString! """Revision when entity was lastly changed.""" revision: Int """ For multi-level forecasts (a "type" path like Pipeline/Step/Owner), the last element of the path identifying the current breakdown axis. """ lastType: ForecastType! """Users granted shared access to this forecast (custom share mode).""" sharedClients: [ClientEntity!]! """ Sales units granted shared access to this forecast (custom share mode). """ sharedUnits: [SalesUnitEntity!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Goal value to reach within the selected period; when the period covers only part of the target or forecast period, only the matching months count. """ targetGoal( """Period to compute the goal for; the whole period when omitted.""" period: PeriodOptionParams ): Int! } """ Filter conditions for Forecast records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ForecastFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ForecastFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ForecastFilterInput!] """Matches records that do not meet this filter.""" NOT: ForecastFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-text description shown alongside the forecast.""" description: EntityFilterStringField """Id of the aggregation field.""" fieldId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """Id of the pipeline whose opportunities the forecast aggregates.""" pipelineId: EntityFilterStringField """ Who besides the owner can access the forecast. Updating it to AllEdit shares the forecast with the users and sales units it covers (see sharedClients and sharedUnits) and stores the mode as Standard. """ shareMode: ShareModeEnumFilterInput """ Legacy additional sharing options; kept with the record but no longer applied. """ shareModeParams: ShareModeParamsEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ For multi-level forecasts (a "type" path like Pipeline/Step/Owner), the last element of the path identifying the current breakdown axis. """ lastType: ForecastType """ Field whose value is summed when computing forecast amounts (typically a currency field on Opportunity). Matches records where a related record meets these conditions. """ field: FieldFilterInput """ User who owns the forecast. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Pipeline whose opportunities the forecast aggregates. Matches records where a related record meets these conditions. """ pipeline: PipelineFilterInput } """ Sorting of Forecast records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ForecastOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Field whose value is summed when computing forecast amounts (typically a currency field on Opportunity). Sorts by fields of the related record, listed in order of priority. """ field: [FieldOrderByNestedInput!] """ User who owns the forecast. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Pipeline whose opportunities the forecast aggregates. Sorts by fields of the related record, listed in order of priority. """ pipeline: [PipelineOrderByNestedInput!] """Free-text description shown alongside the forecast.""" description: OrderByEnum """Last date covered by the forecast period.""" endDate: OrderByEnum """Id of the aggregation field.""" fieldId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Id of the pipeline whose opportunities the forecast aggregates.""" pipelineId: OrderByEnum """ Who besides the owner can access the forecast. Updating it to AllEdit shares the forecast with the users and sales units it covers (see sharedClients and sharedUnits) and stores the mode as Standard. """ shareMode: OrderByEnum """First date covered by the forecast period.""" startDate: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ For multi-level forecasts (a "type" path like Pipeline/Step/Owner), the last element of the path identifying the current breakdown axis. """ lastType: OrderByEnum } """Paginated list of Forecast records.""" type ForecastEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ForecastEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ForecastEntity` and its cursor.""" type ForecastEntityEdge { """The item at the end of the edge""" node: ForecastEntity """A cursor for use in pagination""" cursor: String! } """Read operations for FormView records.""" type FormViewRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): FormViewEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [FormViewEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FormViewFilterInput """Sorting of the returned records.""" orderBy: [FormViewOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FormViewEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: FormViewFilterInput """Sorting of the returned records.""" orderBy: [FormViewOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FormViewEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Variant of the form of an account, contact, lead or opportunity type that hides or colors selected fields; owned by a user and can be shared. """ type FormViewEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Account type the form view applies to. Set when the form view targets accounts. """ accountType: AccountTypeEntity """ Contact type the form view applies to. Set when the form view targets contacts. """ contactType: ContactTypeEntity """ Lead type the form view applies to. Set when the form view targets leads. """ leadType: LeadTypeEntity """ Opportunity type the form view applies to. Set when the form view targets opportunities. """ opptyType: OpportunityTypeEntity """User who owns the form view.""" owner: ClientEntity """ Id of the account type the form view applies to. Set when the form view targets accounts. """ accountTypeId: ID """ Id of the contact type the form view applies to. Set when the form view targets contacts. """ contactTypeId: ID """Ids of fields and webresources hidden from the form for this view.""" hiddenItemIds: [UUID!]! """ Per-item color overrides for fields and webresources in the form, keyed by item id. """ itemColors: [FormViewItemColor!]! """ Id of the lead type the form view applies to. Set when the form view targets leads. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String! """Id of the opportunity type.""" opptyTypeId: ID """Id of the owning user.""" ownerId: ID! """ 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). """ shareMode: ShareModeEnum """ When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Id of the type the form view is configured for, derived from whichever of the per-entity-type relations is set. """ entityTypeId: UUID! """ Sales units that have been granted shared access to this form view (custom share mode). """ sharingUnits( """Filter SalesUnit relations by target SalesUnit attributes.""" filter: SalesUnitFilterInput """ Filter FormViewSharingSalesUnitRelation relations by edge (relation) FormViewSharingSalesUnitRelation attributes. """ filterEdge: FormViewSharingSalesUnitRelationFilterInput """Order SalesUnit relations by target SalesUnit attributes.""" orderBy: [SalesUnitOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FormViewSharingSalesUnitRelationEntityConnection """ Users that have been granted shared access to this form view (custom share mode). """ sharingClients( """Filter Client relations by target Client attributes.""" filter: ClientFilterInput """ Filter FormViewSharingClientRelation relations by edge (relation) FormViewSharingClientRelation attributes. """ filterEdge: FormViewSharingClientRelationFilterInput """Order Client relations by target Client attributes.""" orderBy: [ClientOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FormViewSharingClientRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Color of one field or web resource on a form view.""" type FormViewItemColor { """Id of the form item (field or web resource) the color applies to.""" id: ID! """Color of the item, as a packed RGB integer.""" color: Int! } """Paginated list of FormViewSharingSalesUnitRelation records.""" type FormViewSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [FormViewSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `FormViewSharingSalesUnitRelationEntity` and its cursor. """ type FormViewSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: FormViewSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Sharing of a form view with a sales unit, as a watcher or an editor.""" type FormViewSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Form view being shared.""" formView: FormViewEntity """Sales unit granted shared access to the form view.""" unit: SalesUnitEntity """Id of the shared form view.""" formViewId: ID! """ Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for FormViewSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input FormViewSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [FormViewSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [FormViewSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: FormViewSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared form view.""" formViewId: EntityFilterStringField """ Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnumFilterInput """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Form view being shared. Matches records where a related record meets these conditions. """ formView: FormViewFilterInput """ Sales unit granted shared access to the form view. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Filter conditions for FormView records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input FormViewFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [FormViewFilterInput!] """Matches records that meet all of the listed filters.""" AND: [FormViewFilterInput!] """Matches records that do not meet this filter.""" NOT: FormViewFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the account type the form view applies to. Set when the form view targets accounts. """ accountTypeId: EntityFilterStringField """ Id of the contact type the form view applies to. Set when the form view targets contacts. """ contactTypeId: EntityFilterStringField """ Id of the lead type the form view applies to. Set when the form view targets leads. """ leadTypeId: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the opportunity type.""" opptyTypeId: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """ 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). """ shareMode: ShareModeEnumFilterInput """ When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account type the form view applies to. Set when the form view targets accounts. Matches records where a related record meets these conditions. """ accountType: AccountTypeFilterInput """ Contact type the form view applies to. Set when the form view targets contacts. Matches records where a related record meets these conditions. """ contactType: ContactTypeFilterInput """ Lead type the form view applies to. Set when the form view targets leads. Matches records where a related record meets these conditions. """ leadType: LeadTypeFilterInput """ Opportunity type the form view applies to. Set when the form view targets opportunities. Matches records where a related record meets these conditions. """ opptyType: OpportunityTypeFilterInput """ User who owns the form view. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales units that have been granted shared access to this form view (custom share mode). Matches records where a related record meets these conditions. """ sharingUnits: FormViewSharingSalesUnitRelationFilterInput """ Users that have been granted shared access to this form view (custom share mode). Matches records where a related record meets these conditions. """ sharingClients: FormViewSharingClientRelationFilterInput } """ Filter conditions for FormViewSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input FormViewSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [FormViewSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [FormViewSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: FormViewSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the shared form view.""" formViewId: EntityFilterStringField """ Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User granted shared access to the form view. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Form view being shared. Matches records where a related record meets these conditions. """ formView: FormViewFilterInput } """Paginated list of FormViewSharingClientRelation records.""" type FormViewSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [FormViewSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `FormViewSharingClientRelationEntity` and its cursor. """ type FormViewSharingClientRelationEntityEdge { """The item at the end of the edge""" node: FormViewSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """Sharing of a form view with a user, as a watcher or an editor.""" type FormViewSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User granted shared access to the form view.""" client: ClientEntity """Form view being shared.""" formView: FormViewEntity """Id of the user.""" clientId: ID! """Id of the shared form view.""" formViewId: ID! """ Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Sorting of FormView records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input FormViewOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account type the form view applies to. Set when the form view targets accounts. Sorts by fields of the related record, listed in order of priority. """ accountType: [AccountTypeOrderByNestedInput!] """ Contact type the form view applies to. Set when the form view targets contacts. Sorts by fields of the related record, listed in order of priority. """ contactType: [ContactTypeOrderByNestedInput!] """ Lead type the form view applies to. Set when the form view targets leads. Sorts by fields of the related record, listed in order of priority. """ leadType: [LeadTypeOrderByNestedInput!] """ Opportunity type the form view applies to. Set when the form view targets opportunities. Sorts by fields of the related record, listed in order of priority. """ opptyType: [OpportunityTypeOrderByNestedInput!] """ User who owns the form view. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Id of the account type the form view applies to. Set when the form view targets accounts. """ accountTypeId: OrderByEnum """ Id of the contact type the form view applies to. Set when the form view targets contacts. """ contactTypeId: OrderByEnum """ Id of the lead type the form view applies to. Set when the form view targets leads. """ leadTypeId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """Id of the owning user.""" ownerId: 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). """ shareMode: OrderByEnum """ When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of FormView records.""" type FormViewEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [FormViewEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `FormViewEntity` and its cursor.""" type FormViewEntityEdge { """The item at the end of the edge""" node: FormViewEntity """A cursor for use in pagination""" cursor: String! } """Read operations for FormViewSharingClientRelation records.""" type FormViewSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): FormViewSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [FormViewSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FormViewSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [FormViewSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FormViewSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: FormViewSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [FormViewSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FormViewSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of FormViewSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input FormViewSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User granted shared access to the form view. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Form view being shared. Sorts by fields of the related record, listed in order of priority. """ formView: [FormViewOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the shared form view.""" formViewId: OrderByEnum """ Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related FormView record. Set exactly one field in each item. """ input FormViewOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the account type the form view applies to. Set when the form view targets accounts. """ accountTypeId: OrderByEnum """ Id of the contact type the form view applies to. Set when the form view targets contacts. """ contactTypeId: OrderByEnum """ Id of the lead type the form view applies to. Set when the form view targets leads. """ leadTypeId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """Id of the owning user.""" ownerId: 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). """ shareMode: OrderByEnum """ When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for FormViewSharingSalesUnitRelation records.""" type FormViewSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): FormViewSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [FormViewSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: FormViewSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [FormViewSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [FormViewSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: FormViewSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [FormViewSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): FormViewSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of FormViewSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input FormViewSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Form view being shared. Sorts by fields of the related record, listed in order of priority. """ formView: [FormViewOrderByNestedInput!] """ Sales unit granted shared access to the form view. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared form view.""" formViewId: OrderByEnum """ Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for GhostContact records.""" type GhostContactRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): GhostContactEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [GhostContactEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: GhostContactFilterInput """Sorting of the returned records.""" orderBy: [GhostContactOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [GhostContactEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: GhostContactFilterInput """Sorting of the returned records.""" orderBy: [GhostContactOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): GhostContactEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Placeholder person on an org chart for someone who is not a contact in the space yet, such as an unknown decision maker. """ type GhostContactEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """Job title or position of the placeholder contact (org-chart label).""" position: String """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for GhostContact records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input GhostContactFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [GhostContactFilterInput!] """Matches records that meet all of the listed filters.""" AND: [GhostContactFilterInput!] """Matches records that do not meet this filter.""" NOT: GhostContactFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Name of the entity and its default text representation.""" name: EntityFilterStringField """Job title or position of the placeholder contact (org-chart label).""" position: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Sorting of GhostContact records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input GhostContactOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Job title or position of the placeholder contact (org-chart label).""" position: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of GhostContact records.""" type GhostContactEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [GhostContactEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `GhostContactEntity` and its cursor.""" type GhostContactEntityEdge { """The item at the end of the edge""" node: GhostContactEntity """A cursor for use in pagination""" cursor: String! } """Read operations for GhostContactAccountAccountRoleRelation records.""" type GhostContactAccountAccountRoleRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): GhostContactAccountAccountRoleRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [GhostContactAccountAccountRoleRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: GhostContactAccountAccountRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostContactAccountAccountRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [GhostContactAccountAccountRoleRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: GhostContactAccountAccountRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostContactAccountAccountRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): GhostContactAccountAccountRoleRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Role assigned to a ghost contact on the org chart of an account.""" type GhostContactAccountAccountRoleRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account role assigned to the ghost contact.""" accountRole: AccountRoleEntity """Ghost-contact-on-account placement this role assignment belongs to.""" ghostContactAccountRelation: GhostContactAccountRelationEntity """Id of the account role assigned to the ghost contact.""" accountRoleId: ID! """Id of the ghost-contact-account placement.""" ghostContactAccountRelationId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Placement of a ghost contact on the org chart of an account, with its position and comment. """ type GhostContactAccountRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account whose org chart includes the ghost contact.""" account: AccountEntity """Placeholder ghost contact placed on the account org chart.""" ghostContact: GhostContactEntity """Id of the account whose org chart includes the ghost contact.""" accountId: ID! """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the account org chart.""" ghostContactId: ID! """ True when the ghost contact is rendered as an assistant of its parent in the org chart. """ isAssistant: Boolean """ True when the ghost contact is rendered as a sibling rather than a child in the org chart. """ isSibling: Boolean """Position label shown on the org chart for the ghost contact.""" position: String """Revision when entity was lastly changed.""" revision: Int """Account roles assigned to the ghost contact on this account.""" accountRoles( """Filter AccountRole relations by target AccountRole attributes.""" filter: AccountRoleFilterInput """ Filter GhostContactAccountAccountRoleRelation relations by edge (relation) GhostContactAccountAccountRoleRelation attributes. """ filterEdge: GhostContactAccountAccountRoleRelationFilterInput """Order AccountRole relations by target AccountRole attributes.""" orderBy: [AccountRoleOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): GhostContactAccountAccountRoleRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of GhostContactAccountAccountRoleRelation records.""" type GhostContactAccountAccountRoleRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [GhostContactAccountAccountRoleRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `GhostContactAccountAccountRoleRelationEntity` and its cursor. """ type GhostContactAccountAccountRoleRelationEntityEdge { """The item at the end of the edge""" node: GhostContactAccountAccountRoleRelationEntity """A cursor for use in pagination""" cursor: String! } """ Filter conditions for GhostContactAccountAccountRoleRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input GhostContactAccountAccountRoleRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [GhostContactAccountAccountRoleRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [GhostContactAccountAccountRoleRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: GhostContactAccountAccountRoleRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account role assigned to the ghost contact.""" accountRoleId: EntityFilterStringField """Id of the ghost-contact-account placement.""" ghostContactAccountRelationId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account role assigned to the ghost contact. Matches records where a related record meets these conditions. """ accountRole: AccountRoleFilterInput """ Ghost-contact-on-account placement this role assignment belongs to. Matches records where a related record meets these conditions. """ ghostContactAccountRelation: GhostContactAccountRelationFilterInput } """ Filter conditions for GhostContactAccountRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input GhostContactAccountRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [GhostContactAccountRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [GhostContactAccountRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: GhostContactAccountRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account whose org chart includes the ghost contact.""" accountId: EntityFilterStringField """Free-text comment shown on the org-chart node.""" comment: EntityFilterStringField """Id of the ghost contact placed on the account org chart.""" ghostContactId: EntityFilterStringField """ True when the ghost contact is rendered as an assistant of its parent in the org chart. """ isAssistant: Boolean """ True when the ghost contact is rendered as a sibling rather than a child in the org chart. """ isSibling: Boolean """Position label shown on the org chart for the ghost contact.""" position: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account whose org chart includes the ghost contact. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Placeholder ghost contact placed on the account org chart. Matches records where a related record meets these conditions. """ ghostContact: GhostContactFilterInput """ Account roles assigned to the ghost contact on this account. Matches records where a related record meets these conditions. """ accountRoles: GhostContactAccountAccountRoleRelationFilterInput } """ Sorting of GhostContactAccountAccountRoleRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input GhostContactAccountAccountRoleRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account role assigned to the ghost contact. Sorts by fields of the related record, listed in order of priority. """ accountRole: [AccountRoleOrderByNestedInput!] """ Ghost-contact-on-account placement this role assignment belongs to. Sorts by fields of the related record, listed in order of priority. """ ghostContactAccountRelation: [GhostContactAccountRelationOrderByNestedInput!] """Id of the account role assigned to the ghost contact.""" accountRoleId: OrderByEnum """Id of the ghost-contact-account placement.""" ghostContactAccountRelationId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related GhostContactAccountRelation record. Set exactly one field in each item. """ input GhostContactAccountRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the account whose org chart includes the ghost contact.""" accountId: OrderByEnum """Free-text comment shown on the org-chart node.""" comment: OrderByEnum """Id of the ghost contact placed on the account org chart.""" ghostContactId: OrderByEnum """ True when the ghost contact is rendered as an assistant of its parent in the org chart. """ isAssistant: OrderByEnum """ True when the ghost contact is rendered as a sibling rather than a child in the org chart. """ isSibling: OrderByEnum """Position label shown on the org chart for the ghost contact.""" position: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for GhostContactAccountRelation records.""" type GhostContactAccountRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): GhostContactAccountRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [GhostContactAccountRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: GhostContactAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostContactAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [GhostContactAccountRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: GhostContactAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostContactAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): GhostContactAccountRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of GhostContactAccountRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input GhostContactAccountRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account whose org chart includes the ghost contact. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Placeholder ghost contact placed on the account org chart. Sorts by fields of the related record, listed in order of priority. """ ghostContact: [GhostContactOrderByNestedInput!] """Id of the account whose org chart includes the ghost contact.""" accountId: OrderByEnum """Free-text comment shown on the org-chart node.""" comment: OrderByEnum """Id of the ghost contact placed on the account org chart.""" ghostContactId: OrderByEnum """ True when the ghost contact is rendered as an assistant of its parent in the org chart. """ isAssistant: OrderByEnum """ True when the ghost contact is rendered as a sibling rather than a child in the org chart. """ isSibling: OrderByEnum """Position label shown on the org chart for the ghost contact.""" position: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related GhostContact record. Set exactly one field in each item. """ input GhostContactOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Job title or position of the placeholder contact (org-chart label).""" position: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of GhostContactAccountRelation records.""" type GhostContactAccountRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [GhostContactAccountRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `GhostContactAccountRelationEntity` and its cursor. """ type GhostContactAccountRelationEntityEdge { """The item at the end of the edge""" node: GhostContactAccountRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for GhostLeadOpptyContactRelation records.""" type GhostLeadOpptyContactRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): GhostLeadOpptyContactRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [GhostLeadOpptyContactRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: GhostLeadOpptyContactRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostLeadOpptyContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [GhostLeadOpptyContactRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: GhostLeadOpptyContactRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostLeadOpptyContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): GhostLeadOpptyContactRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Placement of a ghost contact on the org chart of a lead or an opportunity. """ type GhostLeadOpptyContactRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Placeholder ghost contact placed on the lead/opportunity org chart.""" ghostContact: GhostContactEntity """Org-chart group the ghost contact belongs to, when grouped.""" leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity """ Lead whose org chart includes the ghost contact. Set when leadOpptyId resolves to a Lead. """ lead: LeadEntity """ Opportunity whose org chart includes the ghost contact. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the lead/opportunity org chart.""" ghostContactId: ID! """Id of the parent org-chart group.""" leadOpptyContactGroupRelationId: ID """Id of the linked lead or opportunity.""" leadOpptyId: ID! """ Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the ghost contact on this lead/opportunity.""" salesRoles( """Filter SalesRole relations by target SalesRole attributes.""" filter: SalesRoleFilterInput """ Filter GhostLeadOpptyContactSalesRoleRelation relations by edge (relation) GhostLeadOpptyContactSalesRoleRelation attributes. """ filterEdge: GhostLeadOpptyContactSalesRoleRelationFilterInput """Order SalesRole relations by target SalesRole attributes.""" orderBy: [SalesRoleOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): GhostLeadOpptyContactSalesRoleRelationEntityConnection """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Paginated list of GhostLeadOpptyContactSalesRoleRelation records.""" type GhostLeadOpptyContactSalesRoleRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [GhostLeadOpptyContactSalesRoleRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `GhostLeadOpptyContactSalesRoleRelationEntity` and its cursor. """ type GhostLeadOpptyContactSalesRoleRelationEntityEdge { """The item at the end of the edge""" node: GhostLeadOpptyContactSalesRoleRelationEntity """A cursor for use in pagination""" cursor: String! } """ Sales role assigned to a placeholder (ghost) contact on the org chart of a lead or opportunity. """ type GhostLeadOpptyContactSalesRoleRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Ghost-contact-on-lead/opportunity placement this role assignment belongs to. """ ghostLeadOpptyContactRelation: GhostLeadOpptyContactRelationEntity """Sales role assigned to the ghost contact.""" salesRole: SalesRoleEntity """Id of the ghost-contact-lead/opportunity placement.""" ghostLeadOpptyContactRelationId: ID! """Id of the sales role assigned to the ghost contact.""" salesRoleId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for GhostLeadOpptyContactSalesRoleRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input GhostLeadOpptyContactSalesRoleRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [GhostLeadOpptyContactSalesRoleRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [GhostLeadOpptyContactSalesRoleRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: GhostLeadOpptyContactSalesRoleRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the ghost-contact-lead/opportunity placement.""" ghostLeadOpptyContactRelationId: EntityFilterStringField """Id of the sales role assigned to the ghost contact.""" salesRoleId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Ghost-contact-on-lead/opportunity placement this role assignment belongs to. Matches records where a related record meets these conditions. """ ghostLeadOpptyContactRelation: GhostLeadOpptyContactRelationFilterInput """ Sales role assigned to the ghost contact. Matches records where a related record meets these conditions. """ salesRole: SalesRoleFilterInput } """ Filter conditions for GhostLeadOpptyContactRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input GhostLeadOpptyContactRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [GhostLeadOpptyContactRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [GhostLeadOpptyContactRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: GhostLeadOpptyContactRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Free-text comment shown on the org-chart node.""" comment: EntityFilterStringField """Id of the ghost contact placed on the lead/opportunity org chart.""" ghostContactId: EntityFilterStringField """Id of the parent org-chart group.""" leadOpptyContactGroupRelationId: EntityFilterStringField """Id of the linked lead or opportunity.""" leadOpptyId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Placeholder ghost contact placed on the lead/opportunity org chart. Matches records where a related record meets these conditions. """ ghostContact: GhostContactFilterInput """ Org-chart group the ghost contact belongs to, when grouped. Matches records where a related record meets these conditions. """ leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationFilterInput """ Lead whose org chart includes the ghost contact. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity whose org chart includes the ghost contact. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Sales roles assigned to the ghost contact on this lead/opportunity. Matches records where a related record meets these conditions. """ salesRoles: GhostLeadOpptyContactSalesRoleRelationFilterInput } """ Sorting of GhostLeadOpptyContactRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input GhostLeadOpptyContactRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Placeholder ghost contact placed on the lead/opportunity org chart. Sorts by fields of the related record, listed in order of priority. """ ghostContact: [GhostContactOrderByNestedInput!] """ Org-chart group the ghost contact belongs to, when grouped. Sorts by fields of the related record, listed in order of priority. """ leadOpptyContactGroupRelation: [LeadOpptyContactGroupRelationOrderByNestedInput!] """ Lead whose org chart includes the ghost contact. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity whose org chart includes the ghost contact. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """Free-text comment shown on the org-chart node.""" comment: OrderByEnum """Id of the ghost contact placed on the lead/opportunity org chart.""" ghostContactId: OrderByEnum """Id of the parent org-chart group.""" leadOpptyContactGroupRelationId: OrderByEnum """Id of the linked lead or opportunity.""" leadOpptyId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related LeadOpptyContactGroupRelation record. Set exactly one field in each item. """ input LeadOpptyContactGroupRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of GhostLeadOpptyContactRelation records.""" type GhostLeadOpptyContactRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [GhostLeadOpptyContactRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `GhostLeadOpptyContactRelationEntity` and its cursor. """ type GhostLeadOpptyContactRelationEntityEdge { """The item at the end of the edge""" node: GhostLeadOpptyContactRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for GhostLeadOpptyContactSalesRoleRelation records.""" type GhostLeadOpptyContactSalesRoleRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): GhostLeadOpptyContactSalesRoleRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [GhostLeadOpptyContactSalesRoleRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: GhostLeadOpptyContactSalesRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostLeadOpptyContactSalesRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [GhostLeadOpptyContactSalesRoleRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: GhostLeadOpptyContactSalesRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [GhostLeadOpptyContactSalesRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): GhostLeadOpptyContactSalesRoleRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of GhostLeadOpptyContactSalesRoleRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input GhostLeadOpptyContactSalesRoleRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Ghost-contact-on-lead/opportunity placement this role assignment belongs to. Sorts by fields of the related record, listed in order of priority. """ ghostLeadOpptyContactRelation: [GhostLeadOpptyContactRelationOrderByNestedInput!] """ Sales role assigned to the ghost contact. Sorts by fields of the related record, listed in order of priority. """ salesRole: [SalesRoleOrderByNestedInput!] """Id of the ghost-contact-lead/opportunity placement.""" ghostLeadOpptyContactRelationId: OrderByEnum """Id of the sales role assigned to the ghost contact.""" salesRoleId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related GhostLeadOpptyContactRelation record. Set exactly one field in each item. """ input GhostLeadOpptyContactRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text comment shown on the org-chart node.""" comment: OrderByEnum """Id of the ghost contact placed on the lead/opportunity org chart.""" ghostContactId: OrderByEnum """Id of the parent org-chart group.""" leadOpptyContactGroupRelationId: OrderByEnum """Id of the linked lead or opportunity.""" leadOpptyId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related SalesRole record. Set exactly one field in each item. """ input SalesRoleOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ colorCode: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ImportMappingMask records.""" type ImportMappingMaskRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ImportMappingMaskEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ImportMappingMaskEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ImportMappingMaskFilterInput """Sorting of the returned records.""" orderBy: [ImportMappingMaskOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ImportMappingMaskEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ImportMappingMaskFilterInput """Sorting of the returned records.""" orderBy: [ImportMappingMaskOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ImportMappingMaskEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the saved import column mappings for the given record type, sorted by name. """ getForEntityType( """Record type the import mappings are for.""" entityType: ImportMaskEntityTypeEnum! """ API name of the custom entity; required for custom entity imports and omitted otherwise. """ entityApiName: String ): [ImportMappingMaskEntity!]! } """ Saved mapping of import file columns to fields, reused when importing records of the same entity. """ type ImportMappingMaskEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who owns the import mapping mask.""" owner: ClientEntity """ API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). """ entityApiName: String """ Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. """ entityType: ImportMaskEntityTypeEnum! """ How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. """ mapping: JSONString! """Display name of the mask.""" name: String! """Id of the owning user.""" ownerId: ID! """ Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. """ relationTypes: JSONString """ Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. """ shareMode: ProfileShareMode """Revision when entity was lastly changed.""" revision: Int """ Users granted shared access to this import mapping mask (custom share mode). """ sharingClients: [ClientEntity!] """ Sales units granted shared access to this import mapping mask (custom share mode). """ sharingUnits: [SalesUnitEntity!] """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ How the columns of the import file map to fields: one item per mapped field, with the mapping type and the source column. """ mappingMask: [ImportMappingMaskItem!] """Record type selected for each mapped relation field of the mask.""" mappingRelationTypes: [ImportMappingRelationType!] """ True for a default import mapping mask provided by Coevera; it cannot be deleted. """ isDefault: Boolean! } """Entity that an import mapping mask imports records into.""" enum ImportMaskEntityTypeEnum { """ Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. """ Lead """ Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. """ Opportunity """ Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. """ Account """ Person the sales team works with, usually linked to one or more accounts, leads and opportunities. """ Contact """Users of the space.""" Client """ Product or service in the catalog that can be added as a line item to opportunities and quotes. """ Product """Product prices in price lists.""" ProductPriceListPrice """ Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. """ CustomEntity } """Who besides the owner can use a shared item such as an import mapping.""" enum ProfileShareMode { """Only the owner.""" Private """All users.""" Public """The users and sales units the item is shared with.""" SelectedUnitsAndUsers } """ How a saved import mapping fills one field: the mapping type and the source column of the import file. """ type ImportMappingMaskItem { """Id of the field the import fills.""" fieldId: ID! """How the import fills the field.""" mappingType: ImportFieldMappingType! """ Index of the import file column the value is read from; set when mappingType is ColumnIndex. """ columnIndex: Int } """How an import mapping fills a target field.""" enum ImportFieldMappingType { """Value is read from the file column given by columnIndex.""" ColumnIndex """The field's default value is used.""" UseDefaultValues """The value is calculated by Coevera instead of imported.""" CalculateValue } """Record type selected for a relation field in a saved import mapping.""" type ImportMappingRelationType { """Id of the mapped relation field.""" fieldId: ID! """Id of the record type selected for the relation field.""" entityTypeId: ID! } """ Filter conditions for ImportMappingMask records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ImportMappingMaskFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ImportMappingMaskFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ImportMappingMaskFilterInput!] """Matches records that do not meet this filter.""" NOT: ImportMappingMaskFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). """ entityApiName: EntityFilterStringField """ Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. """ entityType: ImportMaskEntityTypeEnumFilterInput """Display name of the mask.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """ Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. """ shareMode: ShareModeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who owns the import mapping mask. Matches records where a related record meets these conditions. """ owner: ClientFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ImportMaskEntityTypeEnumFilterInput { """Matches any of the listed values.""" eq: [ImportMaskEntityTypeEnum!] """Matches values that do not meet this condition.""" NOT: ImportMaskEntityTypeEnumFilterInput } """ Sorting of ImportMappingMask records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ImportMappingMaskOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the import mapping mask. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). """ entityApiName: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. """ shareMode: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ImportMappingMask records.""" type ImportMappingMaskEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ImportMappingMaskEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ImportMappingMaskEntity` and its cursor.""" type ImportMappingMaskEntityEdge { """The item at the end of the edge""" node: ImportMappingMaskEntity """A cursor for use in pagination""" cursor: String! } """Read operations for InterfacePreview records.""" type InterfacePreviewRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): InterfacePreviewEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [InterfacePreviewEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: InterfacePreviewFilterInput """Sorting of the returned records.""" orderBy: [InterfacePreviewOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [InterfacePreviewEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: InterfacePreviewFilterInput """Sorting of the returned records.""" orderBy: [InterfacePreviewOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [InterfacePreviewEntity!]! """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: InterfacePreviewFilterInput """Sorting of the returned records.""" orderBy: [InterfacePreviewOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [InterfacePreviewEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: InterfacePreviewFilterInput """Sorting of the returned records.""" orderBy: [InterfacePreviewOrderByInput!] ): [InterfacePreviewEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): InterfacePreviewEntity! } """ Layout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts. """ type InterfacePreviewEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account type the interface preview applies to.""" accountType: AccountTypeEntity """Appointment type the interface preview applies to.""" appointmentType: AppointmentTypeEntity """Contact type the interface preview applies to.""" contactType: ContactTypeEntity """Custom entity type the interface preview applies to.""" customEntityType: CustomEntityTypeEntity """Lead type the interface preview applies to.""" leadType: LeadTypeEntity """Opportunity type the interface preview applies to.""" opptyType: OpportunityTypeEntity """Product type the interface preview applies to.""" productType: ProductTypeEntity """Project type the interface preview applies to.""" projectType: ProjectTypeEntity """Quote type the interface preview applies to.""" quoteType: QuoteTypeEntity """Task type the interface preview applies to.""" taskType: TaskTypeEntity """Id of the account type the interface preview applies to.""" accountTypeId: ID """Id of the appointment type the interface preview applies to.""" appointmentTypeId: ID """Ordered ids of fields shown on the record's compact card view.""" cardFieldIds: [UUID!]! """ Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments). """ charts: [InterfacePreviewChart!]! """Id of the contact type the interface preview applies to.""" contactTypeId: ID """Id of the custom entity type the interface preview applies to.""" customEntityTypeId: ID """ Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs). """ detailTabs: [InterfaceDetailTab!]! """ Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs). """ detailWidgets: [InterfaceDetailWidget!]! """Ordered ids of fields shown in the record's preview pane.""" fieldIds: [UUID!]! """Id of the lead type the interface preview applies to.""" leadTypeId: ID """Id of the opportunity type.""" opptyTypeId: ID """Id of the product type the interface preview applies to.""" productTypeId: ID """Id of the project type the interface preview applies to.""" projectTypeId: ID """Id of the quote type the interface preview applies to.""" quoteTypeId: ID """ Layout-customization settings for the preview (e.g. isLayoutCustomizationEnabled). This payload conforms to the `InterfacePreviewCustomSettings` JSON Schema: GET /api/v100/rest/schemas/InterfacePreviewCustomSettings.json on your region's API host """ settings: InterfacePreviewCustomSettings! """Id of the task type the interface preview applies to.""" taskTypeId: ID """ True when the interface preview is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set. """ entityTypeId: UUID! """ For custom entities, the API name of the targeted custom entity. Empty when the preview targets a built-in entity (use entityType to identify it). """ entityApiName: String """ Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived from whichever of the per-entity-type relations is set. """ entityType: BaseEntityTypeEnum! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for InterfacePreview records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input InterfacePreviewFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [InterfacePreviewFilterInput!] """Matches records that meet all of the listed filters.""" AND: [InterfacePreviewFilterInput!] """Matches records that do not meet this filter.""" NOT: InterfacePreviewFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account type the interface preview applies to.""" accountTypeId: EntityFilterStringField """Id of the appointment type the interface preview applies to.""" appointmentTypeId: EntityFilterStringField """Id of the contact type the interface preview applies to.""" contactTypeId: EntityFilterStringField """Id of the custom entity type the interface preview applies to.""" customEntityTypeId: EntityFilterStringField """Id of the lead type the interface preview applies to.""" leadTypeId: EntityFilterStringField """Id of the opportunity type.""" opptyTypeId: EntityFilterStringField """Id of the product type the interface preview applies to.""" productTypeId: EntityFilterStringField """Id of the project type the interface preview applies to.""" projectTypeId: EntityFilterStringField """Id of the quote type the interface preview applies to.""" quoteTypeId: EntityFilterStringField """Id of the task type the interface preview applies to.""" taskTypeId: EntityFilterStringField """ True when the interface preview is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set. """ entityTypeId: UUID """ For custom entities, the API name of the targeted custom entity. Empty when the preview targets a built-in entity (use entityType to identify it). """ entityApiName: String """ Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived from whichever of the per-entity-type relations is set. """ entityType: BaseEntityTypeEnum """ Account type the interface preview applies to. Matches records where a related record meets these conditions. """ accountType: AccountTypeFilterInput """ Appointment type the interface preview applies to. Matches records where a related record meets these conditions. """ appointmentType: AppointmentTypeFilterInput """ Contact type the interface preview applies to. Matches records where a related record meets these conditions. """ contactType: ContactTypeFilterInput """ Custom entity type the interface preview applies to. Matches records where a related record meets these conditions. """ customEntityType: CustomEntityTypeFilterInput """ Lead type the interface preview applies to. Matches records where a related record meets these conditions. """ leadType: LeadTypeFilterInput """ Opportunity type the interface preview applies to. Matches records where a related record meets these conditions. """ opptyType: OpportunityTypeFilterInput """ Product type the interface preview applies to. Matches records where a related record meets these conditions. """ productType: ProductTypeFilterInput """ Project type the interface preview applies to. Matches records where a related record meets these conditions. """ projectType: ProjectTypeFilterInput """ Quote type the interface preview applies to. Matches records where a related record meets these conditions. """ quoteType: QuoteTypeFilterInput """ Task type the interface preview applies to. Matches records where a related record meets these conditions. """ taskType: TaskTypeFilterInput } """ Sorting of InterfacePreview records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input InterfacePreviewOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ accountType: [AccountTypeOrderByNestedInput!] """ Appointment type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ appointmentType: [AppointmentTypeOrderByNestedInput!] """ Contact type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ contactType: [ContactTypeOrderByNestedInput!] """ Custom entity type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ customEntityType: [CustomEntityTypeOrderByNestedInput!] """ Lead type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ leadType: [LeadTypeOrderByNestedInput!] """ Opportunity type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ opptyType: [OpportunityTypeOrderByNestedInput!] """ Product type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ productType: [ProductTypeOrderByNestedInput!] """ Project type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ projectType: [ProjectTypeOrderByNestedInput!] """ Quote type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ quoteType: [QuoteTypeOrderByNestedInput!] """ Task type the interface preview applies to. Sorts by fields of the related record, listed in order of priority. """ taskType: [TaskTypeOrderByNestedInput!] """Id of the account type the interface preview applies to.""" accountTypeId: OrderByEnum """Id of the appointment type the interface preview applies to.""" appointmentTypeId: OrderByEnum """Id of the contact type the interface preview applies to.""" contactTypeId: OrderByEnum """Id of the custom entity type the interface preview applies to.""" customEntityTypeId: OrderByEnum """Id of the lead type the interface preview applies to.""" leadTypeId: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """Id of the product type the interface preview applies to.""" productTypeId: OrderByEnum """Id of the project type the interface preview applies to.""" projectTypeId: OrderByEnum """Id of the quote type the interface preview applies to.""" quoteTypeId: OrderByEnum """Id of the task type the interface preview applies to.""" taskTypeId: OrderByEnum """ True when the interface preview is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ For custom entities, the API name of the targeted custom entity. Empty when the preview targets a built-in entity (use entityType to identify it). """ entityApiName: OrderByEnum } """Read operations for Lead records.""" type LeadRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadFilterInput """Sorting of the returned records.""" orderBy: [LeadOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadFilterInput """Sorting of the returned records.""" orderBy: [LeadOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): LeadEntity! """ Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. """ aiAutoPrefill( """ Id of the suggested action, as returned by the AI record suggestions or AI chat. """ actionId: String! ): LeadAutoPrefill! } """Paginated list of Lead records.""" type LeadEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `LeadEntity` and its cursor.""" type LeadEntityEdge { """The item at the end of the edge""" node: LeadEntity """A cursor for use in pagination""" cursor: String! } """ New, unsaved lead pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in. """ type LeadAutoPrefill { """New lead carrying the pre-filled values; it is not saved.""" entity: LeadEntity """Ids of the fields that were filled in.""" fieldIds: [UUID!]! } """Read operations for LeadOppty records.""" type LeadOpptyRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Lead or opportunity, with the fields both kinds of sales records share. """ type LeadOpptyEntity { """ Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). """ customFields( """Api names of custom fields to retrieve. All are returned if not set.""" apiNames: [String!] ): JSONString! """ Filled only when a single record is read by its id; otherwise null or an empty list. """ pendingScheduledActions: Int """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Values of the fields shown in the record's preview pane, as configured for the record's type. """ fields( """ Ids of the fields to return. When not set, the fields configured for the preview pane of the record's type are returned. """ ids: [UUID!] """ Maximum number of preview pane fields to return when ids is not set; fields pinned by the current user come first. """ first: Int ): [InterfaceFieldData]! } """ Filter conditions for LeadOppty records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Matches records related to at least one of the listed records.""" relatedEntities: [EntityFilterRelatedField] } """ Sorting of LeadOppty records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Sorts records by whether they are related to the listed records.""" relatedEntities: CommonEntityRepositoryOrderByEntityRelationField } """Paginated list of LeadOppty records.""" type LeadOpptyEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `LeadOpptyEntity` and its cursor.""" type LeadOpptyEntityEdge { """The item at the end of the edge""" node: LeadOpptyEntity """A cursor for use in pagination""" cursor: String! } """Read operations for LeadOpptyAccountRelation records.""" type LeadOpptyAccountRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyAccountRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyAccountRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyAccountRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyAccountRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of LeadOpptyAccountRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyAccountRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account linked to the lead or opportunity. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Lead the account is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the account is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """Id of the account linked to the lead or opportunity.""" accountId: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """Id of the lead or opportunity this link belongs to.""" leadOpptyId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for LeadOpptyContactGroupRelation records.""" type LeadOpptyContactGroupRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyContactGroupRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyContactGroupRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyContactGroupRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyContactGroupRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyContactGroupRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyContactGroupRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyContactGroupRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyContactGroupRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of LeadOpptyContactGroupRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyContactGroupRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead this contact group belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity this contact group belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of LeadOpptyContactGroupRelation records.""" type LeadOpptyContactGroupRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyContactGroupRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptyContactGroupRelationEntity` and its cursor. """ type LeadOpptyContactGroupRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptyContactGroupRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for LeadOpptyContactRelation records.""" type LeadOpptyContactRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyContactRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyContactRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyContactRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyContactRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyContactRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyContactRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of LeadOpptyContactRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyContactRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact linked to the lead or opportunity. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Sorts by fields of the related record, listed in order of priority. """ leadOpptyContactGroupRelation: [LeadOpptyContactGroupRelationOrderByNestedInput!] """ Lead the contact is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the contact is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """Free-form note describing this contact link.""" comment: OrderByEnum """Id of the contact linked to the lead or opportunity.""" contactId: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: OrderByEnum """Id of the lead or opportunity this link belongs to.""" leadOpptyId: OrderByEnum """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for LeadOpptyContactSalesRoleRelation records.""" type LeadOpptyContactSalesRoleRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyContactSalesRoleRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyContactSalesRoleRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyContactSalesRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyContactSalesRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyContactSalesRoleRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyContactSalesRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyContactSalesRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyContactSalesRoleRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of LeadOpptyContactSalesRoleRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyContactSalesRoleRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead/opportunity-contact link this sales-role assignment belongs to. Sorts by fields of the related record, listed in order of priority. """ leadOpptyContactRelation: [LeadOpptyContactRelationOrderByNestedInput!] """ Sales role assigned to the contact on this lead or opportunity. Sorts by fields of the related record, listed in order of priority. """ salesRole: [SalesRoleOrderByNestedInput!] """Id of the lead/opportunity-contact link.""" leadOpptyContactRelationId: OrderByEnum """ Id of the sales role assigned to the contact on this lead or opportunity. """ salesRoleId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related LeadOpptyContactRelation record. Set exactly one field in each item. """ input LeadOpptyContactRelationOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-form note describing this contact link.""" comment: OrderByEnum """Id of the contact linked to the lead or opportunity.""" contactId: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: OrderByEnum """Id of the lead or opportunity this link belongs to.""" leadOpptyId: OrderByEnum """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of LeadOpptyContactSalesRoleRelation records.""" type LeadOpptyContactSalesRoleRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyContactSalesRoleRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptyContactSalesRoleRelationEntity` and its cursor. """ type LeadOpptyContactSalesRoleRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptyContactSalesRoleRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for LeadOpptyDataExRelation records.""" type LeadOpptyDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Option selected in a multi-select checkbox field of a lead or opportunity. """ type LeadOpptyDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """ Lead on which the option is selected; empty when leadOpptyId is an opportunity. """ lead: LeadEntity """ Opportunity on which the option is selected; empty when leadOpptyId is a lead. """ oppty: OpportunityEntity """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the lead or opportunity on which the option is selected.""" leadOpptyId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for LeadOpptyDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Id of the lead or opportunity on which the option is selected.""" leadOpptyId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput """ Lead on which the option is selected; empty when leadOpptyId is an opportunity. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity on which the option is selected; empty when leadOpptyId is a lead. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput } """ Sorting of LeadOpptyDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """ Lead on which the option is selected; empty when leadOpptyId is an opportunity. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity on which the option is selected; empty when leadOpptyId is a lead. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """Id of the selected option.""" dataId: OrderByEnum """Id of the lead or opportunity on which the option is selected.""" leadOpptyId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of LeadOpptyDataExRelation records.""" type LeadOpptyDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptyDataExRelationEntity` and its cursor. """ type LeadOpptyDataExRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptyDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for LeadOpptyKPI records.""" type LeadOpptyKPIRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyKPIEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyKPIEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyKPIFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyKPIEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyKPIFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyKPIEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ KPI event of a lead or opportunity (e.g. created, qualified, won, lost or moved to another step), used in activity reporting. """ type LeadOpptyKPIEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ User who triggered the KPI event (e.g. created the lead, qualified it, won or lost the opportunity, moved the record). """ client: ClientEntity """ Lead this KPI event relates to. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity this KPI event relates to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """Lead/opportunity owner at the time the KPI event occurred.""" owner: ClientEntity """Sales unit the triggering user belonged to at the time of the event.""" unit: SalesUnitEntity """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove or LastModified. """ kpi: LeadOpptyKpiEnum! """Id of the lead or opportunity the KPI event relates to.""" leadOpptyId: ID! """Id of the lead/opportunity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of lead or opportunity event recorded as a KPI entry; each record keeps at most one entry per kind, dated when the event last happened. """ enum LeadOpptyKpiEnum { """The lead was created.""" CreateLeads """The opportunity was created directly, not qualified from a lead.""" CreateOppty """The lead was qualified into an opportunity.""" QualifyLead """The opportunity was won.""" WinOppty """The lead was lost.""" LoseLead """The opportunity was lost.""" LoseOppty """ The record entered its current pipeline step (set on create and on every step change). """ LastMove """The record was last modified.""" LastModified } """ Filter conditions for LeadOpptyKPI records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyKPIFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyKPIFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyKPIFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyKPIFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: EntityFilterStringField """Id of the user who triggered the event.""" clientId: EntityFilterStringField """ KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove or LastModified. """ kpi: LeadOpptyKpiEnumFilterInput """Id of the lead or opportunity the KPI event relates to.""" leadOpptyId: EntityFilterStringField """Id of the lead/opportunity owner at the time of the event.""" ownerId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who triggered the KPI event (e.g. created the lead, qualified it, won or lost the opportunity, moved the record). Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Lead this KPI event relates to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity this KPI event relates to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Lead/opportunity owner at the time the KPI event occurred. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Sales unit the triggering user belonged to at the time of the event. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input LeadOpptyKpiEnumFilterInput { """Matches any of the listed values.""" eq: [LeadOpptyKpiEnum!] """Matches values that do not meet this condition.""" NOT: LeadOpptyKpiEnumFilterInput } """ Sorting of LeadOpptyKPI records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyKPIOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who triggered the KPI event (e.g. created the lead, qualified it, won or lost the opportunity, moved the record). Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Lead this KPI event relates to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity this KPI event relates to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Lead/opportunity owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Sales unit the triggering user belonged to at the time of the event. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the user who triggered the event.""" clientId: OrderByEnum """Id of the lead or opportunity the KPI event relates to.""" leadOpptyId: OrderByEnum """Id of the lead/opportunity owner at the time of the event.""" ownerId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of LeadOpptyKPI records.""" type LeadOpptyKPIEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyKPIEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `LeadOpptyKPIEntity` and its cursor.""" type LeadOpptyKPIEntityEdge { """The item at the end of the edge""" node: LeadOpptyKPIEntity """A cursor for use in pagination""" cursor: String! } """Read operations for LeadOpptySharingClientRelation records.""" type LeadOpptySharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptySharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptySharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptySharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptySharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptySharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptySharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptySharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptySharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of LeadOpptySharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptySharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the lead or opportunity is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the lead or opportunity being shared.""" leadOpptyId: OrderByEnum """ Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for LeadOpptySharingSalesUnitRelation records.""" type LeadOpptySharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptySharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptySharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptySharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptySharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptySharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptySharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptySharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptySharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of LeadOpptySharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptySharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Sales unit the lead or opportunity is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the lead or opportunity being shared.""" leadOpptyId: OrderByEnum """ Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for LeadOpptyStepCheckListRelation records.""" type LeadOpptyStepCheckListRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadOpptyStepCheckListRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadOpptyStepCheckListRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadOpptyStepCheckListRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyStepCheckListRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadOpptyStepCheckListRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadOpptyStepCheckListRelationFilterInput """Sorting of the returned records.""" orderBy: [LeadOpptyStepCheckListRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadOpptyStepCheckListRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Completion of a step checklist item on a lead, opportunity or quote, with the activity, email, note or document that fulfils it. """ type LeadOpptyStepCheckListRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Appointment used as evidence for this checklist item. Set when activityId resolves to an Appointment; otherwise empty. """ appointment: AppointmentEntity """ Task used as evidence for this checklist item. Set when activityId resolves to a Task; otherwise empty. """ task: TaskEntity """Document linked as evidence for this checklist item.""" cloudObject: CloudObjectEntity """Email linked as evidence for this checklist item.""" email: EmailEntity """ Lead this checklist completion belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. """ lead: LeadEntity """ Opportunity this checklist completion belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. """ oppty: OpportunityEntity """Note linked as evidence for this checklist item.""" note: NoteEntity """ Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. """ quote: QuoteEntity """Step checklist item this completion record refers to.""" stepChecklist: StepChecklistEntity """ Id of the appointment or task linked as evidence for this checklist item. """ activityId: ID """Id of the document.""" cloudObjectId: ID """Id of the email linked as evidence for this checklist item.""" emailId: ID """ True when the checklist item has been completed for this lead, opportunity or quote. """ itemChecked: Boolean """ Id of the lead or opportunity, or empty when this completion belongs to a quote. """ leadOpptyId: ID """Id of the note linked as evidence for this checklist item.""" noteId: ID """ Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. """ quoteId: ID """Id of the step checklist item.""" stepChecklistId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for LeadOpptyStepCheckListRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input LeadOpptyStepCheckListRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [LeadOpptyStepCheckListRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [LeadOpptyStepCheckListRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: LeadOpptyStepCheckListRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the appointment or task linked as evidence for this checklist item. """ activityId: EntityFilterStringField """Id of the document.""" cloudObjectId: EntityFilterStringField """Id of the email linked as evidence for this checklist item.""" emailId: EntityFilterStringField """ True when the checklist item has been completed for this lead, opportunity or quote. """ itemChecked: Boolean """ Id of the lead or opportunity, or empty when this completion belongs to a quote. """ leadOpptyId: EntityFilterStringField """Id of the note linked as evidence for this checklist item.""" noteId: EntityFilterStringField """ Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. """ quoteId: EntityFilterStringField """Id of the step checklist item.""" stepChecklistId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Appointment used as evidence for this checklist item. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions. """ appointment: AppointmentFilterInput """ Task used as evidence for this checklist item. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions. """ task: TaskFilterInput """ Document linked as evidence for this checklist item. Matches records where a related record meets these conditions. """ cloudObject: CloudObjectFilterInput """ Email linked as evidence for this checklist item. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Lead this checklist completion belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity this checklist completion belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Note linked as evidence for this checklist item. Matches records where a related record meets these conditions. """ note: NoteFilterInput """ Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Step checklist item this completion record refers to. Matches records where a related record meets these conditions. """ stepChecklist: StepChecklistFilterInput } """ Filter conditions for Note records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input NoteFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [NoteFilterInput!] """Matches records that meet all of the listed filters.""" AND: [NoteFilterInput!] """Matches records that do not meet this filter.""" NOT: NoteFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the account the note is attached to.""" accountId: EntityFilterStringField """Id of the contact the note is attached to.""" contactId: EntityFilterStringField """Id of the custom entity record the note is attached to.""" customEntityId: EntityFilterStringField """Id of the lead or opportunity the note is attached to.""" leadOpptyId: EntityFilterStringField """Free-form text body of the note (sanitized HTML allowed).""" note: EntityFilterStringField """Id of the note author.""" ownerId: EntityFilterStringField """Id of the project the note is attached to.""" projectId: EntityFilterStringField """Id of the quote the note is attached to.""" quoteId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the note is attached to. Exactly one of account / contact / leadOppty / project / quote / customEntity must be set. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Contact the note is attached to. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record the note is attached to. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Lead the note is attached to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the note is attached to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ User who authored the note. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Project the note is attached to. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Quote the note is attached to. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Sorting of LeadOpptyStepCheckListRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadOpptyStepCheckListRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment used as evidence for this checklist item. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task used as evidence for this checklist item. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Document linked as evidence for this checklist item. Sorts by fields of the related record, listed in order of priority. """ cloudObject: [CloudObjectOrderByNestedInput!] """ Email linked as evidence for this checklist item. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Lead this checklist completion belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity this checklist completion belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Note linked as evidence for this checklist item. Sorts by fields of the related record, listed in order of priority. """ note: [NoteOrderByNestedInput!] """ Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Step checklist item this completion record refers to. Sorts by fields of the related record, listed in order of priority. """ stepChecklist: [StepChecklistOrderByNestedInput!] """ Id of the appointment or task linked as evidence for this checklist item. """ activityId: OrderByEnum """Id of the document.""" cloudObjectId: OrderByEnum """Id of the email linked as evidence for this checklist item.""" emailId: OrderByEnum """ True when the checklist item has been completed for this lead, opportunity or quote. """ itemChecked: OrderByEnum """ Id of the lead or opportunity, or empty when this completion belongs to a quote. """ leadOpptyId: OrderByEnum """Id of the note linked as evidence for this checklist item.""" noteId: OrderByEnum """ Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. """ quoteId: OrderByEnum """Id of the step checklist item.""" stepChecklistId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related CloudObject record. Set exactly one field in each item. """ input CloudObjectOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the producing application.""" applicationId: OrderByEnum """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: OrderByEnum """Id of the uploading user.""" creatorId: OrderByEnum """File name (with extension) used when downloading the object.""" filename: OrderByEnum """When true, the object can be served via a public URL (see publicUrl).""" isPublic: OrderByEnum """Mime-type of the cloud object Is detected from content.""" mimeType: OrderByEnum """Size of the object in bytes.""" size: OrderByEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Note record. Set exactly one field in each item. """ input NoteOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the account the note is attached to.""" accountId: OrderByEnum """Id of the contact the note is attached to.""" contactId: OrderByEnum """Id of the custom entity record the note is attached to.""" customEntityId: OrderByEnum """Id of the lead or opportunity the note is attached to.""" leadOpptyId: OrderByEnum """Free-form text body of the note (sanitized HTML allowed).""" note: OrderByEnum """Id of the note author.""" ownerId: OrderByEnum """Id of the project the note is attached to.""" projectId: OrderByEnum """Id of the quote the note is attached to.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related StepChecklist record. Set exactly one field in each item. """ input StepChecklistOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: OrderByEnum """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: OrderByEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: OrderByEnum """Free-text description shown alongside the checklist item.""" description: OrderByEnum """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: OrderByEnum """Id of the related field.""" fieldId: OrderByEnum """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: OrderByEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: OrderByEnum """Display label of the checklist item.""" label: OrderByEnum """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: OrderByEnum """Id of the related process.""" processId: OrderByEnum """Id of the recipient field.""" sendEmailFieldId: OrderByEnum """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: OrderByEnum """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: OrderByEnum """ Position of the checklist item within its step; lower values appear first. """ sortOrder: OrderByEnum """Id of the pipeline or process step this checklist item belongs to.""" stepId: OrderByEnum """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of LeadOpptyStepCheckListRelation records.""" type LeadOpptyStepCheckListRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadOpptyStepCheckListRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `LeadOpptyStepCheckListRelationEntity` and its cursor. """ type LeadOpptyStepCheckListRelationEntityEdge { """The item at the end of the edge""" node: LeadOpptyStepCheckListRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for LeadProcess records.""" type LeadProcessRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadProcessEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadProcessEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadProcessFilterInput """Sorting of the returned records.""" orderBy: [LeadProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadProcessEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadProcessFilterInput """Sorting of the returned records.""" orderBy: [LeadProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadProcessEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of LeadProcess records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input LeadProcessOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of LeadProcess records.""" type LeadProcessEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadProcessEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `LeadProcessEntity` and its cursor.""" type LeadProcessEntityEdge { """The item at the end of the edge""" node: LeadProcessEntity """A cursor for use in pagination""" cursor: String! } """Read operations for LeadType records.""" type LeadTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): LeadTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [LeadTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadTypeFilterInput """Sorting of the returned records.""" orderBy: [LeadTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: LeadTypeFilterInput """Sorting of the returned records.""" orderBy: [LeadTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): LeadTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: LeadTypeFilterInput """Sorting of the returned records.""" orderBy: [LeadTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [LeadTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: LeadTypeFilterInput """Sorting of the returned records.""" orderBy: [LeadTypeOrderByInput!] ): [LeadTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): LeadTypeEntity! """ Returns the lead type that uses the given lead process, or null when none does. """ getByLeadProcess( """Id of the lead process.""" leadProcessId: UUID! ): LeadTypeEntity } """Paginated list of LeadType records.""" type LeadTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [LeadTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `LeadTypeEntity` and its cursor.""" type LeadTypeEntityEdge { """The item at the end of the edge""" node: LeadTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for MasterRight records.""" type MasterRightRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): MasterRightEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [MasterRightEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: MasterRightFilterInput """Sorting of the returned records.""" orderBy: [MasterRightOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [MasterRightEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: MasterRightFilterInput """Sorting of the returned records.""" orderBy: [MasterRightOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MasterRightEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of MasterRight records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input MasterRightOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. """ accessAccountRelationTypes: OrderByEnum """ Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. """ accessAccounts: OrderByEnum """ Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. """ accessAiAutomatizer: OrderByEnum """ Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. """ accessAiOnlineForms: OrderByEnum """ Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. """ accessAiRecordDetail: OrderByEnum """ Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. """ accessAiRecordEnrichment: OrderByEnum """ Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. """ accessAiRelationshipCharts: OrderByEnum """ Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. """ accessAiReports: OrderByEnum """ Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. """ accessAiSmartField: OrderByEnum """ Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. """ accessAppointmentScheduler: OrderByEnum """ Allows users with this role to manage appointment schedules of other users. """ accessAppointmentSchedulerManagement: OrderByEnum """ Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. """ accessApprovalProcesses: OrderByEnum """ Allows users with this role to manage approval processes owned by other users. """ accessApprovalProcessesManagement: OrderByEnum """ Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. """ accessApprovals: OrderByEnum """ Allows users with this role to open the Archive screens listing lost, closed and archived records. """ accessArchive: OrderByEnum """Allows users with this role to open the Audit screen.""" accessAudit: OrderByEnum """ Allows users with this role to view the audit log of changes made in the space. """ accessAuditLog: OrderByEnum """ Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. """ accessBottomMenuCustomization: OrderByEnum """ Allows users with this role to update many records at once with bulk update. """ accessBulkUpdate: OrderByEnum """ Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. """ accessCalling: OrderByEnum """ Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessCallingCompanyPhone: OrderByEnum """ Allows users with this role to purchase and manage company phone numbers for the calling integration. """ accessCallingPurchasePhone: OrderByEnum """ Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). """ accessCompanyEmails: OrderByEnum """ Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. """ accessContacts: OrderByEnum """ Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. """ accessDocumentManagement: OrderByEnum """ Allows users with this role to manage company documents and folders that are not tied to a record. """ accessDocumentManagementCompany: OrderByEnum """ Allows users with this role to create and edit the document folders used for records. """ accessDocumentManagementRecord: OrderByEnum """ Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. """ accessDuplicateChecker: OrderByEnum """ When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. """ accessEmailNotificationEnforcement: OrderByEnum """ Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. """ accessEntityAccount: OrderByEnum """Allows users with this role to create copies of existing accounts.""" accessEntityAccountCopy: OrderByEnum """Allows users with this role to delete accounts they can edit.""" accessEntityAccountDelete: OrderByEnum """ Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAccountDirection: OrderByEnum """ Allows users with this role to own private accounts, which are visible only to their owner. """ accessEntityAccountPrivate: OrderByEnum """Allows users with this role to create new tags for accounts.""" accessEntityAccountTagCreate: OrderByEnum """ Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. """ accessEntityAppointment: OrderByEnum """Allows users with this role to delete appointments they can edit.""" accessEntityAppointmentDelete: OrderByEnum """ Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAppointmentDirection: OrderByEnum """Allows users with this role to create new tags for appointments.""" accessEntityAppointmentTagCreate: OrderByEnum """ Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityBetterNavigator: OrderByEnum """ Allows users with this role to delete Navigator screen layouts owned by other users. """ accessEntityBetterNavigatorDeleteNotOwned: OrderByEnum """ Allows users with this role to delete Navigator screen layouts they own. """ accessEntityBetterNavigatorDeleteOwned: OrderByEnum """ Allows users with this role to share their Navigator screen layouts with selected users and sales units. """ accessEntityBetterNavigatorSharingCustom: OrderByEnum """ Allows users with this role to share their Navigator screen layouts with all users of the space. """ accessEntityBetterNavigatorSharingPublic: OrderByEnum """ Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. """ accessEntityContact: OrderByEnum """Allows users with this role to create copies of existing contacts.""" accessEntityContactCopy: OrderByEnum """Allows users with this role to delete contacts they can edit.""" accessEntityContactDelete: OrderByEnum """ Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityContactDirection: OrderByEnum """ Allows users with this role to own private contacts, which are visible only to their owner. """ accessEntityContactPrivate: OrderByEnum """Allows users with this role to create new tags for contacts.""" accessEntityContactTagCreate: OrderByEnum """ Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. """ accessEntityDashboard: OrderByEnum """Allows users with this role to delete dashboards owned by other users.""" accessEntityDashboardDeleteNotOwned: OrderByEnum """Allows users with this role to delete dashboards they own.""" accessEntityDashboardDeleteOwned: OrderByEnum """ Allows users with this role to share their dashboards with selected users and sales units. """ accessEntityDashboardSharingCustom: OrderByEnum """ Allows users with this role to share their dashboards with all users of the space. """ accessEntityDashboardSharingPublic: OrderByEnum """ Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). The Inbox is not affected. """ accessEntityEmailAccessLevel: OrderByEnum """ How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). """ accessEntityEmailContentShareMode: OrderByEnum """ Allows users with this role to delete emails they neither own nor sent. """ accessEntityEmailDeleteNotOwned: OrderByEnum """ Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccounts: OrderByEnum """ Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccountsByDomain: OrderByEnum """ Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToContacts: OrderByEnum """ Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityEmailSequence: OrderByEnum """ Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityEmailTemplate: OrderByEnum """ Allows users with this role to create and delete email template folders. """ accessEntityEmailTemplateCreateDeleteFolder: OrderByEnum """ Allows users with this role to delete email templates owned by other users. """ accessEntityEmailTemplateDeleteNotOwned: OrderByEnum """Allows users with this role to delete email templates they own.""" accessEntityEmailTemplateDeleteOwned: OrderByEnum """ Allows users with this role to share their email templates with selected users and sales units. """ accessEntityEmailTemplateSharingCustom: OrderByEnum """ Allows users with this role to share their email templates with all users of the space. """ accessEntityEmailTemplateSharingPublic: OrderByEnum """ Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityForecast: OrderByEnum """Allows users with this role to delete forecasts owned by other users.""" accessEntityForecastDeleteNotOwned: OrderByEnum """Allows users with this role to delete forecasts they own.""" accessEntityForecastDeleteOwned: OrderByEnum """Allows users with this role to edit forecasts owned by other users.""" accessEntityForecastEditNotOwned: OrderByEnum """ Allows users with this role to share their forecasts with selected users and sales units. """ accessEntityForecastSharingCustom: OrderByEnum """ Allows users with this role to share their forecasts with all users of the space. """ accessEntityForecastSharingPublic: OrderByEnum """ Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityFormView: OrderByEnum """Allows users with this role to delete form views owned by other users.""" accessEntityFormViewDeleteNotOwned: OrderByEnum """Allows users with this role to delete form views they own.""" accessEntityFormViewDeleteOwned: OrderByEnum """ Allows users with this role to share their form views with selected users and sales units. """ accessEntityFormViewSharingCustom: OrderByEnum """ Allows users with this role to share their form views with all users of the space. """ accessEntityFormViewSharingPublic: OrderByEnum """ Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. """ accessEntityLead: OrderByEnum """Allows users with this role to create copies of existing leads.""" accessEntityLeadCopy: OrderByEnum """Allows users with this role to delete leads they can edit.""" accessEntityLeadDelete: OrderByEnum """ Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityLeadDirection: OrderByEnum """ Allows users with this role to own private leads, which are visible only to their owner. """ accessEntityLeadPrivate: OrderByEnum """Allows users with this role to create new tags for leads.""" accessEntityLeadTagCreate: OrderByEnum """ Allows users with this role to create new tags for emails, memos and text messages. """ accessEntityMessageTagCreate: OrderByEnum """ Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. """ accessEntityOppty: OrderByEnum """ Allows users with this role to create copies of existing opportunities. """ accessEntityOpptyCopy: OrderByEnum """Allows users with this role to delete opportunities they can edit.""" accessEntityOpptyDelete: OrderByEnum """ Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityOpptyDirection: OrderByEnum """ Allows users with this role to own private opportunities, which are visible only to their owner. """ accessEntityOpptyPrivate: OrderByEnum """Allows users with this role to create new tags for opportunities.""" accessEntityOpptyTagCreate: OrderByEnum """ Which pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). """ accessEntityPipeline: OrderByEnum """ Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityProcess: OrderByEnum """ Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. """ accessEntityProfile: OrderByEnum """ Allows users with this role to delete screen profiles owned by other users. """ accessEntityProfileDeleteNotOwned: OrderByEnum """Allows users with this role to delete screen profiles they own.""" accessEntityProfileDeleteOwned: OrderByEnum """ Allows users with this role to share their screen profiles with selected users and sales units. """ accessEntityProfileSharingCustom: OrderByEnum """ Allows users with this role to share their screen profiles with all users of the space. """ accessEntityProfileSharingPublic: OrderByEnum """ Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. """ accessEntityProject: OrderByEnum """Allows users with this role to create copies of existing projects.""" accessEntityProjectCopy: OrderByEnum """Allows users with this role to delete projects they can edit.""" accessEntityProjectDelete: OrderByEnum """ Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityProjectDirection: OrderByEnum """ Allows users with this role to own private projects, which are visible only to their owner. """ accessEntityProjectPrivate: OrderByEnum """Allows users with this role to create new tags for projects.""" accessEntityProjectTagCreate: OrderByEnum """ Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. """ accessEntityQuote: OrderByEnum """Allows users with this role to create copies of existing quotes.""" accessEntityQuoteCopy: OrderByEnum """Allows users with this role to delete quotes they can edit.""" accessEntityQuoteDelete: OrderByEnum """ Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityQuoteDirection: OrderByEnum """Allows users with this role to create new tags for quotes.""" accessEntityQuoteTagCreate: OrderByEnum """ Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityReport: OrderByEnum """Allows users with this role to create and delete report folders.""" accessEntityReportCreateDeleteFolder: OrderByEnum """Allows users with this role to delete reports owned by other users.""" accessEntityReportDeleteNotOwned: OrderByEnum """Allows users with this role to delete reports they own.""" accessEntityReportDeleteOwned: OrderByEnum """ Allows users with this role to save reports as private, visible only to themselves. """ accessEntityReportPrivate: OrderByEnum """Allows users with this role to schedule reports for regular delivery.""" accessEntityReportScheduleCreate: OrderByEnum """ Allows users with this role to view and manage report schedules of other users. """ accessEntityReportScheduleManagement: OrderByEnum """ Allows users with this role to share their reports with selected users and sales units. """ accessEntityReportSharingCustom: OrderByEnum """ Allows users with this role to share their reports with all users of the space. """ accessEntityReportSharingPublic: OrderByEnum """ Allows users with this role to view and follow solutions, when the feature is enabled for the space. """ accessEntitySolution: OrderByEnum """Allows users with this role to create, edit and delete solutions.""" accessEntitySolutionManagement: OrderByEnum """ Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityTarget: OrderByEnum """Allows users with this role to delete targets owned by other users.""" accessEntityTargetDeleteNotOwned: OrderByEnum """Allows users with this role to delete targets they own.""" accessEntityTargetDeleteOwned: OrderByEnum """ Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. """ accessEntityTask: OrderByEnum """Allows users with this role to delete tasks they can edit.""" accessEntityTaskDelete: OrderByEnum """ Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityTaskDirection: OrderByEnum """Allows users with this role to create new tags for tasks.""" accessEntityTaskTagCreate: OrderByEnum """ Allows users with this role to create tasks without an owner (unassigned tasks). """ accessEntityTaskUnassigned: OrderByEnum """Allows users with this role to export records and reports to files.""" accessExport: OrderByEnum """ Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. """ accessFeeds: OrderByEnum """ Allows users with this role to manage currencies and exchange rate lists in Administration. """ accessForeignCurrencies: OrderByEnum """ Allows users with this role to manage fields, forms, record types, tags and translations in Administration. """ accessFormAndFields: OrderByEnum """ Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. """ accessGlobalSettings: OrderByEnum """Allows users with this role to open the Navigator screen.""" accessHomeScreen: OrderByEnum """Allows users with this role to import records from files.""" accessImport: OrderByEnum """ Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. """ accessInsights: OrderByEnum """ Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. """ accessLeads: OrderByEnum """ Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. """ accessOnlineForms: OrderByEnum """ Allows users with this role to edit and delete online forms owned by other users. """ accessOnlineFormsManagement: OrderByEnum """ Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. """ accessOpportunity: OrderByEnum """ Allows users with this role to manage pipelines, lead processes and quote processes in Administration. """ accessPipelineConfiguration: OrderByEnum """Allows users with this role to print records and reports.""" accessPrint: OrderByEnum """ Allows users with this role to manage products, product categories and price lists in Administration. """ accessProductsServices: OrderByEnum """ Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. """ accessProjects: OrderByEnum """ Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. """ accessQuotes: OrderByEnum """Allows users with this role to manage sales roles in Administration.""" accessSalesRoles: OrderByEnum """ Allows users with this role to manage the security settings of the space in Administration. """ accessSecurity: OrderByEnum """Allows users with this role to manage sales units in Administration.""" accessUnits: OrderByEnum """ Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. """ accessUserAndRoles: OrderByEnum """ Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessWhatsAppCompanyPhone: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of MasterRight records.""" type MasterRightEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MasterRightEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `MasterRightEntity` and its cursor.""" type MasterRightEntityEdge { """The item at the end of the edge""" node: MasterRightEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Media records.""" type MediaRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): MediaEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [MediaEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: MediaFilterInput """Sorting of the returned records.""" orderBy: [MediaOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [MediaEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: MediaFilterInput """Sorting of the returned records.""" orderBy: [MediaOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MediaEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of Media records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input MediaOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Appointment this media is attached to. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Task this media is attached to. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Call this media belongs to (e.g. a recording or transcription). Sorts by fields of the related record, listed in order of priority. """ call: [CallOrderByNestedInput!] """ Id of the linked appointment or task, or empty when not linked to an activity. """ activityId: OrderByEnum """Id of the linked call, or empty when not linked.""" callId: OrderByEnum """Free-text description of the media.""" description: OrderByEnum """ Error code reported by the calling/recording provider when processing failed; empty on success. """ errorCode: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Media records.""" type MediaEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MediaEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `MediaEntity` and its cursor.""" type MediaEntityEdge { """The item at the end of the edge""" node: MediaEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Memo records.""" type MemoRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): MemoEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [MemoEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: MemoFilterInput """Sorting of the returned records.""" orderBy: [MemoOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [MemoEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: MemoFilterInput """Sorting of the returned records.""" orderBy: [MemoOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MemoEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of Memo records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input MemoOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who authored the memo. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """Id of the memo author.""" ownerId: OrderByEnum """Short summary line of the memo.""" subject: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Memo records.""" type MemoEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [MemoEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `MemoEntity` and its cursor.""" type MemoEntityEdge { """The item at the end of the edge""" node: MemoEntity """A cursor for use in pagination""" cursor: String! } """Read operations for MemoComment records.""" type MemoCommentRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): MemoCommentEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [MemoCommentEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: MemoCommentFilterInput """Sorting of the returned records.""" orderBy: [MemoCommentOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [MemoCommentEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: MemoCommentFilterInput """Sorting of the returned records.""" orderBy: [MemoCommentOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MemoCommentEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for MessageRelation records.""" type MessageRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): MessageRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [MessageRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: MessageRelationFilterInput """Sorting of the returned records.""" orderBy: [MessageRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [MessageRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: MessageRelationFilterInput """Sorting of the returned records.""" orderBy: [MessageRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of MessageRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input MessageRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the message is linked to, or empty when not linked to an account. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Contact the message is linked to, or empty when not linked to a contact. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record the message is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Lead the message is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the message is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Email side of the link. Set when messageId resolves to an Email; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Memo side of the link. Set when messageId resolves to a Memo; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ memo: [MemoOrderByNestedInput!] """ Project the message is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote the message is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked custom entity record.""" customEntityId: OrderByEnum """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: OrderByEnum """Id of the email or memo on this link.""" messageId: OrderByEnum """Id of the linked project.""" projectId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for MessageSharingClientRelation records.""" type MessageSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): MessageSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [MessageSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: MessageSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [MessageSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [MessageSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: MessageSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [MessageSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of MessageSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input MessageSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the message is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Email being shared. Set when messageId resolves to an Email; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Memo being shared. Set when messageId resolves to a Memo; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ memo: [MemoOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the email or memo being shared.""" messageId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for MessageSharingSalesUnitRelation records.""" type MessageSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): MessageSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [MessageSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: MessageSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [MessageSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [MessageSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: MessageSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [MessageSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): MessageSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of MessageSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input MessageSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Email being shared. Set when messageId resolves to an Email; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Memo being shared. Set when messageId resolves to a Memo; otherwise empty. Sorts by fields of the related record, listed in order of priority. """ memo: [MemoOrderByNestedInput!] """ Sales unit the message is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the email or memo being shared.""" messageId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for Note records.""" type NoteRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): NoteEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [NoteEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: NoteFilterInput """Sorting of the returned records.""" orderBy: [NoteOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [NoteEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: NoteFilterInput """Sorting of the returned records.""" orderBy: [NoteOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): NoteEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of Note records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input NoteOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the note is attached to. Exactly one of account / contact / leadOppty / project / quote / customEntity must be set. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Contact the note is attached to. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record the note is attached to. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Lead the note is attached to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the note is attached to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ User who authored the note. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Project the note is attached to. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote the note is attached to. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the account the note is attached to.""" accountId: OrderByEnum """Id of the contact the note is attached to.""" contactId: OrderByEnum """Id of the custom entity record the note is attached to.""" customEntityId: OrderByEnum """Id of the lead or opportunity the note is attached to.""" leadOpptyId: OrderByEnum """Free-form text body of the note (sanitized HTML allowed).""" note: OrderByEnum """Id of the note author.""" ownerId: OrderByEnum """Id of the project the note is attached to.""" projectId: OrderByEnum """Id of the quote the note is attached to.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Note records.""" type NoteEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [NoteEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `NoteEntity` and its cursor.""" type NoteEntityEdge { """The item at the end of the edge""" node: NoteEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OnlineForm records.""" type OnlineFormRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OnlineFormEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OnlineFormEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OnlineFormFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OnlineFormEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OnlineFormFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Exports the submission log of an online form to a zipped text file and returns a URL to download it. """ getDownloadUrl( """Id of the online form.""" onlineFormType: UUID! """Name of the export, used for the file name.""" name: String! """Conditions the exported submissions must meet.""" filter: OnlineFormFilterInput """When set, only submissions created in the last N days are exported.""" days: Int ): String! } """Read operations for OnlineFormActivityLogLine records.""" type OnlineFormActivityLogLineRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OnlineFormActivityLogLineEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OnlineFormActivityLogLineEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OnlineFormActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OnlineFormActivityLogLineEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OnlineFormActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormActivityLogLineEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for OnlineFormDataExRelation records.""" type OnlineFormDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OnlineFormDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OnlineFormDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OnlineFormDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OnlineFormDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OnlineFormDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Option selected in a multi-select checkbox field of an online form submission. """ type OnlineFormDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Online form submission on which the option is selected.""" onlineForm: OnlineFormEntity """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the online form submission.""" onlineFormId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for OnlineFormDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OnlineFormDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OnlineFormDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OnlineFormDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: OnlineFormDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Id of the online form submission.""" onlineFormId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput """ Online form submission on which the option is selected. Matches records where a related record meets these conditions. """ onlineForm: OnlineFormFilterInput } """ Sorting of OnlineFormDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OnlineFormDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """ Online form submission on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ onlineForm: [OnlineFormOrderByNestedInput!] """Id of the selected option.""" dataId: OrderByEnum """Id of the online form submission.""" onlineFormId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OnlineFormDataExRelation records.""" type OnlineFormDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OnlineFormDataExRelationEntity` and its cursor. """ type OnlineFormDataExRelationEntityEdge { """The item at the end of the edge""" node: OnlineFormDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OnlineFormRelation records.""" type OnlineFormRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OnlineFormRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OnlineFormRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OnlineFormRelationFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OnlineFormRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OnlineFormRelationFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of OnlineFormRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OnlineFormRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Contact the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Lead the submission is linked to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the submission is linked to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Online form submission being linked. Sorts by fields of the related record, listed in order of priority. """ onlineForm: [OnlineFormOrderByNestedInput!] """ Project the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked custom entity record.""" customEntityId: OrderByEnum """ True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType. """ isPrimary: OrderByEnum """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: OrderByEnum """Id of the submission.""" onlineFormId: OrderByEnum """Id of the linked project.""" projectId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for OnlineFormStyle records.""" type OnlineFormStyleRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OnlineFormStyleEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OnlineFormStyleEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OnlineFormStyleFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormStyleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OnlineFormStyleEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OnlineFormStyleFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormStyleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormStyleEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of OnlineFormStyle records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OnlineFormStyleOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OnlineFormStyle records.""" type OnlineFormStyleEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormStyleEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OnlineFormStyleEntity` and its cursor.""" type OnlineFormStyleEntityEdge { """The item at the end of the edge""" node: OnlineFormStyleEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OnlineFormType records.""" type OnlineFormTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OnlineFormTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OnlineFormTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OnlineFormTypeFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OnlineFormTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OnlineFormTypeFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of online forms filtered by owner, enabled state and status, in addition to the regular filter. """ getByOnlineFormTypeCriteria( """Owner, active/inactive and status filters applied to the list.""" listingOptions: OnlineFormTypeTabDataGridViewOptionsParams! """Conditions the returned records must meet.""" filter: OnlineFormTypeFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormTypeOrderByInput!] """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormTypeEntityConnection } """ Sorting of OnlineFormType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OnlineFormTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the online form. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Visual style applied to the form when rendered. Sorts by fields of the related record, listed in order of priority. """ style: [OnlineFormStyleOrderByNestedInput!] """ When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. """ autoPrefillWithJavascript: OrderByEnum """Free-text description shown alongside the form definition in the UI.""" description: OrderByEnum """ API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. """ entityApiName: OrderByEnum """ When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. """ isEnabled: OrderByEnum """ True when the form is system-managed and its schema cannot be edited by users. """ isReadonly: OrderByEnum """Timestamp of the most recent change to formEdit (form schema).""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled.""" lastStatusChange: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Id of the form style.""" styleId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Minimum response count required for the form to be considered "responsive" in reports and notifications. Empty when no threshold is configured. """ responseAcceptanceThreshold: OrderByEnum """Total number of times the form link has been delivered to recipients.""" sentCount: OrderByEnum """Number of distinct recipients the form link has been delivered to.""" sentUniqueCount: OrderByEnum """Total number of submissions (responses) recorded for the form.""" responseCount: OrderByEnum """Fraction (0–1) of unique recipients who submitted a response.""" responseRate: OrderByEnum """ Timestamp of the most recent submission. Empty when the form has no responses. """ lastResponseDate: OrderByEnum """ Name or email address of the respondent on the most recent submission. Empty when the form has no responses or the respondent could not be identified. """ lastResponseBy: OrderByEnum """ Names of the solutions whose canvas contains this form, in name order. Empty when the form is on no solution canvas. """ solutions: OrderByEnum """ Overall state of the form: Inactive while it has no active configuration, Active while accepting responses, Completed once the configured end condition is met. """ status: OrderByEnum } """ Sorting by a field of the related OnlineFormStyle record. Set exactly one field in each item. """ input OnlineFormStyleOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OnlineFormType records.""" type OnlineFormTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OnlineFormTypeEntity` and its cursor.""" type OnlineFormTypeEntityEdge { """The item at the end of the edge""" node: OnlineFormTypeEntity """A cursor for use in pagination""" cursor: String! } """ Filters for listing online form types by owner, active state and status. """ input OnlineFormTypeTabDataGridViewOptionsParams { """ Ids of the owners whose records are listed; null or an empty list turns the owner filter off. """ filterByOwnerId: [ID!] """ When true, the list includes active records. When both showActive and showInactive are false, the list is not filtered by state. """ showActive: Boolean! = true """When true, the list includes inactive records; see showActive.""" showInactive: Boolean! = true """ Statuses to include, such as Ok, Warning or Error; null or an empty list turns the status filter off. Ignored when both showActive and showInactive are false. """ filterByStatus: [ProcessStatusEnum!] } """Read operations for OnlineFormTypeEmailRelation records.""" type OnlineFormTypeEmailRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OnlineFormTypeEmailRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OnlineFormTypeEmailRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OnlineFormTypeEmailRelationFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormTypeEmailRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OnlineFormTypeEmailRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OnlineFormTypeEmailRelationFilterInput """Sorting of the returned records.""" orderBy: [OnlineFormTypeEmailRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OnlineFormTypeEmailRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Email that sent an online form link to a recipient, with the record it was sent on. """ type OnlineFormTypeEmailRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account the email recipient belongs to, when applicable.""" account: AccountEntity """Contact the email was addressed to, when applicable.""" contact: ContactEntity """Custom entity record the form was sent on, when applicable.""" customEntity: CustomEntityEntity """Email message used to deliver the form link to the recipient.""" email: EmailEntity """Lead the form was sent on. Set when leadOpptyId resolves to a Lead.""" lead: LeadEntity """ Opportunity the form was sent on. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """Online form being shared with the recipient via email.""" onlineFormType: OnlineFormTypeEntity """Quote the form was sent on, when applicable.""" quote: QuoteEntity """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the email message.""" emailId: ID! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the online form whose link the email delivers to the recipient.""" onlineFormTypeId: ID! """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for OnlineFormTypeEmailRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OnlineFormTypeEmailRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OnlineFormTypeEmailRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OnlineFormTypeEmailRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: OnlineFormTypeEmailRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the linked account.""" accountId: EntityFilterStringField """Id of the linked contact.""" contactId: EntityFilterStringField """Id of the linked custom entity record.""" customEntityId: EntityFilterStringField """Id of the email message.""" emailId: EntityFilterStringField """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: EntityFilterStringField """Id of the online form whose link the email delivers to the recipient.""" onlineFormTypeId: EntityFilterStringField """Id of the linked quote.""" quoteId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account the email recipient belongs to, when applicable. Matches records where a related record meets these conditions. """ account: AccountFilterInput """ Contact the email was addressed to, when applicable. Matches records where a related record meets these conditions. """ contact: ContactFilterInput """ Custom entity record the form was sent on, when applicable. Matches records where a related record meets these conditions. """ customEntity: CustomEntityFilterInput """ Email message used to deliver the form link to the recipient. Matches records where a related record meets these conditions. """ email: EmailFilterInput """ Lead the form was sent on. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity the form was sent on. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Online form being shared with the recipient via email. Matches records where a related record meets these conditions. """ onlineFormType: OnlineFormTypeFilterInput """ Quote the form was sent on, when applicable. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Sorting of OnlineFormTypeEmailRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OnlineFormTypeEmailRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the email recipient belongs to, when applicable. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Contact the email was addressed to, when applicable. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record the form was sent on, when applicable. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Email message used to deliver the form link to the recipient. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Lead the form was sent on. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the form was sent on. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Online form being shared with the recipient via email. Sorts by fields of the related record, listed in order of priority. """ onlineFormType: [OnlineFormTypeOrderByNestedInput!] """ Quote the form was sent on, when applicable. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked custom entity record.""" customEntityId: OrderByEnum """Id of the email message.""" emailId: OrderByEnum """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: OrderByEnum """Id of the online form whose link the email delivers to the recipient.""" onlineFormTypeId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OnlineFormTypeEmailRelation records.""" type OnlineFormTypeEmailRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OnlineFormTypeEmailRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OnlineFormTypeEmailRelationEntity` and its cursor. """ type OnlineFormTypeEmailRelationEntityEdge { """The item at the end of the edge""" node: OnlineFormTypeEmailRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Opportunity records.""" type OpportunityRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpportunityEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpportunityEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpportunityFilterInput """Sorting of the returned records.""" orderBy: [OpportunityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpportunityEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpportunityFilterInput """Sorting of the returned records.""" orderBy: [OpportunityOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpportunityEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpportunityEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): OpportunityEntity! """ Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. """ aiAutoPrefill( """ Id of the suggested action, as returned by the AI record suggestions or AI chat. """ actionId: String! ): OpportunityAutoPrefill! } """Paginated list of Opportunity records.""" type OpportunityEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpportunityEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OpportunityEntity` and its cursor.""" type OpportunityEntityEdge { """The item at the end of the edge""" node: OpportunityEntity """A cursor for use in pagination""" cursor: String! } """ New, unsaved opportunity pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in. """ type OpportunityAutoPrefill { """New opportunity carrying the pre-filled values; it is not saved.""" entity: OpportunityEntity """Ids of the fields that were filled in.""" fieldIds: [UUID!]! } """Read operations for OpportunityType records.""" type OpportunityTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpportunityTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpportunityTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpportunityTypeFilterInput """Sorting of the returned records.""" orderBy: [OpportunityTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpportunityTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpportunityTypeFilterInput """Sorting of the returned records.""" orderBy: [OpportunityTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpportunityTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpportunityTypeFilterInput """Sorting of the returned records.""" orderBy: [OpportunityTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpportunityTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: OpportunityTypeFilterInput """Sorting of the returned records.""" orderBy: [OpportunityTypeOrderByInput!] ): [OpportunityTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): OpportunityTypeEntity! """ Returns the opportunity type that uses the given pipeline, or null when none does. """ getByPipeline( """Id of the pipeline.""" pipelineId: UUID! ): OpportunityTypeEntity } """ Sorting of OpportunityType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpportunityTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Pipeline this opportunity type drives. Each opportunity type maps to exactly one pipeline. Sorts by fields of the related record, listed in order of priority. """ pipeline: [PipelineOrderByNestedInput!] """ True when the opportunity type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the pipeline this opportunity type drives.""" pipelineId: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OpportunityType records.""" type OpportunityTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpportunityTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OpportunityTypeEntity` and its cursor.""" type OpportunityTypeEntityEdge { """The item at the end of the edge""" node: OpportunityTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OpptyProductRelation records.""" type OpptyProductRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyProductRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyProductRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyProductRelationFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyProductRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyProductRelationFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString } """ Sorting of OpptyProductRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyProductRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. Sorts by fields of the related record, listed in order of priority. """ currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!] """ Online form field that produced this line item, or empty when not applicable. Sorts by fields of the related record, listed in order of priority. """ onlineFormField: [FieldOrderByNestedInput!] """ Online form this line item came from when the related opportunity was created through a form submission, or empty otherwise. Sorts by fields of the related record, listed in order of priority. """ onlineForm: [OnlineFormOrderByNestedInput!] """ Opportunity this line item belongs to. Set on create; mutually exclusive with quote. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Line-item type that drives the form layout for this product line. Resolved from the product type on create. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelationType: [OpptyProductRelationTypeOrderByNestedInput!] """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. Sorts by fields of the related record, listed in order of priority. """ pairedOpptyProductRelation: [OpptyProductRelationOrderByNestedInput!] """ Product on this line item. Set on create; cannot be changed afterwards. Sorts by fields of the related record, listed in order of priority. """ product: [ProductOrderByNestedInput!] """ Quote this line item belongs to. Set on create; mutually exclusive with opportunity. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Total amount of the line item (price * quantity, with discounts applied). """ amount: OrderByEnum """Free-form note describing this line item.""" comment: OrderByEnum """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: OrderByEnum """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: OrderByEnum """ Id of the online form submission this line item came from, or empty when it was not created through a form. """ onlineFormId: OrderByEnum """Id of the opportunity.""" opptyId: OrderByEnum """Id of the line-item type.""" opptyProductRelationTypeId: OrderByEnum """Id of the paired line item.""" pairedOpptyProductRelationId: OrderByEnum """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: OrderByEnum """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: OrderByEnum """Number of product units on this line item.""" quantity: OrderByEnum """ Id of the quote this line item belongs to. Mutually exclusive with opptyId. """ quoteId: OrderByEnum """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. Sorts by fields of the related record, listed in order of priority. """ revenueSchedule: [OpptyProductRelationRevenueScheduleOrderByNestedInput!] """ Absolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountValue: OrderByEnum """ Percentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera. """ discountPercentage: OrderByEnum """Sorts by a custom field.""" withCustom: CommonEntityRepositoryOrderByCustomField } """ Sorting by a field of the related OpptyProductRelationType record. Set exactly one field in each item. """ input OpptyProductRelationTypeOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the line-item type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for OpptyProductRelationDataExRelation records.""" type OpptyProductRelationDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyProductRelationDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyProductRelationDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyProductRelationDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyProductRelationDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyProductRelationDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Option selected in a multi-select checkbox field of a product line item. """ type OpptyProductRelationDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Product line item on which the option is selected.""" opptyProductRelation: OpptyProductRelationEntity """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the product line item.""" opptyProductRelationId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for OpptyProductRelationDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input OpptyProductRelationDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [OpptyProductRelationDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [OpptyProductRelationDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: OpptyProductRelationDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Id of the product line item.""" opptyProductRelationId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput """ Product line item on which the option is selected. Matches records where a related record meets these conditions. """ opptyProductRelation: OpptyProductRelationFilterInput } """ Sorting of OpptyProductRelationDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyProductRelationDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """ Product line item on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelation: [OpptyProductRelationOrderByNestedInput!] """Id of the selected option.""" dataId: OrderByEnum """Id of the product line item.""" opptyProductRelationId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OpptyProductRelationDataExRelation records.""" type OpptyProductRelationDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyProductRelationDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OpptyProductRelationDataExRelationEntity` and its cursor. """ type OpptyProductRelationDataExRelationEntityEdge { """The item at the end of the edge""" node: OpptyProductRelationDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OpptyProductRelationRevenueSchedule records.""" type OpptyProductRelationRevenueScheduleRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyProductRelationRevenueScheduleEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyProductRelationRevenueScheduleEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyProductRelationRevenueScheduleFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationRevenueScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyProductRelationRevenueScheduleEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyProductRelationRevenueScheduleFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationRevenueScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationRevenueScheduleEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of OpptyProductRelationRevenueSchedule records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyProductRelationRevenueScheduleOrderByInput { """Unique identifier of entity. Must match with OpptyProductRelation id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: OrderByEnum """Number of periods the line-item amount is split into.""" periodCount: OrderByEnum """Date when revenue recognition for this product line begins.""" startDate: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OpptyProductRelationRevenueSchedule records.""" type OpptyProductRelationRevenueScheduleEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyProductRelationRevenueScheduleEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OpptyProductRelationRevenueScheduleEntity` and its cursor. """ type OpptyProductRelationRevenueScheduleEntityEdge { """The item at the end of the edge""" node: OpptyProductRelationRevenueScheduleEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OpptyProductRelationRevenueSchedulePeriod records.""" type OpptyProductRelationRevenueSchedulePeriodRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyProductRelationRevenueSchedulePeriodEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyProductRelationRevenueSchedulePeriodEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyProductRelationRevenueSchedulePeriodFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationRevenueSchedulePeriodOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyProductRelationRevenueSchedulePeriodEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyProductRelationRevenueSchedulePeriodFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationRevenueSchedulePeriodOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationRevenueSchedulePeriodEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for OpptyProductRelationType records.""" type OpptyProductRelationTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyProductRelationTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyProductRelationTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyProductRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyProductRelationTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyProductRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyProductRelationTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyProductRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyProductRelationTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: OpptyProductRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [OpptyProductRelationTypeOrderByInput!] ): [OpptyProductRelationTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): OpptyProductRelationTypeEntity! } """ Sorting of OpptyProductRelationType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyProductRelationTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ True when the line-item type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ Product type paired with this line-item type. Sorts by fields of the related record, listed in order of priority. """ productType: [ProductTypeOrderByNestedInput!] } """Paginated list of OpptyProductRelationType records.""" type OpptyProductRelationTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyProductRelationTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `OpptyProductRelationTypeEntity` and its cursor. """ type OpptyProductRelationTypeEntityEdge { """The item at the end of the edge""" node: OpptyProductRelationTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OpptyRecurrence records.""" type OpptyRecurrenceRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyRecurrenceEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyRecurrenceEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyRecurrenceFilterInput """Sorting of the returned records.""" orderBy: [OpptyRecurrenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyRecurrenceEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyRecurrenceFilterInput """Sorting of the returned records.""" orderBy: [OpptyRecurrenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyRecurrenceEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of OpptyRecurrence records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyRecurrenceOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Opportunity this recurrence belongs to. Each recurrence is bound to exactly one opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Pipeline step that newly generated opportunities are placed in. Sorts by fields of the related record, listed in order of priority. """ step: [StepOrderByNestedInput!] "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: OrderByEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: OrderByEnum """ Date information. The last date when no more other items should be created. """ endDate: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: OrderByEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: OrderByEnum """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: OrderByEnum """Id of the parent opportunity.""" opptyId: OrderByEnum """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: OrderByEnum """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: OrderByEnum """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OpptyRecurrence records.""" type OpptyRecurrenceEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyRecurrenceEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OpptyRecurrenceEntity` and its cursor.""" type OpptyRecurrenceEntityEdge { """The item at the end of the edge""" node: OpptyRecurrenceEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OpptyRevenueSchedule records.""" type OpptyRevenueScheduleRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyRevenueScheduleEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyRevenueScheduleEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyRevenueScheduleFilterInput """Sorting of the returned records.""" orderBy: [OpptyRevenueScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyRevenueScheduleEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyRevenueScheduleFilterInput """Sorting of the returned records.""" orderBy: [OpptyRevenueScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyRevenueScheduleEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of OpptyRevenueSchedule records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input OpptyRevenueScheduleOrderByInput { """Unique identifier of entity. Must match with Opportunity id.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: OrderByEnum """Number of periods the opportunity value is split into.""" periodCount: OrderByEnum """Date when revenue recognition for the opportunity begins.""" startDate: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of OpptyRevenueSchedule records.""" type OpptyRevenueScheduleEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [OpptyRevenueScheduleEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `OpptyRevenueScheduleEntity` and its cursor.""" type OpptyRevenueScheduleEntityEdge { """The item at the end of the edge""" node: OpptyRevenueScheduleEntity """A cursor for use in pagination""" cursor: String! } """Read operations for OpptyRevenueSchedulePeriod records.""" type OpptyRevenueSchedulePeriodRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): OpptyRevenueSchedulePeriodEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [OpptyRevenueSchedulePeriodEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: OpptyRevenueSchedulePeriodFilterInput """Sorting of the returned records.""" orderBy: [OpptyRevenueSchedulePeriodOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [OpptyRevenueSchedulePeriodEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: OpptyRevenueSchedulePeriodFilterInput """Sorting of the returned records.""" orderBy: [OpptyRevenueSchedulePeriodOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): OpptyRevenueSchedulePeriodEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for ParentAccountRelationType records.""" type ParentAccountRelationTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ParentAccountRelationTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ParentAccountRelationTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ParentAccountRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [ParentAccountRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ParentAccountRelationTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ParentAccountRelationTypeFilterInput """Sorting of the returned records.""" orderBy: [ParentAccountRelationTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ParentAccountRelationTypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ParentAccountRelationType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ParentAccountRelationTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). """ childLabel: OrderByEnum """ Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). """ parentLabel: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ParentAccountRelationType records.""" type ParentAccountRelationTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ParentAccountRelationTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ParentAccountRelationTypeEntity` and its cursor. """ type ParentAccountRelationTypeEntityEdge { """The item at the end of the edge""" node: ParentAccountRelationTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Phone records.""" type PhoneRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): PhoneEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [PhoneEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: PhoneFilterInput """Sorting of the returned records.""" orderBy: [PhoneOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [PhoneEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: PhoneFilterInput """Sorting of the returned records.""" orderBy: [PhoneOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): PhoneEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns all phone numbers of the space, including other users' numbers, for administration. """ getAllForAdmin( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: PhoneFilterInput """Sorting of the returned records.""" orderBy: [PhoneOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [PhoneEntity!]! """ Returns the recipients from the given list who have unsubscribed from text messages, so they can be removed before sending. """ checkForUnsubscribed( """Text message recipients to check.""" recipients: [SendTextMessageRecipientParams!]! ): [SendTextMessageRecipient!]! } """Paginated list of Phone records.""" type PhoneEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [PhoneEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `PhoneEntity` and its cursor.""" type PhoneEntityEdge { """The item at the end of the edge""" node: PhoneEntity """A cursor for use in pagination""" cursor: String! } """ Recipient of a text message: the phone number and the records whose data fill its placeholders. """ type SendTextMessageRecipient { """ Which of the given records, such as the Contact or the Account, the message is primarily addressed to. """ primary: EntityLacotaType """Opportunity whose data fills the opportunity placeholders.""" opportunityId: UUID """Contact whose data fills the contact placeholders.""" contactId: UUID """Account whose data fills the account placeholders.""" accountId: UUID """Lead whose data fills the lead placeholders.""" leadId: UUID """Project whose data fills the project placeholders.""" projectId: UUID """Quote whose data fills the quote placeholders.""" quoteId: UUID """ Custom entity records whose data fill the custom entity placeholders, each given as a `CustomEntityID`. """ customEntityIds: [CustomEntityID] """Phone number the text message is sent to.""" phoneNumber: String! } """ Recipient of a text message: the phone number and the records whose data fill its placeholders. """ input SendTextMessageRecipientParams { """ Which of the given records, such as the Contact or the Account, the message is primarily addressed to. """ primary: EntityLacotaType """Opportunity whose data fills the opportunity placeholders.""" opportunityId: UUID """Contact whose data fills the contact placeholders.""" contactId: UUID """Account whose data fills the account placeholders.""" accountId: UUID """Lead whose data fills the lead placeholders.""" leadId: UUID """Project whose data fills the project placeholders.""" projectId: UUID """Quote whose data fills the quote placeholders.""" quoteId: UUID """ Custom entity records whose data fill the custom entity placeholders, each given as a `CustomEntityID`. """ customEntityIds: [CustomEntityIDParams] """Phone number the text message is sent to.""" phoneNumber: String! } """Read operations for Pipeline records.""" type PipelineRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): PipelineEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [PipelineEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: PipelineFilterInput """Sorting of the returned records.""" orderBy: [PipelineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [PipelineEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: PipelineFilterInput """Sorting of the returned records.""" orderBy: [PipelineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): PipelineEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns the default pipeline of the space.""" getDefaultPipeline: PipelineEntity! } """Paginated list of Pipeline records.""" type PipelineEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [PipelineEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `PipelineEntity` and its cursor.""" type PipelineEntityEdge { """The item at the end of the edge""" node: PipelineEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Process records.""" type ProcessRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProcessEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProcessEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProcessFilterInput """Sorting of the returned records.""" orderBy: [ProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProcessEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProcessFilterInput """Sorting of the returned records.""" orderBy: [ProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns how many runs of the process succeeded, ended with a warning or failed, bucketed by hour for the last 24 hours or by day for the last 7 or 14 days, in the user's time zone. Buckets without runs are included with zero counts. """ getActivityTimeline( """Id of the process.""" entityId: ID! """Time range of the timeline.""" interval: LastActivityInterval! ): ProcessTimelineResult! """ Returns a page of processes filtered by owner, enabled state, status and tags, in addition to the regular filter. """ getByProcessCriteria( """Owner, active/inactive, status and tag filters applied to the list.""" listingOptions: ProcessTabDataGridViewOptionsParams! """Conditions the returned records must meet.""" filter: ProcessFilterInput """Sorting of the returned records.""" orderBy: [ProcessOrderByInput!] """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessEntityConnection """ Returns the processes that have actions scheduled to run later for any of the selected records. """ getProcessesWithScheduledActions( """Selection of records: explicit ids, a list result, and ids to exclude.""" bulkFilter: BulkOperationInput! ): [ProcessEntity!]! """ Returns the processes that start the given process from one of their steps. """ getTriggeringProcesses( """Id of the triggered process.""" processId: UUID! ): [ProcessEntity!]! """ Returns the most recent process runs that involved the record, either because the record triggered the process or because a process action created or changed it, newest first. """ getRecentExecutions( """Id of the record.""" entityId: UUID! """Type of the record.""" entityName: EntityNameEnum! """Maximum number of records to return.""" limit: Int! ): [RecentExecutionItem!]! """ Returns processes with a manual trigger that the current user is allowed to start, according to each trigger's allowed users and units. """ getProcessesWithManualTrigger( """ Maximum number of records to return. Limit and offset are applied before the allowed users and units are checked, so a page can hold fewer records. """ limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProcessFilterInput """Sorting of the returned records.""" orderBy: [ProcessOrderByInput!] ): [ProcessEntity!]! """ Converts process definitions into human-readable text descriptions, one per input, in the same order. An empty definition gives an empty string and an invalid one gives the text "error". """ convertProcessSchemasToDescriptions( """ Process definitions as JSON strings, each conforming to the ProcessSchema type. """ schemas: [String!]! ): [String!]! } """ Sorting of Process records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProcessOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the process. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Why the process is disabled: turned off by a user, suspended after repeated failed runs, or suspended because Automatizer was switched off for the space. NoReason while enabled; read-only. """ deactivationReason: OrderByEnum """Free-text description shown alongside the process.""" description: OrderByEnum """ When true, the process actively responds to its trigger; when false, the process is paused. Toggle via enable/disable mutations. """ isEnabled: OrderByEnum """Timestamp of the most recent change to settings.""" lastSchemaChange: OrderByEnum """Timestamp of the most recent change to isEnabled.""" lastStatusChange: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. """ type: OrderByEnum """ Timestamp of the most recent execution of this process. Empty when never run. """ lastProcessRun: OrderByEnum """ Names of the solutions whose canvas contains this process, in name order. Empty when the process is on no solution canvas. """ solutions: OrderByEnum """ Overall status of the process, derived from its most recent runs since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are no runs. """ status: OrderByEnum """ For record-triggered processes, the event that starts the process: Create, Update, CreateOrUpdate or Delete, or EmailSent / EmailReceived for email-triggered processes. Empty for other trigger types. """ recordTriggerEvent: OrderByEnum """ What starts the process: a record event (ProcessRecordTrigger), a schedule (ProcessScheduleTrigger), a user on selected records (ProcessManualTrigger) or an online form submission (ProcessOnlineFormTrigger). """ triggerType: OrderByEnum """ For record-based triggers, the entity whose records fire the process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: OrderByEnum """ API name of the trigger entity (useful for custom entities where this differs from triggerEntityName). Empty for non-record triggers. """ triggerEntityApiName: OrderByEnum } """Paginated list of Process records.""" type ProcessEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProcessEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProcessEntity` and its cursor.""" type ProcessEntityEdge { """The item at the end of the edge""" node: ProcessEntity """A cursor for use in pagination""" cursor: String! } """Period covered by an automation process's activity timeline.""" enum LastActivityInterval { """Last 24 hours, grouped by hour.""" Last24hours """Last 7 days, grouped by day.""" Last7days """Last 14 days, grouped by day.""" Last14days } """Recent process run that involved a record.""" type RecentExecutionItem { """True when the current user can open the process.""" hasAccess: Boolean! """Id of the process that ran.""" id: UUID! """Link to the process in the Coevera web app.""" url: String! """Name of the process.""" name: String! """Type of the process.""" type: ProcessTypeEnum! """Overall status of the process (not of this run): Ok, Warning or Error.""" status: ProcessStatusEnum! """When the process run started.""" executionDate: DateTime! """Description of the process.""" description: String! } """Read operations for ProcessActivityLog records.""" type ProcessActivityLogRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProcessActivityLogEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProcessActivityLogEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProcessActivityLogFilterInput """Sorting of the returned records.""" orderBy: [ProcessActivityLogOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProcessActivityLogEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProcessActivityLogFilterInput """Sorting of the returned records.""" orderBy: [ProcessActivityLogOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessActivityLogEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Exports the activity log of a process to a zipped text file and returns a URL to download it. """ getDownloadUrl( """Id of the process.""" processId: UUID! """Name of the export, used for the file name.""" name: String! """Conditions the exported log entries must meet.""" filter: ProcessActivityLogFilterInput """When set, only runs started in the last N days are exported.""" days: Int ): String! } """Read operations for ProcessActivityLogLine records.""" type ProcessActivityLogLineRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProcessActivityLogLineEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProcessActivityLogLineEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProcessActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [ProcessActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProcessActivityLogLineEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProcessActivityLogLineFilterInput """Sorting of the returned records.""" orderBy: [ProcessActivityLogLineOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessActivityLogLineEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for ProcessScheduledAction records.""" type ProcessScheduledActionRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProcessScheduledActionEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProcessScheduledActionEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProcessScheduledActionFilterInput """Sorting of the returned records.""" orderBy: [ProcessScheduledActionOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProcessScheduledActionEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProcessScheduledActionFilterInput """Sorting of the returned records.""" orderBy: [ProcessScheduledActionOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessScheduledActionEntityConnection } """ Action of an Automatizer process that is waiting to run for a record at a scheduled time. """ type ProcessScheduledActionEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """ User whose change triggered the process run that scheduled this action. """ actor: ClientEntity """ Id of the user whose change triggered the process run that scheduled this action. """ actorId: ID """ Application through which the change that triggered the process run was made; empty for changes made in Coevera itself. """ application: ApplicationEntity """ Id of the application through which the triggering change was made; empty for changes made in Coevera itself. """ applicationId: ID """Name of the scheduled action as set in the process.""" actionName: String! """Date and time the process run that scheduled this action started.""" triggeredDate: DateTime! """Date and time the action is scheduled to run.""" scheduledDate: DateTime! """ Id of the record whose change triggered the process run that scheduled this action. """ entityId: ID! """ Entity type of the triggering record; CustomEntity for a custom entity record (see entityApiName). """ entityName: EntityNameEnum! """ API name of the custom entity of the triggering record; empty for other entity types. """ entityApiName: String """Process (automation) that scheduled this action.""" process: ProcessEntity """Id of the process that scheduled this action.""" processId: ID! """ Link that opens the process (automation) that scheduled this action in the Coevera web app. Empty when the link is not available to the caller. """ processUrl: String """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ProcessScheduledAction records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProcessScheduledActionFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProcessScheduledActionFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProcessScheduledActionFilterInput!] """Matches records that do not meet this filter.""" NOT: ProcessScheduledActionFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """ Id of the user whose change triggered the process run that scheduled this action. """ actorId: EntityFilterStringField """ Id of the application through which the triggering change was made; empty for changes made in Coevera itself. """ applicationId: EntityFilterStringField """Name of the scheduled action as set in the process.""" actionName: EntityFilterStringField """Date and time the process run that scheduled this action started.""" triggeredDate: EntityFilterDateTimeField """Date and time the action is scheduled to run.""" scheduledDate: EntityFilterDateTimeField """ Id of the record whose change triggered the process run that scheduled this action. """ entityId: EntityFilterStringField """ Entity type of the triggering record; CustomEntity for a custom entity record (see entityApiName). """ entityName: EntityNameEnumFilterInput """ API name of the custom entity of the triggering record; empty for other entity types. """ entityApiName: EntityFilterStringField """Id of the process that scheduled this action.""" processId: EntityFilterStringField """ User whose change triggered the process run that scheduled this action. Matches records where a related record meets these conditions. """ actor: ClientFilterInput """ Application through which the change that triggered the process run was made; empty for changes made in Coevera itself. Matches records where a related record meets these conditions. """ application: ClientFilterInput """ Process (automation) that scheduled this action. Matches records where a related record meets these conditions. """ process: ProcessFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input EntityNameEnumFilterInput { """Matches any of the listed values.""" eq: [EntityNameEnum!] """Matches values that do not meet this condition.""" NOT: EntityNameEnumFilterInput } """ Sorting of ProcessScheduledAction records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProcessScheduledActionOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """ User whose change triggered the process run that scheduled this action. Sorts by fields of the related record, listed in order of priority. """ actor: [ClientOrderByNestedInput!] """ Id of the user whose change triggered the process run that scheduled this action. """ actorId: OrderByEnum """ Application through which the change that triggered the process run was made; empty for changes made in Coevera itself. Sorts by fields of the related record, listed in order of priority. """ application: [ClientOrderByNestedInput!] """ Id of the application through which the triggering change was made; empty for changes made in Coevera itself. """ applicationId: OrderByEnum """Name of the scheduled action as set in the process.""" actionName: OrderByEnum """Date and time the process run that scheduled this action started.""" triggeredDate: OrderByEnum """Date and time the action is scheduled to run.""" scheduledDate: OrderByEnum """ Id of the record whose change triggered the process run that scheduled this action. """ entityId: OrderByEnum """ API name of the custom entity of the triggering record; empty for other entity types. """ entityApiName: OrderByEnum """ Process (automation) that scheduled this action. Sorts by fields of the related record, listed in order of priority. """ process: [ProcessOrderByNestedInput!] """Id of the process that scheduled this action.""" processId: OrderByEnum } """Paginated list of ProcessScheduledAction records.""" type ProcessScheduledActionEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProcessScheduledActionEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProcessScheduledActionEntity` and its cursor. """ type ProcessScheduledActionEntityEdge { """The item at the end of the edge""" node: ProcessScheduledActionEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProcessTemplate records.""" type ProcessTemplateRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProcessTemplateEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProcessTemplateEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProcessTemplateFilterInput """Sorting of the returned records.""" orderBy: [ProcessTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProcessTemplateEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProcessTemplateFilterInput """Sorting of the returned records.""" orderBy: [ProcessTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProcessTemplateEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProcessTemplate records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProcessTemplateOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text description of what the template does.""" description: OrderByEnum """ True when the platform recommends this template (highlighted in the template gallery). """ isRecommended: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template. """ triggerType: OrderByEnum """ For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers. """ triggerEntityName: OrderByEnum } """Paginated list of ProcessTemplate records.""" type ProcessTemplateEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProcessTemplateEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProcessTemplateEntity` and its cursor.""" type ProcessTemplateEntityEdge { """The item at the end of the edge""" node: ProcessTemplateEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Product records.""" type ProductRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProductEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProductEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductFilterInput """Sorting of the returned records.""" orderBy: [ProductOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductEntity!]! """ Returns the products that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProductFilterInput """Sorting of the returned records.""" orderBy: [ProductOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """When set, returns only products that have a price in this price list.""" priceListId: ID """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns the products that can be used in the given pipeline: products allowed in all pipelines and products assigned to this pipeline. """ getForPipeline( """Id of the pipeline; an error is returned when it does not exist.""" pipelineId: UUID! """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductFilterInput """Sorting of the returned records.""" orderBy: [ProductOrderByInput!] ): [ProductEntity!]! } """Read operations for ProductCategory records.""" type ProductCategoryRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProductCategoryEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProductCategoryEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductCategoryFilterInput """Sorting of the returned records.""" orderBy: [ProductCategoryOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductCategoryEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProductCategoryFilterInput """Sorting of the returned records.""" orderBy: [ProductCategoryOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductCategoryEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProductCategory records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProductCategoryOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Parent category in the catalog hierarchy. Empty for top-level categories. Sorts by fields of the related record, listed in order of priority. """ parent: [ProductCategoryOrderByNestedInput!] """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the parent category.""" parentId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProductCategory records.""" type ProductCategoryEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProductCategoryEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProductCategoryEntity` and its cursor.""" type ProductCategoryEntityEdge { """The item at the end of the edge""" node: ProductCategoryEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProductDataExRelation records.""" type ProductDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProductDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProductDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ProductDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProductDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ProductDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Option selected in a multi-select checkbox field of a product.""" type ProductDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Product on which the option is selected.""" product: ProductEntity """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the product on which the option is selected.""" productId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ProductDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProductDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProductDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProductDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProductDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Id of the product on which the option is selected.""" productId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput """ Product on which the option is selected. Matches records where a related record meets these conditions. """ product: ProductFilterInput } """ Sorting of ProductDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProductDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """ Product on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ product: [ProductOrderByNestedInput!] """Id of the selected option.""" dataId: OrderByEnum """Id of the product on which the option is selected.""" productId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProductDataExRelation records.""" type ProductDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProductDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProductDataExRelationEntity` and its cursor. """ type ProductDataExRelationEntityEdge { """The item at the end of the edge""" node: ProductDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProductPipelineRelation records.""" type ProductPipelineRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProductPipelineRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProductPipelineRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductPipelineRelationFilterInput """Sorting of the returned records.""" orderBy: [ProductPipelineRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductPipelineRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProductPipelineRelationFilterInput """Sorting of the returned records.""" orderBy: [ProductPipelineRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductPipelineRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProductPipelineRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProductPipelineRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Pipeline in which the product can be added as a line item. Sorts by fields of the related record, listed in order of priority. """ pipeline: [PipelineOrderByNestedInput!] """ Product available in the linked pipeline. Sorts by fields of the related record, listed in order of priority. """ product: [ProductOrderByNestedInput!] """Id of the pipeline in which the product can be added as a line item.""" pipelineId: OrderByEnum """Id of the product made available in the pipeline.""" productId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ProductPriceList records.""" type ProductPriceListRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProductPriceListEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProductPriceListEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductPriceListFilterInput """Sorting of the returned records.""" orderBy: [ProductPriceListOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductPriceListEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProductPriceListFilterInput """Sorting of the returned records.""" orderBy: [ProductPriceListOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductPriceListEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProductPriceList records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProductPriceListOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-form description of the price list.""" description: OrderByEnum """Date when the price list expires. Empty means open-ended.""" endDate: OrderByEnum """ Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates. """ isActive: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Date when the price list becomes active. Empty means immediately.""" startDate: OrderByEnum """ Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled). """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """ True for the team space default price list, which cannot be deleted. Read-only. """ isDefault: OrderByEnum } """Paginated list of ProductPriceList records.""" type ProductPriceListEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProductPriceListEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProductPriceListEntity` and its cursor.""" type ProductPriceListEntityEdge { """The item at the end of the edge""" node: ProductPriceListEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProductPriceListPrice records.""" type ProductPriceListPriceRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProductPriceListPriceEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProductPriceListPriceEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductPriceListPriceFilterInput """Sorting of the returned records.""" orderBy: [ProductPriceListPriceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductPriceListPriceEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProductPriceListPriceFilterInput """Sorting of the returned records.""" orderBy: [ProductPriceListPriceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductPriceListPriceEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProductPriceListPrice records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProductPriceListPriceOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Currency the price value is denominated in. Sorts by fields of the related record, listed in order of priority. """ currency: [CurrencyOrderByNestedInput!] """ Product the price applies to. Sorts by fields of the related record, listed in order of priority. """ product: [ProductOrderByNestedInput!] """ Price list the price belongs to. Sorts by fields of the related record, listed in order of priority. """ productPriceList: [ProductPriceListOrderByNestedInput!] """Id of the currency the price is denominated in.""" currencyId: OrderByEnum """ Price amount stored at 6-decimal precision; values set via the API are rounded. """ price: OrderByEnum """Id of the product the price applies to.""" productId: OrderByEnum """Id of the price list this price belongs to.""" productPriceListId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ProductType records.""" type ProductTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProductTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProductTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductTypeFilterInput """Sorting of the returned records.""" orderBy: [ProductTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProductTypeFilterInput """Sorting of the returned records.""" orderBy: [ProductTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProductTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProductTypeFilterInput """Sorting of the returned records.""" orderBy: [ProductTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProductTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: ProductTypeFilterInput """Sorting of the returned records.""" orderBy: [ProductTypeOrderByInput!] ): [ProductTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): ProductTypeEntity! } """ Sorting of ProductType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProductTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Opportunity / quote line-item type paired with this product type. Drives the form used when adding products of this type as line items. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelationType: [OpptyProductRelationTypeOrderByNestedInput!] """ True when the product type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the paired opportunity/quote line-item type.""" opptyProductRelationTypeId: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProductType records.""" type ProductTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProductTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProductTypeEntity` and its cursor.""" type ProductTypeEntityEdge { """The item at the end of the edge""" node: ProductTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Profile records.""" type ProfileRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProfileEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProfileEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProfileFilterInput """Sorting of the returned records.""" orderBy: [ProfileOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProfileEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProfileFilterInput """Sorting of the returned records.""" orderBy: [ProfileOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the built-in default screen profiles of every screen, including one set per custom entity, for administration. """ getStaticProfilesForAdmin: [DefaultProfileEntity!]! """ Returns the screen profiles with the given ids for administration, regardless of their owner. Built-in default profiles are not included. """ getProfilesForAdminByIds( """Ids of the screen profiles.""" ids: [UUID!]! """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProfileEntity!]! """ Returns a page of screen profiles shared with everyone for the given screen, for administration. Built-in default profiles are not included. """ getProfilesInAdmin( """Screen the profiles belong to.""" screen: ScreenTypeEnum! """API name of the custom entity, to limit the result to its profiles.""" entityApiName: String """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileEntityConnection } """Paginated list of Profile records.""" type ProfileEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProfileEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProfileEntity` and its cursor.""" type ProfileEntityEdge { """The item at the end of the edge""" node: ProfileEntity """A cursor for use in pagination""" cursor: String! } """ Built-in default profile of a screen: the predefined view of records the screen offers before users create profiles of their own. """ type DefaultProfileEntity { """Identifier of the default screen profile.""" id: UUID! """Name of the profile; a translation key when `useLang` is true.""" name: String! """Screen the profile belongs to.""" entity: ScreenTypeEnum! """ Pipelines the profile shows; empty when it is not limited to pipelines. """ pipelines: [UUID!]! """True when `name` is a translation key that is shown localized.""" useLang: Boolean! """API name of the custom entity the profile belongs to; empty otherwise.""" entityApiName: String } """Read operations for ProfileRelation records.""" type ProfileRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProfileRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProfileRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProfileRelationFilterInput """Sorting of the returned records.""" orderBy: [ProfileRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProfileRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProfileRelationFilterInput """Sorting of the returned records.""" orderBy: [ProfileRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProfileRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProfileRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Contact this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Screen profile this relation links to a specific record. Sorts by fields of the related record, listed in order of priority. """ profile: [ProfileOrderByNestedInput!] """ Project this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked custom entity record.""" customEntityId: OrderByEnum """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: OrderByEnum """Id of the screen profile.""" profileId: OrderByEnum """Id of the linked project.""" projectId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum } """Read operations for ProfileSharingClientRelation records.""" type ProfileSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProfileSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProfileSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProfileSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ProfileSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProfileSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProfileSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ProfileSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Share of a saved view (profile) with an individual user.""" type ProfileSharingClientRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User granted shared access to the profile.""" client: ClientEntity """Screen profile being shared.""" profile: ProfileEntity """Id of the user.""" clientId: ID! """Id of the shared profile.""" profileId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ProfileSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProfileSharingClientRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProfileSharingClientRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProfileSharingClientRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProfileSharingClientRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the user.""" clientId: EntityFilterStringField """Id of the shared profile.""" profileId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User granted shared access to the profile. Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Screen profile being shared. Matches records where a related record meets these conditions. """ profile: ProfileFilterInput } """ Sorting of ProfileSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProfileSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User granted shared access to the profile. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Screen profile being shared. Sorts by fields of the related record, listed in order of priority. """ profile: [ProfileOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the shared profile.""" profileId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProfileSharingClientRelation records.""" type ProfileSharingClientRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProfileSharingClientRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProfileSharingClientRelationEntity` and its cursor. """ type ProfileSharingClientRelationEntityEdge { """The item at the end of the edge""" node: ProfileSharingClientRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProfileSharingSalesUnitRelation records.""" type ProfileSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProfileSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProfileSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProfileSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ProfileSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProfileSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProfileSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ProfileSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProfileSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Share of a saved view (profile) with a sales unit.""" type ProfileSharingSalesUnitRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Screen profile being shared.""" profile: ProfileEntity """Sales unit granted shared access to the profile.""" unit: SalesUnitEntity """Id of the shared profile.""" profileId: ID! """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ProfileSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProfileSharingSalesUnitRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProfileSharingSalesUnitRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProfileSharingSalesUnitRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProfileSharingSalesUnitRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the shared profile.""" profileId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Screen profile being shared. Matches records where a related record meets these conditions. """ profile: ProfileFilterInput """ Sales unit granted shared access to the profile. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Sorting of ProfileSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProfileSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Screen profile being shared. Sorts by fields of the related record, listed in order of priority. """ profile: [ProfileOrderByNestedInput!] """ Sales unit granted shared access to the profile. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared profile.""" profileId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProfileSharingSalesUnitRelation records.""" type ProfileSharingSalesUnitRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProfileSharingSalesUnitRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProfileSharingSalesUnitRelationEntity` and its cursor. """ type ProfileSharingSalesUnitRelationEntityEdge { """The item at the end of the edge""" node: ProfileSharingSalesUnitRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Project records.""" type ProjectRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectFilterInput """Sorting of the returned records.""" orderBy: [ProjectOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectFilterInput """Sorting of the returned records.""" orderBy: [ProjectOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): ProjectEntity! } """Paginated list of Project records.""" type ProjectEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProjectEntity` and its cursor.""" type ProjectEntityEdge { """The item at the end of the edge""" node: ProjectEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProjectContactRelation records.""" type ProjectContactRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectContactRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectContactRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectContactRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectContactRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectContactRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectContactRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProjectContactRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectContactRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact linked to the project. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Project the contact is linked to. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """Id of the contact linked to the project.""" contactId: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """Id of the project the contact is linked to.""" projectId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ProjectDataExRelation records.""" type ProjectDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Option selected in a multi-select checkbox field of a project.""" type ProjectDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Project on which the option is selected.""" project: ProjectEntity """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the project on which the option is selected.""" projectId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for ProjectDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Id of the project on which the option is selected.""" projectId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput """ Project on which the option is selected. Matches records where a related record meets these conditions. """ project: ProjectFilterInput } """ Sorting of ProjectDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """ Project on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """Id of the selected option.""" dataId: OrderByEnum """Id of the project on which the option is selected.""" projectId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProjectDataExRelation records.""" type ProjectDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `ProjectDataExRelationEntity` and its cursor. """ type ProjectDataExRelationEntityEdge { """The item at the end of the edge""" node: ProjectDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProjectKPI records.""" type ProjectKPIRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectKPIEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectKPIEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectKPIFilterInput """Sorting of the returned records.""" orderBy: [ProjectKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectKPIEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectKPIFilterInput """Sorting of the returned records.""" orderBy: [ProjectKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectKPIEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """KPI event of a project (its completion), used in activity reporting.""" type ProjectKPIEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User who triggered the KPI event (project completion).""" client: ClientEntity """Project owner at the time the KPI event occurred.""" owner: ClientEntity """Project this KPI event relates to.""" project: ProjectEntity """Sales unit the triggering user belonged to at the time of the event.""" unit: SalesUnitEntity """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, ProjectCompleted or LastModified. """ kpi: ProjectKpiEnum! """Id of the project owner at the time of the event.""" ownerId: ID! """Id of the project this KPI event relates to.""" projectId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of project event recorded as a KPI entry; each project keeps at most one entry per kind. """ enum ProjectKpiEnum { """The project was completed.""" ProjectCompleted """The project was created.""" Create """The project was last modified.""" LastModified } """ Filter conditions for ProjectKPI records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input ProjectKPIFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [ProjectKPIFilterInput!] """Matches records that meet all of the listed filters.""" AND: [ProjectKPIFilterInput!] """Matches records that do not meet this filter.""" NOT: ProjectKPIFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: EntityFilterStringField """Id of the user who triggered the event.""" clientId: EntityFilterStringField """ KPI metric this event represents: Create, ProjectCompleted or LastModified. """ kpi: ProjectKpiEnumFilterInput """Id of the project owner at the time of the event.""" ownerId: EntityFilterStringField """Id of the project this KPI event relates to.""" projectId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who triggered the KPI event (project completion). Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Project owner at the time the KPI event occurred. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Project this KPI event relates to. Matches records where a related record meets these conditions. """ project: ProjectFilterInput """ Sales unit the triggering user belonged to at the time of the event. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input ProjectKpiEnumFilterInput { """Matches any of the listed values.""" eq: [ProjectKpiEnum!] """Matches values that do not meet this condition.""" NOT: ProjectKpiEnumFilterInput } """ Sorting of ProjectKPI records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectKPIOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who triggered the KPI event (project completion). Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Project owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Project this KPI event relates to. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Sales unit the triggering user belonged to at the time of the event. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the user who triggered the event.""" clientId: OrderByEnum """Id of the project owner at the time of the event.""" ownerId: OrderByEnum """Id of the project this KPI event relates to.""" projectId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProjectKPI records.""" type ProjectKPIEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectKPIEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProjectKPIEntity` and its cursor.""" type ProjectKPIEntityEdge { """The item at the end of the edge""" node: ProjectKPIEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProjectObjective records.""" type ProjectObjectiveRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectObjectiveEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectObjectiveEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectObjectiveFilterInput """Sorting of the returned records.""" orderBy: [ProjectObjectiveOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectObjectiveEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectObjectiveFilterInput """Sorting of the returned records.""" orderBy: [ProjectObjectiveOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectObjectiveEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProjectObjective records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectObjectiveOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Project this objective belongs to. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """Name of the entity and its default text representation.""" name: OrderByEnum """ Id of the project this objective belongs to. Set on create; cannot be changed afterwards. """ projectId: OrderByEnum """ Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. """ sortOrder: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProjectObjective records.""" type ProjectObjectiveEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectObjectiveEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProjectObjectiveEntity` and its cursor.""" type ProjectObjectiveEntityEdge { """The item at the end of the edge""" node: ProjectObjectiveEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ProjectSharingClientRelation records.""" type ProjectSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProjectSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the project is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Project being shared. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the shared project.""" projectId: OrderByEnum """ Access the sharing gives the user on the project: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ProjectSharingSalesUnitRelation records.""" type ProjectSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ProjectSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ProjectSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Project being shared. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Sales unit the project is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared project.""" projectId: OrderByEnum """ Access the sharing gives the sales unit on the project: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ProjectType records.""" type ProjectTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ProjectTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ProjectTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectTypeFilterInput """Sorting of the returned records.""" orderBy: [ProjectTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ProjectTypeFilterInput """Sorting of the returned records.""" orderBy: [ProjectTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ProjectTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ProjectTypeFilterInput """Sorting of the returned records.""" orderBy: [ProjectTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ProjectTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: ProjectTypeFilterInput """Sorting of the returned records.""" orderBy: [ProjectTypeOrderByInput!] ): [ProjectTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): ProjectTypeEntity! } """ Sorting of ProjectType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ProjectTypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account). """ icon: OrderByEnum """ True when the project type is system-managed and cannot be edited or deleted by users. """ isReadonly: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ProjectType records.""" type ProjectTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ProjectTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ProjectTypeEntity` and its cursor.""" type ProjectTypeEntityEdge { """The item at the end of the edge""" node: ProjectTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Quote records.""" type QuoteRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteFilterInput """Sorting of the returned records.""" orderBy: [QuoteOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteFilterInput """Sorting of the returned records.""" orderBy: [QuoteOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): QuoteEntity! } """Read operations for QuoteAccountRelation records.""" type QuoteAccountRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteAccountRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteAccountRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteAccountRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteAccountRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteAccountRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteAccountRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of QuoteAccountRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteAccountRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account linked to the quote. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Quote the account is linked to. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the account linked to this quote.""" accountId: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """Id of the quote the account is linked to.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for QuoteContactRelation records.""" type QuoteContactRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteContactRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteContactRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteContactRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteContactRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteContactRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteContactRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteContactRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of QuoteContactRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteContactRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Contact linked to the quote. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Quote the contact is linked to. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the contact linked to this quote.""" contactId: OrderByEnum """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: OrderByEnum """Id of the quote the contact is linked to.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for QuoteDataExRelation records.""" type QuoteDataExRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteDataExRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteDataExRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteDataExRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteDataExRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteDataExRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteDataExRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Option selected in a multi-select checkbox field of a quote.""" type QuoteDataExRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. """ data: DataEntity """Quote on which the option is selected.""" quote: QuoteEntity """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the quote on which the option is selected.""" quoteId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for QuoteDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteDataExRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteDataExRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteDataExRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteDataExRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the selected option.""" dataId: EntityFilterStringField """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: EntityFilterStringField """Id of the quote on which the option is selected.""" quoteId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions. """ data: DataFilterInput """ Quote on which the option is selected. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput } """ Sorting of QuoteDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteDataExRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """ Quote on which the option is selected. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the selected option.""" dataId: OrderByEnum """Id of the quote on which the option is selected.""" quoteId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of QuoteDataExRelation records.""" type QuoteDataExRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteDataExRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `QuoteDataExRelationEntity` and its cursor.""" type QuoteDataExRelationEntityEdge { """The item at the end of the edge""" node: QuoteDataExRelationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for QuoteKPI records.""" type QuoteKPIRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteKPIEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteKPIEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteKPIFilterInput """Sorting of the returned records.""" orderBy: [QuoteKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteKPIEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteKPIFilterInput """Sorting of the returned records.""" orderBy: [QuoteKPIOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteKPIEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ KPI event of a quote (e.g. created, accepted, archived or moved to another step), used in activity reporting. """ type QuoteKPIEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ User who triggered the KPI event (e.g. created the quote, accepted it, archived it, moved the record). """ client: ClientEntity """Quote owner at the time the KPI event occurred.""" owner: ClientEntity """Quote this KPI event relates to.""" quote: QuoteEntity """Sales unit the triggering user belonged to at the time of the event.""" unit: SalesUnitEntity """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, Accept, Archive, LastMove or LastModified. """ kpi: QuoteKpiEnum! """Id of the quote owner at the time of the event.""" ownerId: ID! """Id of the quote this KPI event relates to.""" quoteId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Kind of quote event recorded as a KPI entry; each quote keeps at most one entry per kind. """ enum QuoteKpiEnum { """The quote was created.""" Create """The quote was accepted.""" Accept """The quote was archived without being accepted.""" Archive """The quote entered its current step.""" LastMove """The quote was last modified.""" LastModified } """ Filter conditions for QuoteKPI records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input QuoteKPIFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [QuoteKPIFilterInput!] """Matches records that meet all of the listed filters.""" AND: [QuoteKPIFilterInput!] """Matches records that do not meet this filter.""" NOT: QuoteKPIFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: EntityFilterStringField """Id of the user who triggered the event.""" clientId: EntityFilterStringField """ KPI metric this event represents: Create, Accept, Archive, LastMove or LastModified. """ kpi: QuoteKpiEnumFilterInput """Id of the quote owner at the time of the event.""" ownerId: EntityFilterStringField """Id of the quote this KPI event relates to.""" quoteId: EntityFilterStringField """Id of the sales unit.""" unitId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ User who triggered the KPI event (e.g. created the quote, accepted it, archived it, moved the record). Matches records where a related record meets these conditions. """ client: ClientFilterInput """ Quote owner at the time the KPI event occurred. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ Quote this KPI event relates to. Matches records where a related record meets these conditions. """ quote: QuoteFilterInput """ Sales unit the triggering user belonged to at the time of the event. Matches records where a related record meets these conditions. """ unit: SalesUnitFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input QuoteKpiEnumFilterInput { """Matches any of the listed values.""" eq: [QuoteKpiEnum!] """Matches values that do not meet this condition.""" NOT: QuoteKpiEnumFilterInput } """ Sorting of QuoteKPI records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteKPIOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who triggered the KPI event (e.g. created the quote, accepted it, archived it, moved the record). Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Quote owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Quote this KPI event relates to. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Sales unit the triggering user belonged to at the time of the event. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the user who triggered the event.""" clientId: OrderByEnum """Id of the quote owner at the time of the event.""" ownerId: OrderByEnum """Id of the quote this KPI event relates to.""" quoteId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of QuoteKPI records.""" type QuoteKPIEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteKPIEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `QuoteKPIEntity` and its cursor.""" type QuoteKPIEntityEdge { """The item at the end of the edge""" node: QuoteKPIEntity """A cursor for use in pagination""" cursor: String! } """Read operations for QuoteProcess records.""" type QuoteProcessRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteProcessEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteProcessEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteProcessFilterInput """Sorting of the returned records.""" orderBy: [QuoteProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteProcessEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteProcessFilterInput """Sorting of the returned records.""" orderBy: [QuoteProcessOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteProcessEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of QuoteProcess records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteProcessOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of QuoteProcess records.""" type QuoteProcessEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteProcessEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `QuoteProcessEntity` and its cursor.""" type QuoteProcessEntityEdge { """The item at the end of the edge""" node: QuoteProcessEntity """A cursor for use in pagination""" cursor: String! } """Read operations for QuoteSharingClientRelation records.""" type QuoteSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of QuoteSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the quote is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Quote being shared. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the shared quote.""" quoteId: OrderByEnum """ Access the sharing gives the user on the quote: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for QuoteSharingSalesUnitRelation records.""" type QuoteSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [QuoteSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of QuoteSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input QuoteSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Quote being shared. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Sales unit the quote is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared quote.""" quoteId: OrderByEnum """ Access the sharing gives the sales unit on the quote: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for QuoteType records.""" type QuoteTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): QuoteTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [QuoteTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteTypeFilterInput """Sorting of the returned records.""" orderBy: [QuoteTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: QuoteTypeFilterInput """Sorting of the returned records.""" orderBy: [QuoteTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): QuoteTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: QuoteTypeFilterInput """Sorting of the returned records.""" orderBy: [QuoteTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [QuoteTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: QuoteTypeFilterInput """Sorting of the returned records.""" orderBy: [QuoteTypeOrderByInput!] ): [QuoteTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): QuoteTypeEntity! """ Returns the quote type that uses the given quote process, or null when none does. """ getByQuoteProcess( """Id of the quote process.""" quoteProcessId: UUID! ): QuoteTypeEntity } """Paginated list of QuoteType records.""" type QuoteTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [QuoteTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `QuoteTypeEntity` and its cursor.""" type QuoteTypeEntityEdge { """The item at the end of the edge""" node: QuoteTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Report records.""" type ReportRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ReportEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ReportEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ReportFilterInput """Sorting of the returned records.""" orderBy: [ReportOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ReportEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ReportFilterInput """Sorting of the returned records.""" orderBy: [ReportOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ReportEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Paginated list of Report records.""" type ReportEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ReportEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ReportEntity` and its cursor.""" type ReportEntityEdge { """The item at the end of the edge""" node: ReportEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ReportFolder records.""" type ReportFolderRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ReportFolderEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ReportFolderEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ReportFolderFilterInput """Sorting of the returned records.""" orderBy: [ReportFolderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ReportFolderEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ReportFolderFilterInput """Sorting of the returned records.""" orderBy: [ReportFolderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ReportFolderEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ReportFolder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ReportFolderOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Parent report folder, when this folder is nested. Empty for top-level folders. Sorts by fields of the related record, listed in order of priority. """ parentReportFolder: [ReportFolderOrderByNestedInput!] """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the parent folder, or empty for top-level folders.""" parentReportFolderId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ReportFolder records.""" type ReportFolderEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ReportFolderEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ReportFolderEntity` and its cursor.""" type ReportFolderEntityEdge { """The item at the end of the edge""" node: ReportFolderEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ReportSchedule records.""" type ReportScheduleRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ReportScheduleEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ReportScheduleEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ReportScheduleFilterInput """Sorting of the returned records.""" orderBy: [ReportScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ReportScheduleEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ReportScheduleFilterInput """Sorting of the returned records.""" orderBy: [ReportScheduleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ReportScheduleEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ReportSchedule records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ReportScheduleOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the schedule. The schedule sends emails on behalf of this user. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Report whose delivery is scheduled. Sorts by fields of the related record, listed in order of priority. """ report: [ReportOrderByNestedInput!] """Id of the owning user.""" ownerId: OrderByEnum """Id of the scheduled report.""" reportId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of ReportSchedule records.""" type ReportScheduleEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [ReportScheduleEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `ReportScheduleEntity` and its cursor.""" type ReportScheduleEntityEdge { """The item at the end of the edge""" node: ReportScheduleEntity """A cursor for use in pagination""" cursor: String! } """Read operations for ReportSharingClientRelation records.""" type ReportSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ReportSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ReportSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ReportSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ReportSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ReportSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ReportSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [ReportSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ReportSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ReportSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ReportSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User granted shared access to the report. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Report being shared. Sorts by fields of the related record, listed in order of priority. """ report: [ReportOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the shared report.""" reportId: OrderByEnum """ Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it. """ role: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for ReportSharingSalesUnitRelation records.""" type ReportSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): ReportSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [ReportSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: ReportSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ReportSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [ReportSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: ReportSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [ReportSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): ReportSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of ReportSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input ReportSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Report being shared. Sorts by fields of the related record, listed in order of priority. """ report: [ReportOrderByNestedInput!] """ Sales unit granted shared access to the report. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the shared report.""" reportId: OrderByEnum """ Access the sharing gives members and managers of the sales unit on the report: Watcher can view it, Editor can also edit it. """ role: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for SalesRole records.""" type SalesRoleRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): SalesRoleEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [SalesRoleEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: SalesRoleFilterInput """Sorting of the returned records.""" orderBy: [SalesRoleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [SalesRoleEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: SalesRoleFilterInput """Sorting of the returned records.""" orderBy: [SalesRoleOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SalesRoleEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Paginated list of SalesRole records.""" type SalesRoleEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [SalesRoleEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `SalesRoleEntity` and its cursor.""" type SalesRoleEntityEdge { """The item at the end of the edge""" node: SalesRoleEntity """A cursor for use in pagination""" cursor: String! } """Read operations for SalesUnit records.""" type SalesUnitRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): SalesUnitEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [SalesUnitEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: SalesUnitFilterInput """Sorting of the returned records.""" orderBy: [SalesUnitOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [SalesUnitEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: SalesUnitFilterInput """Sorting of the returned records.""" orderBy: [SalesUnitOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SalesUnitEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the top-level sales unit of the space, the root of the sales unit hierarchy. """ getRoot: SalesUnitEntity! } """Paginated list of SalesUnit records.""" type SalesUnitEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [SalesUnitEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `SalesUnitEntity` and its cursor.""" type SalesUnitEntityEdge { """The item at the end of the edge""" node: SalesUnitEntity """A cursor for use in pagination""" cursor: String! } """Read operations for SalesUnitClientRelation records.""" type SalesUnitClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): SalesUnitClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [SalesUnitClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: SalesUnitClientRelationFilterInput """Sorting of the returned records.""" orderBy: [SalesUnitClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [SalesUnitClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: SalesUnitClientRelationFilterInput """Sorting of the returned records.""" orderBy: [SalesUnitClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SalesUnitClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of SalesUnitClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input SalesUnitClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User belonging to the sales unit. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Sales unit the user belongs to. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """ Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit. """ unitRole: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for Solution records.""" type SolutionRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): SolutionEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [SolutionEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: SolutionFilterInput """Sorting of the returned records.""" orderBy: [SolutionOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [SolutionEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: SolutionFilterInput """Sorting of the returned records.""" orderBy: [SolutionOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of solutions filtered by owner, status and tags, in addition to the regular filter. """ getBySolutionCriteria( """ Owner, status (Active, Partial, Inactive) and tag filters applied to the list. """ listingOptions: SolutionTabDataGridViewOptionsParams! """Conditions the returned records must meet.""" filter: SolutionFilterInput """Sorting of the returned records.""" orderBy: [SolutionOrderByInput!] """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionEntityConnection """ Returns the current status and name of the given nodes of a solution canvas, computed from the live state of the records and features they reference. Node ids not present on the canvas are left out of the result. """ nodeStatus( """ The solution canvas to evaluate, as a JSON object conforming to the SolutionSchema type; it may be unsaved. """ settings: SolutionSchemaJSONString! """Ids of the canvas nodes to evaluate.""" nodeIds: [UUID!]! ): [SolutionNodeStatusResult!]! """ Scans a solution canvas for related records and returns an updated canvas together with related records it did not add, so the user can choose which to add. Nothing is saved; save the returned canvas with the update mutation. Without nodeId the whole canvas is verified and outdated automatically added nodes are removed, but no new nodes are added. """ scan( """ The solution canvas to scan, as a JSON object conforming to the SolutionSchema type; it may be unsaved. """ settings: SolutionSchemaJSONString! """ Id of the canvas node whose direct neighbours are scanned and added; omit to verify the whole canvas. """ nodeId: UUID """ Candidate records of the scanned node to add, as chosen by the user. Requires nodeId. """ addRecordIds: [UUID!] """ Id of the solution being edited, excluded when counting how many other solutions use each candidate. Omit for an unsaved solution. """ solutionId: UUID ): SolutionScanResult! } """ Sorting of Solution records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input SolutionOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the solution. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Template this solution was created from, if any. Sorts by fields of the related record, listed in order of priority. """ solutionTemplate: [SolutionTemplateOrderByNestedInput!] """Free-text description of the solution.""" description: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Template this solution was created from, if any.""" solutionTemplateId: OrderByEnum """Number of nodes on the canvas.""" nodeCount: OrderByEnum """ Live status derived from the activatable nodes (Automatizer, Email Sequence, Online Form): Active when all are enabled, Inactive when none are, Partial otherwise. """ status: OrderByEnum } """ Sorting by a field of the related SolutionTemplate record. Set exactly one field in each item. """ input SolutionTemplateOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text description of what the template sets up.""" description: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """URL of the template preview image shown in the template gallery.""" previewImageUrl: OrderByEnum } """Filters for listing solutions by owner, status and tags.""" input SolutionTabDataGridViewOptionsParams { """ Owner ids to include; NULL/omitted = no owner filter, empty list = none match. """ filterByOwnerId: [ID!] """Solution statuses (Active/Partial/Inactive) to include.""" filterByStatus: [SolutionStatusEnum!] """Tag ids to include.""" filterByTagIds: [ID!] } """ Current status of one canvas node, computed on every nodeStatus query from the live state of the record or feature it references. """ type SolutionNodeStatusResult { """Canvas node id the status belongs to.""" id: ID! """ Deleted (record deleted or missing), Upgrade (feature not in the subscription), Unavailable (caller cannot access the record), Active or Inactive (process, email sequence or online form enabled or disabled) or Default. """ status: SolutionNodeStatus! """ Current display name of the node's referenced record. Null when the node references no single record (e.g. an entity-settings node), the record no longer exists, or the caller cannot access it. """ name: String } """ Status of a canvas node, derived from the current state of the record it references. """ enum SolutionNodeStatus { """ No special status; always used for entity-settings nodes and for record types that cannot be enabled. """ Default """The referenced record is deleted or no longer exists.""" Deleted """The record exists but the caller cannot access it.""" Unavailable """The feature behind the node is not included in the subscription.""" Upgrade """The referenced process, email sequence or online form is disabled.""" Inactive """The referenced process, email sequence or online form is enabled.""" Active } """JSON object, sent as a string, conforming to the SolutionSchema type.""" scalar SolutionSchemaJSONString """ Result of a canvas scan: the updated canvas plus the connected records the scan found but did not add. A record appears in at most one of the two candidate lists; directCandidates takes precedence. """ type SolutionScanResult { """ The canvas with the scan's changes applied. The scan does not save it; send it with updateSolution to keep the changes. """ schema: SolutionSchema! """ Records directly connected to a canvas node (TriggerExplicit, UsedIn or Reference) that are not on the canvas, one entry per source node and record. Pass chosen recordIds in addRecordIds of a node-scoped scan to add them; a record listed here is not repeated in indirectCandidates. """ directCandidates: [SolutionDirectCandidate!]! """ Records indirectly connected to a canvas node (TriggerImplicit) that are not on the canvas, one entry per source node and record. Pass chosen recordIds in addRecordIds of a node-scoped scan to add them; records already in directCandidates are not repeated here. """ indirectCandidates: [SolutionIndirectCandidate!]! } """ A record directly connected to a canvas node (a TriggerExplicit, UsedIn or Reference connection) that the scan found but did not add to the canvas. """ type SolutionDirectCandidate { """Canvas node the candidate connection belongs to.""" sourceNodeId: ID! """Id of the candidate record.""" recordId: ID! """Type of the candidate record.""" recordType: SolutionRecordNodeType! """Current display name of the candidate record.""" name: String """ True when the record is in removedRecordIds — it is never auto-added, but picking it via scan addRecordIds restores it. """ isRemoved: Boolean! """ Number of other solutions whose canvas already contains this record. Deleted solutions, solutions the caller cannot see and the solution passed as solutionId to scan are not counted. """ usedInSolutionsCount: Int! } """ A record indirectly connected to a canvas node (a TriggerImplicit connection) that the scan found but did not add to the canvas. """ type SolutionIndirectCandidate { """Canvas node the candidate connection belongs to.""" sourceNodeId: ID! """Id of the candidate record.""" recordId: ID! """Type of the candidate record.""" recordType: SolutionRecordNodeType! """Current display name of the candidate record.""" name: String """ True when the record is in removedRecordIds — it is never auto-added, but picking it via scan addRecordIds restores it. """ isRemoved: Boolean! """ Number of other solutions whose canvas already contains this record. Deleted solutions, solutions the caller cannot see and the solution passed as solutionId to scan are not counted. """ usedInSolutionsCount: Int! } """Read operations for SolutionTemplate records.""" type SolutionTemplateRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): SolutionTemplateEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [SolutionTemplateEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: SolutionTemplateFilterInput """Sorting of the returned records.""" orderBy: [SolutionTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [SolutionTemplateEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: SolutionTemplateFilterInput """Sorting of the returned records.""" orderBy: [SolutionTemplateOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): SolutionTemplateEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of SolutionTemplate records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input SolutionTemplateOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text description of what the template sets up.""" description: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """URL of the template preview image shown in the template gallery.""" previewImageUrl: OrderByEnum } """Paginated list of SolutionTemplate records.""" type SolutionTemplateEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [SolutionTemplateEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `SolutionTemplateEntity` and its cursor.""" type SolutionTemplateEntityEdge { """The item at the end of the edge""" node: SolutionTemplateEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Step records.""" type StepRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): StepEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [StepEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: StepFilterInput """Sorting of the returned records.""" orderBy: [StepOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [StepEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: StepFilterInput """Sorting of the returned records.""" orderBy: [StepOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): StepEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns the steps of the pipeline in their display order.""" getByPipeline( """Id of the pipeline.""" pipelineId: UUID! ): [StepEntity!]! """Returns the steps of the lead process in their display order.""" getByLeadProcess( """Id of the lead process.""" leadProcessId: UUID! ): [StepEntity!]! """Returns the steps of the quote process in their display order.""" getByQuoteProcess( """Id of the quote process.""" quoteProcessId: UUID! ): [StepEntity!]! } """ Sorting of Step records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input StepOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead process this step belongs to. Set when the step is part of a lead process. Sorts by fields of the related record, listed in order of priority. """ leadProcess: [LeadProcessOrderByNestedInput!] """ Opportunity pipeline this step belongs to. Set when the step is part of an opportunity pipeline. Sorts by fields of the related record, listed in order of priority. """ pipeline: [PipelineOrderByNestedInput!] """ Quote process this step belongs to. Set when the step is part of a quote process. Sorts by fields of the related record, listed in order of priority. """ quoteProcess: [QuoteProcessOrderByNestedInput!] """Free-text description shown in the step UI.""" description: OrderByEnum """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: OrderByEnum """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: OrderByEnum """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: OrderByEnum """Id of the opportunity pipeline.""" pipelineId: OrderByEnum """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: OrderByEnum """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: OrderByEnum """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Step records.""" type StepEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [StepEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `StepEntity` and its cursor.""" type StepEntityEdge { """The item at the end of the edge""" node: StepEntity """A cursor for use in pagination""" cursor: String! } """Read operations for StepChecklist records.""" type StepChecklistRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): StepChecklistEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [StepChecklistEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: StepChecklistFilterInput """Sorting of the returned records.""" orderBy: [StepChecklistOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [StepChecklistEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: StepChecklistFilterInput """Sorting of the returned records.""" orderBy: [StepChecklistOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): StepChecklistEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns the checklist items of the step in their display order.""" getByStep( """Id of the step.""" stepId: UUID! ): [StepChecklistEntity!]! } """Read operations for StepChecklistSalesRoleRelation records.""" type StepChecklistSalesRoleRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): StepChecklistSalesRoleRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [StepChecklistSalesRoleRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: StepChecklistSalesRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [StepChecklistSalesRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [StepChecklistSalesRoleRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: StepChecklistSalesRoleRelationFilterInput """Sorting of the returned records.""" orderBy: [StepChecklistSalesRoleRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): StepChecklistSalesRoleRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of StepChecklistSalesRoleRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input StepChecklistSalesRoleRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Sales role that sees the checklist item. Sorts by fields of the related record, listed in order of priority. """ salesRole: [SalesRoleOrderByNestedInput!] """ Checklist item the role is granted access to. Sorts by fields of the related record, listed in order of priority. """ stepChecklist: [StepChecklistOrderByNestedInput!] """Id of the sales role that sees the checklist item.""" salesRoleId: OrderByEnum """Id of the checklist item.""" stepChecklistId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for Tag records.""" type TagRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TagEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TagEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TagFilterInput """Sorting of the returned records.""" orderBy: [TagOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TagEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TagFilterInput """Sorting of the returned records.""" orderBy: [TagOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """Returns the tags available for the given record type.""" getByEntityType( """Record type the tags are available for (e.g. Account, Opportunity).""" entityType: BaseEntityTypeEnum! """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TagEntity!]! """ Returns a page of tags that can be used on any of the given record types, in addition to the regular filter. Tags not limited to specific types are always included. """ getByCustomCriteria( """Record type ids the tags must be usable on.""" listingOptions: TagTabDataGridViewOptionsParams! """Conditions the returned records must meet.""" filter: TagFilterInput """Sorting of the returned records.""" orderBy: [TagOrderByInput!] """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagEntityConnection } """Paginated list of Tag records.""" type TagEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TagEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TagEntity` and its cursor.""" type TagEntityEdge { """The item at the end of the edge""" node: TagEntity """A cursor for use in pagination""" cursor: String! } """ Filter for listing the tags that can be assigned to records of the given types (for example specific account types). """ input TagTabDataGridViewOptionsParams { """ List of allowed entity type ids for which the user wants to filter tags for """ allowedEntityTypeIds: [UUID!] } """Read operations for TagRelation records.""" type TagRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TagRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TagRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TagRelationFilterInput """Sorting of the returned records.""" orderBy: [TagRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TagRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TagRelationFilterInput """Sorting of the returned records.""" orderBy: [TagRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TagRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of TagRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TagRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the tag is attached to, or empty when not attached to an account. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Appointment the tag is attached to, or empty when not attached to an appointment. Sorts by fields of the related record, listed in order of priority. """ appointment: [AppointmentOrderByNestedInput!] """ Contact the tag is attached to, or empty when not attached to a contact. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Custom entity record the tag is attached to, or empty when not attached to a custom entity record. Sorts by fields of the related record, listed in order of priority. """ customEntity: [CustomEntityOrderByNestedInput!] """ Email the tag is attached to, or empty when not attached to an email. Sorts by fields of the related record, listed in order of priority. """ email: [EmailOrderByNestedInput!] """ Lead the tag is attached to, or empty when not attached to a lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the tag is attached to, or empty when not attached to an opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Sales process the tag is attached to, or empty when not attached to a process. Sorts by fields of the related record, listed in order of priority. """ process: [ProcessOrderByNestedInput!] """ Project the tag is attached to, or empty when not attached to a project. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote the tag is attached to, or empty when not attached to a quote. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Solution the tag is attached to, or empty when not attached to a solution. Sorts by fields of the related record, listed in order of priority. """ solution: [SolutionOrderByNestedInput!] """ Tag being attached to the record. Sorts by fields of the related record, listed in order of priority. """ tag: [TagOrderByNestedInput!] """ Task the tag is attached to, or empty when not attached to a task. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the linked appointment.""" appointmentId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """Id of the linked custom entity record.""" customEntityId: OrderByEnum """Id of the linked email.""" emailId: OrderByEnum """Id of the linked lead.""" leadId: OrderByEnum """Id of the linked opportunity.""" opptyId: OrderByEnum """Id of the linked sales process.""" processId: OrderByEnum """Id of the linked project.""" projectId: OrderByEnum """Id of the linked quote.""" quoteId: OrderByEnum """Id of the linked solution.""" solutionId: OrderByEnum """Id of the tag attached to the record.""" tagId: OrderByEnum """Id of the linked task.""" taskId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Solution record. Set exactly one field in each item. """ input SolutionOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Free-text description of the solution.""" description: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """Template this solution was created from, if any.""" solutionTemplateId: OrderByEnum """Number of nodes on the canvas.""" nodeCount: OrderByEnum """ Live status derived from the activatable nodes (Automatizer, Email Sequence, Online Form): Active when all are enabled, Inactive when none are, Partial otherwise. """ status: OrderByEnum } """ Sorting by a field of the related Tag record. Set exactly one field in each item. """ input TagOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: OrderByEnum """Id of the creating user.""" creatorId: OrderByEnum """ For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags. """ entityApiName: OrderByEnum """ When false, the tag is hidden in pickers and cannot be assigned to new records. """ isEnabled: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """ Bit flags of the entities the tag can be attached to, added together: Contact 1, Account 2, Opportunity 4, Lead 8, Project 16, Email 32, Process 64, Appointment 128, Task 256, Quote 512, CustomEntity 1024, Solution 2048. """ supportedEntities: OrderByEnum """ When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for Target records.""" type TargetRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TargetEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TargetEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TargetFilterInput """Sorting of the returned records.""" orderBy: [TargetOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TargetEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TargetFilterInput """Sorting of the returned records.""" orderBy: [TargetOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TargetEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sales target set for a user or a group of users for a period, measured by a chosen metric. """ type TargetEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Currency the target value is expressed in. Required when calculationType is a currency-based metric. """ currency: CurrencyEntity """User who owns the target.""" owner: ClientEntity """ User the target is set on (the assignee). Required for User-type targets; null for group targets. """ targetClient: ClientEntity """ What the target measures: revenue from opportunities won, or the number of leads qualified or created in the target period. """ calculationType: TargetCalculationTypeEnum """Id of the target currency.""" currencyId: ID """Free-text description shown alongside the target.""" description: String """ When true, the target is currently being tracked; when false, the target is a draft or has been deactivated. """ isActive: Boolean! """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ First date of the active target period. Set when isActive is true; recomputed from settings.period when activated. """ periodFrom: Date """Last date of the active target period.""" periodTo: Date """ Target configuration: period (year, quarter/month etc.), value, fragment breakdown and indicator inputs. Stored as a JSON document. This payload conforms to the `TargetsSettings` JSON Schema: GET /api/v100/rest/schemas/TargetsSettings.json on your region's API host """ settings: TargetsSettings! """Id of the assignee user.""" targetClientId: ID """ Kind of target: a User target for targetClient, a group target that is split into or combines user targets, or a Simulated what-if target. """ type: TargetTypeEnum """Revision when entity was lastly changed.""" revision: Int """Target value the user committed to for the current period.""" target: Float """ Start date of the target period, derived from periodType and periodYear. """ virtualPeriodFrom: Date """End date of the target period, derived from periodType and periodYear.""" virtualPeriodTo: Date """ Whole days remaining until the target period ends, or zero once the period is past. """ daysLeft: Int! """ Progress state of the target: Draft until it is activated, then NotStarted before its period begins, InProgress while the period runs, and Finished once it is marked finished or the period has ended. """ status: TargetStatusEnum """ Date the target was marked as finished. Empty until the target is closed. """ finishedDate: Date """ Projected end-of-period value extrapolated from progress to date. Used to compare against the committed target. """ estimatedTarget: Float """Calendar year the target period belongs to (e.g. 2026).""" periodYear: Int! """ Whether the target period follows the calendar year (CalendarYear) or the space's financial year (FinancialYear). Combined with periodYear to determine virtualPeriodFrom / virtualPeriodTo. """ periodType: TargetsPeriodTypeEnum! """Returns if current target has any non-deleted parent group target.""" hasParentGroupTarget: Boolean! """User-level child targets that aggregate into this group target.""" childTargets( """Filter Target relations by target Target attributes.""" filter: TargetFilterInput """ Filter TargetRelation relations by edge (relation) TargetRelation attributes. """ filterEdge: TargetRelationFilterInput """Order Target relations by target Target attributes.""" orderBy: [TargetOrderByInput!] """Returns deleted target records as well. Default is true.""" includeDeleted: Boolean = true """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TargetRelationEntityConnection """ Length of the fragments the target period is split into: the whole year (Year), quarters (Quarter) or months (Month). """ periodFragmentType: TargetsPeriodFragmentTypeEnum! """ Zero-based position of the current fragment within the parent period (e.g. fragment index 2 for the 3rd month in a yearly target split into monthly fragments). """ periodFragmentIndex: Int! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! """ Goal value to reach within the selected period; when the period covers only part of the target or forecast period, only the matching months count. """ targetGoal( """Period to compute the goal for; the whole period when omitted.""" period: PeriodOptionParams ): Int! """ Current sales performance indicators (qualification and win rates, deal size, sales cycle length) computed from the actual records in the target's scope. """ currentIndicators: TargetsIndicators! """ Progress of the target per period part (year, quarters, months); for a group target the values of its member targets are combined. """ currentMetrics( """ For a group target, limits the result to these member user targets; all members when omitted. """ includeChildIds: [UUID] ): [TargetsCurrentMetrics]! """ Value achieved toward the target so far; for a group target, the sum over its member user targets. """ currentTargetValue( """ For a group target, limits the result to these member user targets; all members when omitted. """ includeChildIds: [UUID] ): Float! """ Values of the selected metric over the target period, one series per user target (one per member for a group target). """ chartData( """Metric to chart.""" metric: TargetsMetricEnum! """Time step between the chart values.""" granularity: TargetsChartGranularityEnum! """ For a group target, limits the result to these member user targets; all members when omitted. """ includeChildIds: [UUID] ): [TargetsUserChartData!]! """ First and last day of the target period; null for group targets. An active target keeps the dates set on activation; a draft computes them from its period settings. """ absolutePeriod: TargetsAbsolutePeriod """ Returns if period.type and period.year can be updated - Child of inactive group is dependent on the group """ canUpdatePeriodTypeAndYear: Boolean! """ Returns if period.fragmentType can be updated - Child of inactive group is dependent on the group! """ canUpdatePeriodFragmentType: Boolean! """ Returns if settings.filter and settings.pipelineLeadProcessId can be changed - Child of inactive group is dependent on the group """ canChangeFilterSettings: Boolean! """Indicate if targetClient can be changed.""" canChangeTargetClient: Boolean! """ Expected results (created, qualified and closed leads, won opportunities and amount) derived from the indicators set in the target's settings. """ simulatedIndicators: SimulatedTargetIndicators! } """What a target measures.""" enum TargetCalculationTypeEnum { """Value of opportunities won in the target period.""" Revenue """Number of leads qualified in the target period.""" LeadQualified """Number of leads created in the target period.""" LeadCreated } """Kind of sales target.""" enum TargetTypeEnum { """Target assigned to a single user.""" User """ Group target that defines the settings and is split into user targets for its members. """ GroupFromUser """Group target that combines existing user targets.""" GroupFromExisting """What-if target used to simulate the activity needed to reach a goal.""" Simulated } """Progress state of a target.""" enum TargetStatusEnum { """The target has not been activated yet.""" Draft """The target is active but its period has not begun.""" NotStarted """The target is active and its period is running.""" InProgress """The target was marked finished or its period has ended.""" Finished } """Paginated list of TargetRelation records.""" type TargetRelationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TargetRelationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TargetRelationEntity` and its cursor.""" type TargetRelationEntityEdge { """The item at the end of the edge""" node: TargetRelationEntity """A cursor for use in pagination""" cursor: String! } """Link between a group target and a user target that rolls up into it.""" type TargetRelationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent group target that aggregates the user target.""" groupTarget: TargetEntity """Child user target rolling up into the group target.""" userTarget: TargetEntity """Id of the parent group target that aggregates the user target.""" groupTargetId: ID! """Id of the user target that rolls up into the group target.""" userTargetId: ID! """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for Target records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TargetFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TargetFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TargetFilterInput!] """Matches records that do not meet this filter.""" NOT: TargetFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ What the target measures: revenue from opportunities won, or the number of leads qualified or created in the target period. """ calculationType: TargetCalculationTypeEnumFilterInput """Id of the target currency.""" currencyId: EntityFilterStringField """Free-text description shown alongside the target.""" description: EntityFilterStringField """ When true, the target is currently being tracked; when false, the target is a draft or has been deactivated. """ isActive: Boolean """Name of the entity and its default text representation.""" name: EntityFilterStringField """Id of the owning user.""" ownerId: EntityFilterStringField """Id of the assignee user.""" targetClientId: EntityFilterStringField """ Kind of target: a User target for targetClient, a group target that is split into or combines user targets, or a Simulated what-if target. """ type: TargetTypeEnumFilterInput """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """Target value the user committed to for the current period.""" target: Float """ Start date of the target period, derived from periodType and periodYear. """ virtualPeriodFrom: Date """End date of the target period, derived from periodType and periodYear.""" virtualPeriodTo: Date """ Whole days remaining until the target period ends, or zero once the period is past. """ daysLeft: Int """ Progress state of the target: Draft until it is activated, then NotStarted before its period begins, InProgress while the period runs, and Finished once it is marked finished or the period has ended. """ status: TargetStatusEnum """ Date the target was marked as finished. Empty until the target is closed. """ finishedDate: Date """ Projected end-of-period value extrapolated from progress to date. Used to compare against the committed target. """ estimatedTarget: Float """Calendar year the target period belongs to (e.g. 2026).""" periodYear: Int """ Whether the target period follows the calendar year (CalendarYear) or the space's financial year (FinancialYear). Combined with periodYear to determine virtualPeriodFrom / virtualPeriodTo. """ periodType: TargetsPeriodTypeEnum """ True when this target is rolled up into a parent group target (e.g. a team-level target aggregating its members). Read-only. """ hasParentGroupTarget: Boolean """ Length of the fragments the target period is split into: the whole year (Year), quarters (Quarter) or months (Month). """ periodFragmentType: TargetsPeriodFragmentTypeEnum """ Zero-based position of the current fragment within the parent period (e.g. fragment index 2 for the 3rd month in a yearly target split into monthly fragments). """ periodFragmentIndex: Int """ Currency the target value is expressed in. Required when calculationType is a currency-based metric. Matches records where a related record meets these conditions. """ currency: CurrencyFilterInput """ User who owns the target. Matches records where a related record meets these conditions. """ owner: ClientFilterInput """ User the target is set on (the assignee). Required for User-type targets; null for group targets. Matches records where a related record meets these conditions. """ targetClient: ClientFilterInput """ User-level child targets that aggregate into this group target. Matches records where a related record meets these conditions. """ childTargets: TargetRelationFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input TargetCalculationTypeEnumFilterInput { """Matches any of the listed values.""" eq: [TargetCalculationTypeEnum!] """Matches values that do not meet this condition.""" NOT: TargetCalculationTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input TargetTypeEnumFilterInput { """Matches any of the listed values.""" eq: [TargetTypeEnum!] """Matches values that do not meet this condition.""" NOT: TargetTypeEnumFilterInput } """ Filter conditions for TargetRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TargetRelationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TargetRelationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TargetRelationFilterInput!] """Matches records that do not meet this filter.""" NOT: TargetRelationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the parent group target that aggregates the user target.""" groupTargetId: EntityFilterStringField """Id of the user target that rolls up into the group target.""" userTargetId: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Parent group target that aggregates the user target. Matches records where a related record meets these conditions. """ groupTarget: TargetFilterInput """ Child user target rolling up into the group target. Matches records where a related record meets these conditions. """ userTarget: TargetFilterInput } """ Sorting of Target records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TargetOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who owns the target. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ User the target is set on (the assignee). Required for User-type targets; null for group targets. Sorts by fields of the related record, listed in order of priority. """ targetClient: [ClientOrderByNestedInput!] """ What the target measures: revenue from opportunities won, or the number of leads qualified or created in the target period. """ calculationType: OrderByEnum """Free-text description shown alongside the target.""" description: OrderByEnum """ When true, the target is currently being tracked; when false, the target is a draft or has been deactivated. """ isActive: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ First date of the active target period. Set when isActive is true; recomputed from settings.period when activated. """ periodFrom: OrderByEnum """Last date of the active target period.""" periodTo: OrderByEnum """Id of the assignee user.""" targetClientId: OrderByEnum """ Kind of target: a User target for targetClient, a group target that is split into or combines user targets, or a Simulated what-if target. """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """Target value the user committed to for the current period.""" target: OrderByEnum """ Start date of the target period, derived from periodType and periodYear. """ virtualPeriodFrom: OrderByEnum """End date of the target period, derived from periodType and periodYear.""" virtualPeriodTo: OrderByEnum """ Whole days remaining until the target period ends, or zero once the period is past. """ daysLeft: OrderByEnum """ Progress state of the target: Draft until it is activated, then NotStarted before its period begins, InProgress while the period runs, and Finished once it is marked finished or the period has ended. """ status: OrderByEnum """ Date the target was marked as finished. Empty until the target is closed. """ finishedDate: OrderByEnum """ Projected end-of-period value extrapolated from progress to date. Used to compare against the committed target. """ estimatedTarget: OrderByEnum """Calendar year the target period belongs to (e.g. 2026).""" periodYear: OrderByEnum """ Whether the target period follows the calendar year (CalendarYear) or the space's financial year (FinancialYear). Combined with periodYear to determine virtualPeriodFrom / virtualPeriodTo. """ periodType: OrderByEnum """ True when this target is rolled up into a parent group target (e.g. a team-level target aggregating its members). Read-only. """ hasParentGroupTarget: OrderByEnum """ Length of the fragments the target period is split into: the whole year (Year), quarters (Quarter) or months (Month). """ periodFragmentType: OrderByEnum """ Zero-based position of the current fragment within the parent period (e.g. fragment index 2 for the 3rd month in a yearly target split into monthly fragments). """ periodFragmentIndex: OrderByEnum } """ Progress of a target in one part of its period (the year, a quarter, month or week): the lead and opportunity counts and values achieved so far. """ type TargetsCurrentMetrics { """ Share of the working time of the period that has elapsed as of today, from 0 to 1. """ relativeRate: Float! """ Part of the target period the metrics cover: the year, or the current quarter, month or week. """ period: TargetsMetricPeriodEnum """ Number of the covered part: the year for Year, 1-4 for Quarter, 1-12 for Month, or the week number within the target year for Week. """ periodIndex: Int! """ Value of the won opportunities closed in the period, in the target currency; revenue targets only. """ quota: Float """Number of leads created in the period.""" leadsNew: Int """Number of leads qualified in the period.""" leadsQualified: Int """ Number of won opportunities closed in the period; revenue targets only. """ opportunitiesWon: Int """Number of opportunities created in the period; revenue targets only.""" opportunitiesNew: Int """ Total value of open and won opportunities closing in the period, in the target currency; revenue targets only. """ unweightedTarget: Float """Currently the same value as unweightedTarget; revenue targets only.""" unweightedTargetByVelocity: Float } """Period length used when breaking target metrics down.""" enum TargetsMetricPeriodEnum { """Targets are broken down by year.""" Year """Targets are broken down by quarter.""" Quarter """Targets are broken down by month.""" Month """Targets are broken down by week.""" Week } """ Chart series of one user target: the values of a metric over the target period. """ type TargetsUserChartData { """Id of the user target the series belongs to.""" targetId: UUID! """Metric values, one per chart step over the target period.""" values: [TargetsChartValue!]! } """Value of a target metric in one step of a target chart.""" type TargetsChartValue { """Start date of the chart step.""" date: Date! """ Number of the step: the month (1-12) for Monthly, the week number for Weekly, otherwise its position starting at 1. """ index: Int! """Metric value in the step; 0 when there is none.""" value: Float! } """Metric reported for a target over its periods and used for drill-down.""" enum TargetsMetricEnum { """Value of won opportunities closing within the period.""" Quota """Number of leads created.""" LeadsNew """Number of leads qualified.""" LeadsQualified """Number of won opportunities closing within the period.""" OpportunitiesWon """Number of opportunities created directly.""" OpportunitiesNew """Full value of open and won opportunities closing within the period.""" UnweightedTarget """ Full value of open and won opportunities closing within the period, as used for the velocity projection. """ UnweightedTargetByVelocity } """Start and end dates of a target's period.""" type TargetsAbsolutePeriod { """First day of the target period.""" periodFrom: Date! """Last day of the target period.""" periodTo: Date! } """ Expected results of a target derived from its indicators: leads created, qualified and closed, and opportunities closed, won and their value. """ type SimulatedTargetIndicators { """ Target value: the won amount for revenue targets, or the number of leads to create or qualify for lead targets. """ target: Float! """Expected number of leads closed (qualified or lost) in the period.""" leadClosedCount: Int """Expected number of leads created in the period.""" leadCreatedCount: Int """Expected number of leads qualified in the period.""" leadQualifiedCount: Int """Expected number of opportunities closed (won or lost) in the period.""" opportunityClosedCount: Int """Expected number of won opportunities in the period.""" opportunityWonCount: Int """ Expected value of the won opportunities in the period, in the target currency. """ opportunityWonAmount: Float """Average rate at which opportunity value is won over time.""" opportunityAverageVelocity: Float } """Paginated list of Target records.""" type TargetEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TargetEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TargetEntity` and its cursor.""" type TargetEntityEdge { """The item at the end of the edge""" node: TargetEntity """A cursor for use in pagination""" cursor: String! } """Read operations for TargetRelation records.""" type TargetRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TargetRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TargetRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TargetRelationFilterInput """Sorting of the returned records.""" orderBy: [TargetRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TargetRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TargetRelationFilterInput """Sorting of the returned records.""" orderBy: [TargetRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TargetRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of TargetRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TargetRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Parent group target that aggregates the user target. Sorts by fields of the related record, listed in order of priority. """ groupTarget: [TargetOrderByNestedInput!] """ Child user target rolling up into the group target. Sorts by fields of the related record, listed in order of priority. """ userTarget: [TargetOrderByNestedInput!] """Id of the parent group target that aggregates the user target.""" groupTargetId: OrderByEnum """Id of the user target that rolls up into the group target.""" userTargetId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """ Sorting by a field of the related Target record. Set exactly one field in each item. """ input TargetOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ What the target measures: revenue from opportunities won, or the number of leads qualified or created in the target period. """ calculationType: OrderByEnum """Free-text description shown alongside the target.""" description: OrderByEnum """ When true, the target is currently being tracked; when false, the target is a draft or has been deactivated. """ isActive: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """Id of the owning user.""" ownerId: OrderByEnum """ First date of the active target period. Set when isActive is true; recomputed from settings.period when activated. """ periodFrom: OrderByEnum """Last date of the active target period.""" periodTo: OrderByEnum """Id of the assignee user.""" targetClientId: OrderByEnum """ Kind of target: a User target for targetClient, a group target that is split into or combines user targets, or a Simulated what-if target. """ type: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum """Target value the user committed to for the current period.""" target: OrderByEnum """ Start date of the target period, derived from periodType and periodYear. """ virtualPeriodFrom: OrderByEnum """End date of the target period, derived from periodType and periodYear.""" virtualPeriodTo: OrderByEnum """ Whole days remaining until the target period ends, or zero once the period is past. """ daysLeft: OrderByEnum """ Progress state of the target: Draft until it is activated, then NotStarted before its period begins, InProgress while the period runs, and Finished once it is marked finished or the period has ended. """ status: OrderByEnum """ Date the target was marked as finished. Empty until the target is closed. """ finishedDate: OrderByEnum """ Projected end-of-period value extrapolated from progress to date. Used to compare against the committed target. """ estimatedTarget: OrderByEnum """Calendar year the target period belongs to (e.g. 2026).""" periodYear: OrderByEnum """ Whether the target period follows the calendar year (CalendarYear) or the space's financial year (FinancialYear). Combined with periodYear to determine virtualPeriodFrom / virtualPeriodTo. """ periodType: OrderByEnum """ True when this target is rolled up into a parent group target (e.g. a team-level target aggregating its members). Read-only. """ hasParentGroupTarget: OrderByEnum """ Length of the fragments the target period is split into: the whole year (Year), quarters (Quarter) or months (Month). """ periodFragmentType: OrderByEnum """ Zero-based position of the current fragment within the parent period (e.g. fragment index 2 for the 3rd month in a yearly target split into monthly fragments). """ periodFragmentIndex: OrderByEnum } """Read operations for Task records.""" type TaskRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TaskEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TaskEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TaskFilterInput """Sorting of the returned records.""" orderBy: [TaskOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TaskEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TaskFilterInput """Sorting of the returned records.""" orderBy: [TaskOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. """ getBySession( """Ids of records to add to the selection.""" includedIds: [UUID!]! """Ids of records to remove from the selection.""" excludedIds: [UUID!]! """ Id of the list or report result to take the records from. Pass an empty string to select only the included ids. """ sessionId: String! """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskEntityConnection """ Returns the values of a record's fields formatted for display, keyed by field id. """ getByIdFormatted( """Id of the record.""" id: UUID! """Ids of the fields to return; null returns all fields.""" fieldIds: [UUID!] ): JSONString """ Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. """ autoPrefill( """ Field mapping that defines how values are copied from the source record. """ mappingId: UUID! """Id of the source record the values are taken from.""" entityId: UUID! """ Type of the new record (e.g. opportunity type); applies the mapping rules defined for that source/target type pair. """ targetEntityTypeId: UUID ): TaskEntity! """ Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. """ aiAutoPrefill( """ Id of the suggested action, as returned by the AI record suggestions or AI chat. """ actionId: String! ): TaskAutoPrefill! """ Returns a new, unsaved task pre-filled from an email conversation: subject and description from the last sent email of the conversation that the user can read, the records linked to the conversation (including ones the user cannot open) and its attachments as documents. Nothing is saved. """ autoPrefillFromEmail( """Id of any email of the conversation.""" emailId: UUID! """ Mailbox the conversation was opened in; limits the conversation to that mailbox. It must be a mailbox the user can use. """ mailboxId: UUID ): TaskAutoPrefill! } """Paginated list of Task records.""" type TaskEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TaskEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TaskEntity` and its cursor.""" type TaskEntityEdge { """The item at the end of the edge""" node: TaskEntity """A cursor for use in pagination""" cursor: String! } """ New, unsaved task pre-filled by AI or from an email conversation, with the ids of the fields that were filled in. """ type TaskAutoPrefill { """New task carrying the pre-filled values; it is not saved.""" entity: TaskEntity """Ids of the fields that were filled in.""" fieldIds: [UUID!]! } """Read operations for TaskRecurrence records.""" type TaskRecurrenceRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TaskRecurrenceEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TaskRecurrenceEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TaskRecurrenceFilterInput """Sorting of the returned records.""" orderBy: [TaskRecurrenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TaskRecurrenceEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TaskRecurrenceFilterInput """Sorting of the returned records.""" orderBy: [TaskRecurrenceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskRecurrenceEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of TaskRecurrence records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TaskRecurrenceOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Task this recurrence belongs to. Each recurrence is bound to exactly one task. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: OrderByEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: OrderByEnum """ Date information. The last date when no more other items should be created. """ endDate: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: OrderByEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: OrderByEnum """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: OrderByEnum """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: OrderByEnum """Id of the parent task.""" taskId: OrderByEnum """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: OrderByEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of TaskRecurrence records.""" type TaskRecurrenceEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TaskRecurrenceEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TaskRecurrenceEntity` and its cursor.""" type TaskRecurrenceEntityEdge { """The item at the end of the edge""" node: TaskRecurrenceEntity """A cursor for use in pagination""" cursor: String! } """Read operations for TaskReminder records.""" type TaskReminderRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TaskReminderEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TaskReminderEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TaskReminderFilterInput """Sorting of the returned records.""" orderBy: [TaskReminderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TaskReminderEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TaskReminderFilterInput """Sorting of the returned records.""" orderBy: [TaskReminderOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskReminderEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of TaskReminder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TaskReminderOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User who set this reminder. Reminders are per-user. Sorts by fields of the related record, listed in order of priority. """ owner: [ClientOrderByNestedInput!] """ Task this reminder belongs to. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """Id of the user who set the reminder.""" ownerId: OrderByEnum """Timestamp when the reminder should fire.""" setDate: OrderByEnum """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: OrderByEnum """Id of the task this reminder belongs to.""" taskId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of TaskReminder records.""" type TaskReminderEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TaskReminderEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TaskReminderEntity` and its cursor.""" type TaskReminderEntityEdge { """The item at the end of the edge""" node: TaskReminderEntity """A cursor for use in pagination""" cursor: String! } """Read operations for TaskSharingClientRelation records.""" type TaskSharingClientRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TaskSharingClientRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TaskSharingClientRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TaskSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [TaskSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TaskSharingClientRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TaskSharingClientRelationFilterInput """Sorting of the returned records.""" orderBy: [TaskSharingClientRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskSharingClientRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of TaskSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TaskSharingClientRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ User the task is shared with. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """ Task being shared. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """Id of the user.""" clientId: OrderByEnum """ Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the shared task.""" taskId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for TaskSharingSalesUnitRelation records.""" type TaskSharingSalesUnitRelationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TaskSharingSalesUnitRelationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TaskSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TaskSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [TaskSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TaskSharingSalesUnitRelationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TaskSharingSalesUnitRelationFilterInput """Sorting of the returned records.""" orderBy: [TaskSharingSalesUnitRelationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskSharingSalesUnitRelationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of TaskSharingSalesUnitRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TaskSharingSalesUnitRelationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Task being shared. Sorts by fields of the related record, listed in order of priority. """ task: [TaskOrderByNestedInput!] """ Sales unit the task is shared with. Sorts by fields of the related record, listed in order of priority. """ unit: [SalesUnitOrderByNestedInput!] """ Access the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it. """ role: OrderByEnum """Id of the shared task.""" taskId: OrderByEnum """Id of the sales unit.""" unitId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for TaskType records.""" type TaskTypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TaskTypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TaskTypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TaskTypeFilterInput """Sorting of the returned records.""" orderBy: [TaskTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TaskTypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TaskTypeFilterInput """Sorting of the returned records.""" orderBy: [TaskTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TaskTypeEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TaskTypeFilterInput """Sorting of the returned records.""" orderBy: [TaskTypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TaskTypeEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: TaskTypeFilterInput """Sorting of the returned records.""" orderBy: [TaskTypeOrderByInput!] ): [TaskTypeEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): TaskTypeEntity! } """Paginated list of TaskType records.""" type TaskTypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TaskTypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TaskTypeEntity` and its cursor.""" type TaskTypeEntityEdge { """The item at the end of the edge""" node: TaskTypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for TextMessage records.""" type TextMessageRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TextMessageEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TextMessageEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TextMessageFilterInput """Sorting of the returned records.""" orderBy: [TextMessageOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TextMessageEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TextMessageFilterInput """Sorting of the returned records.""" orderBy: [TextMessageOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Read operations for TextMessageConversation records.""" type TextMessageConversationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TextMessageConversationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TextMessageConversationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TextMessageConversationFilterInput """Sorting of the returned records.""" orderBy: [TextMessageConversationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TextMessageConversationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TextMessageConversationFilterInput """Sorting of the returned records.""" orderBy: [TextMessageConversationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! """ Returns the current user's text message conversation with the given phone number, or null when there is none. The user must have a personal SMS number; otherwise an error is returned. """ getByPhone( """Phone number of the other party, preferably in international format.""" phoneNumber: String! """ Country of the phone number (ISO code or name), used to read a number given without the international prefix. """ country: String! ): TextMessageConversationEntity """ Returns the messages of the text message conversation that were added or changed after the given time, so a client can poll for new messages. Returns an empty list when no time is given. """ pollMessages( """Id of the conversation and the time to return changes after.""" input: PollMessagesInput! ): [TextMessageEntity!]! } """ Sorting of TextMessageConversation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TextMessageConversationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Coevera phone number used as the sender side of the conversation. Sorts by fields of the related record, listed in order of priority. """ phone: [PhoneOrderByNestedInput!] """ Account record matched to the recipient phone, when one exists. Sorts by fields of the related record, listed in order of priority. """ recipientAccount: [AccountOrderByNestedInput!] """ Contact record matched to the recipient phone, when one exists. Sorts by fields of the related record, listed in order of priority. """ recipientContact: [ContactOrderByNestedInput!] """Id of the sender phone.""" phoneId: OrderByEnum """Id of the matched account.""" recipientAccountId: OrderByEnum """Id of the matched contact.""" recipientContactId: OrderByEnum """ External phone number of the conversation recipient. Cannot be changed once the conversation has started. """ recipientPhoneNumber: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of TextMessageConversation records.""" type TextMessageConversationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TextMessageConversationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """ A Relay edge containing a `TextMessageConversationEntity` and its cursor. """ type TextMessageConversationEntityEdge { """The item at the end of the edge""" node: TextMessageConversationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for TextMessageConversationRelations records.""" type TextMessageConversationRelationsRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TextMessageConversationRelationsEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TextMessageConversationRelationsEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TextMessageConversationRelationsFilterInput """Sorting of the returned records.""" orderBy: [TextMessageConversationRelationsOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TextMessageConversationRelationsEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TextMessageConversationRelationsFilterInput """Sorting of the returned records.""" orderBy: [TextMessageConversationRelationsOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TextMessageConversationRelationsEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Sorting of TextMessageConversationRelations records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TextMessageConversationRelationsOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account the conversation is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority. """ account: [AccountOrderByNestedInput!] """ Contact the conversation is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority. """ contact: [ContactOrderByNestedInput!] """ Lead the conversation is linked to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity the conversation is linked to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Project the conversation is linked to. Sorts by fields of the related record, listed in order of priority. """ project: [ProjectOrderByNestedInput!] """ Quote the conversation is linked to. Sorts by fields of the related record, listed in order of priority. """ quote: [QuoteOrderByNestedInput!] """ Conversation this link belongs to. Sorts by fields of the related record, listed in order of priority. """ textMessageConversation: [TextMessageConversationOrderByNestedInput!] """Id of the linked account.""" accountId: OrderByEnum """Id of the linked contact.""" contactId: OrderByEnum """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: OrderByEnum """Id of the linked project, or empty when not linked.""" projectId: OrderByEnum """Id of the linked quote, or empty when not linked.""" quoteId: OrderByEnum """Id of the text message conversation this link belongs to.""" textMessageConversationId: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Read operations for Timeframe records.""" type TimeframeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TimeframeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TimeframeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TimeframeFilterInput """Sorting of the returned records.""" orderBy: [TimeframeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TimeframeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TimeframeFilterInput """Sorting of the returned records.""" orderBy: [TimeframeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TimeframeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Time a lead or opportunity has spent in a pipeline step.""" type TimeframeEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Lead this step-time record belongs to. Set when leadOpptyId resolves to a Lead. """ lead: LeadEntity """ Opportunity this step-time record belongs to. Set when leadOpptyId resolves to an Opportunity. """ oppty: OpportunityEntity """Pipeline step the lead/opportunity entered.""" step: StepEntity """Id of the lead or opportunity the timeframe belongs to.""" leadOpptyId: ID! """Id of the pipeline step.""" stepId: ID! """ Number of seconds the record spent in the step (cumulative across re-entries). """ timeframe: Int! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for Timeframe records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TimeframeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TimeframeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TimeframeFilterInput!] """Matches records that do not meet this filter.""" NOT: TimeframeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the lead or opportunity the timeframe belongs to.""" leadOpptyId: EntityFilterStringField """Id of the pipeline step.""" stepId: EntityFilterStringField """ Number of seconds the record spent in the step (cumulative across re-entries). """ timeframe: EntityFilterNumberField """ Lead this step-time record belongs to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. """ lead: LeadFilterInput """ Opportunity this step-time record belongs to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. """ oppty: OpportunityFilterInput """ Pipeline step the lead/opportunity entered. Matches records where a related record meets these conditions. """ step: StepFilterInput } """ Sorting of Timeframe records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TimeframeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Lead this step-time record belongs to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. """ lead: [LeadOrderByNestedInput!] """ Opportunity this step-time record belongs to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. """ oppty: [OpportunityOrderByNestedInput!] """ Pipeline step the lead/opportunity entered. Sorts by fields of the related record, listed in order of priority. """ step: [StepOrderByNestedInput!] """Id of the lead or opportunity the timeframe belongs to.""" leadOpptyId: OrderByEnum """Id of the pipeline step.""" stepId: OrderByEnum """ Number of seconds the record spent in the step (cumulative across re-entries). """ timeframe: OrderByEnum } """Paginated list of Timeframe records.""" type TimeframeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TimeframeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TimeframeEntity` and its cursor.""" type TimeframeEntityEdge { """The item at the end of the edge""" node: TimeframeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Translation records.""" type TranslationRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TranslationEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TranslationEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TranslationFilterInput """Sorting of the returned records.""" orderBy: [TranslationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TranslationEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TranslationFilterInput """Sorting of the returned records.""" orderBy: [TranslationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TranslationEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TranslationFilterInput """Sorting of the returned records.""" orderBy: [TranslationOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TranslationEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: TranslationFilterInput """Sorting of the returned records.""" orderBy: [TranslationOrderByInput!] ): [TranslationEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): TranslationEntity! } """ Translation of a field name, dropdown option or form text into the supported languages. """ type TranslationEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account type the form-level translation applies to.""" accountType: AccountTypeEntity """Appointment type the form-level translation applies to.""" appointmentType: AppointmentTypeEntity """Contact type the form-level translation applies to.""" contactType: ContactTypeEntity """ Data option (dropdown/radio choice) this row translates. Set when labelType is Data. """ data: DataEntity """ Field whose name/label this row translates. Set when labelType is Field, FormField, or FormDescription. """ field: FieldEntity """Lead type the form-level translation applies to.""" leadType: LeadTypeEntity """ Opportunity product relation type the form-level translation applies to. """ opptyProductRelationType: OpptyProductRelationTypeEntity """Opportunity type the form-level translation applies to.""" opptyType: OpportunityTypeEntity """Product type the form-level translation applies to.""" productType: ProductTypeEntity """Project type the form-level translation applies to.""" projectType: ProjectTypeEntity """Task type the form-level translation applies to.""" taskType: TaskTypeEntity """ Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ accountTypeId: ID """ Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ appointmentTypeId: ID """ Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ contactTypeId: ID """Id of the translated data option.""" dataId: ID """Translated text in German.""" deDe: String """Translated text in US English.""" enUs: String """Translated text in Spanish.""" esEs: String """Id of the translated field.""" fieldId: ID """ Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription. """ formType: FormTypeEnum """ Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription). """ labelType: TranslationLabelTypeEnum! """ Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ leadTypeId: ID """Id of the opportunity product relation type.""" opptyProductRelationTypeId: ID """Id of the opportunity type.""" opptyTypeId: ID """ Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ productTypeId: ID """ Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ projectTypeId: ID """Translated text in Brazilian Portuguese.""" ptBr: String """ Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ taskTypeId: ID """ True when the translation is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """Which form of a lead or opportunity type a setting applies to.""" enum FormTypeEnum { """The record detail (edit) form.""" Edit """The form shown when a lead or opportunity is marked as lost.""" Lost } """Kind of text a translation entry translates.""" enum TranslationLabelTypeEnum { """Name of a field.""" Field """Option of a dropdown or radio field.""" Data """Label of a field on the form of a specific record type.""" FormField """Description of a field on the form of a specific record type.""" FormDescription } """ Filter conditions for Translation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TranslationFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TranslationFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TranslationFilterInput!] """Matches records that do not meet this filter.""" NOT: TranslationFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ accountTypeId: EntityFilterStringField """ Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ appointmentTypeId: EntityFilterStringField """ Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ contactTypeId: EntityFilterStringField """Id of the translated data option.""" dataId: EntityFilterStringField """Translated text in German.""" deDe: EntityFilterStringField """Translated text in US English.""" enUs: EntityFilterStringField """Translated text in Spanish.""" esEs: EntityFilterStringField """Id of the translated field.""" fieldId: EntityFilterStringField """ Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription. """ formType: FormTypeEnumFilterInput """ Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription). """ labelType: TranslationLabelTypeEnumFilterInput """ Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ leadTypeId: EntityFilterStringField """Id of the opportunity product relation type.""" opptyProductRelationTypeId: EntityFilterStringField """Id of the opportunity type.""" opptyTypeId: EntityFilterStringField """ Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ productTypeId: EntityFilterStringField """ Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ projectTypeId: EntityFilterStringField """Translated text in Brazilian Portuguese.""" ptBr: EntityFilterStringField """ Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ taskTypeId: EntityFilterStringField """ True when the translation is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField """ Account type the form-level translation applies to. Matches records where a related record meets these conditions. """ accountType: AccountTypeFilterInput """ Appointment type the form-level translation applies to. Matches records where a related record meets these conditions. """ appointmentType: AppointmentTypeFilterInput """ Contact type the form-level translation applies to. Matches records where a related record meets these conditions. """ contactType: ContactTypeFilterInput """ Data option (dropdown/radio choice) this row translates. Set when labelType is Data. Matches records where a related record meets these conditions. """ data: DataFilterInput """ Field whose name/label this row translates. Set when labelType is Field, FormField, or FormDescription. Matches records where a related record meets these conditions. """ field: FieldFilterInput """ Lead type the form-level translation applies to. Matches records where a related record meets these conditions. """ leadType: LeadTypeFilterInput """ Opportunity product relation type the form-level translation applies to. Matches records where a related record meets these conditions. """ opptyProductRelationType: OpptyProductRelationTypeFilterInput """ Opportunity type the form-level translation applies to. Matches records where a related record meets these conditions. """ opptyType: OpportunityTypeFilterInput """ Product type the form-level translation applies to. Matches records where a related record meets these conditions. """ productType: ProductTypeFilterInput """ Project type the form-level translation applies to. Matches records where a related record meets these conditions. """ projectType: ProjectTypeFilterInput """ Task type the form-level translation applies to. Matches records where a related record meets these conditions. """ taskType: TaskTypeFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input FormTypeEnumFilterInput { """Matches any of the listed values.""" eq: [FormTypeEnum!] """Matches values that do not meet this condition.""" NOT: FormTypeEnumFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input TranslationLabelTypeEnumFilterInput { """Matches any of the listed values.""" eq: [TranslationLabelTypeEnum!] """Matches values that do not meet this condition.""" NOT: TranslationLabelTypeEnumFilterInput } """ Sorting of Translation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TranslationOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Account type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ accountType: [AccountTypeOrderByNestedInput!] """ Appointment type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ appointmentType: [AppointmentTypeOrderByNestedInput!] """ Contact type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ contactType: [ContactTypeOrderByNestedInput!] """ Data option (dropdown/radio choice) this row translates. Set when labelType is Data. Sorts by fields of the related record, listed in order of priority. """ data: [DataOrderByNestedInput!] """ Field whose name/label this row translates. Set when labelType is Field, FormField, or FormDescription. Sorts by fields of the related record, listed in order of priority. """ field: [FieldOrderByNestedInput!] """ Lead type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ leadType: [LeadTypeOrderByNestedInput!] """ Opportunity product relation type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ opptyProductRelationType: [OpptyProductRelationTypeOrderByNestedInput!] """ Opportunity type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ opptyType: [OpportunityTypeOrderByNestedInput!] """ Product type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ productType: [ProductTypeOrderByNestedInput!] """ Project type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ projectType: [ProjectTypeOrderByNestedInput!] """ Task type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority. """ taskType: [TaskTypeOrderByNestedInput!] """ Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ accountTypeId: OrderByEnum """ Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ appointmentTypeId: OrderByEnum """ Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ contactTypeId: OrderByEnum """Id of the translated data option.""" dataId: OrderByEnum """Translated text in German.""" deDe: OrderByEnum """Translated text in US English.""" enUs: OrderByEnum """Translated text in Spanish.""" esEs: OrderByEnum """Id of the translated field.""" fieldId: OrderByEnum """ Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription. """ formType: OrderByEnum """ Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription). """ labelType: OrderByEnum """ Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ leadTypeId: OrderByEnum """Id of the opportunity product relation type.""" opptyProductRelationTypeId: OrderByEnum """Id of the opportunity type.""" opptyTypeId: OrderByEnum """ Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ productTypeId: OrderByEnum """ Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ projectTypeId: OrderByEnum """Translated text in Brazilian Portuguese.""" ptBr: OrderByEnum """ Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ taskTypeId: OrderByEnum """ True when the translation is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Translation records.""" type TranslationEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TranslationEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TranslationEntity` and its cursor.""" type TranslationEntityEdge { """The item at the end of the edge""" node: TranslationEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Type records.""" type TypeRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): TypeEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [TypeEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: TypeFilterInput """Sorting of the returned records.""" orderBy: [TypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [TypeEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: TypeFilterInput """Sorting of the returned records.""" orderBy: [TypeOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): TypeEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Filter conditions for Type records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input TypeFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [TypeFilterInput!] """Matches records that meet all of the listed filters.""" AND: [TypeFilterInput!] """Matches records that do not meet this filter.""" NOT: TypeFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """ Underlying data type of values of this field type, such as STRING, DECIMAL or DATETIME. Read-only. """ primitiveType: PrimitiveTypeFilterInput """ What fields of this type can do, as a sum of flags: 1 - can be a custom field, 2 - can have a calculation formula, 4 - can have a default value, 8 - can be shown on mobile, 16 - needs a field mapping, 32 - cannot be placed on forms, 64 - can be read-only on forms, 128 - only on the main form, 256 - can be used in calculation formulas, 512 - must stay on the form, 1024 - searchable in global search, 2048 - needs a calculation formula, 4096 - can be used in advanced calculation formulas. """ flag: EntityFilterNumberField """ Default value applied to fields of this type when no value is supplied at create-time. Empty when the type has no default. """ defaultValue: EntityFilterStringField """ Whether fields of this type hold a plain value (NO_RELATION), a reference to one related record (MANY_TO_ONE_SCALAR) or a collection of related records (MANY_TO_MANY_VECTOR). """ relationType: RelationTypeFilterInput """ Maximum length or capacity for fields of this type (e.g. string max-length). """ containerSize: EntityFilterNumberField """ True when fields of this type can be used as a grouping column in reports. """ isGroupable: Boolean """True when fields of this type can be used in filters.""" isFilterable: Boolean """True when fields of this type can be used to sort records.""" isSortable: Boolean """True when fields of this type can be selected in queries.""" isSelectable: Boolean } """ Conditions on an enumeration field. Several conditions given together must all match. """ input PrimitiveTypeFilterInput { """Matches any of the listed values.""" eq: [PrimitiveType!] """Matches values that do not meet this condition.""" NOT: PrimitiveTypeFilterInput } """ Conditions on an enumeration field. Several conditions given together must all match. """ input RelationTypeFilterInput { """Matches any of the listed values.""" eq: [RelationType!] """Matches values that do not meet this condition.""" NOT: RelationTypeFilterInput } """ Sorting of Type records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input TypeOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """ What fields of this type can do, as a sum of flags: 1 - can be a custom field, 2 - can have a calculation formula, 4 - can have a default value, 8 - can be shown on mobile, 16 - needs a field mapping, 32 - cannot be placed on forms, 64 - can be read-only on forms, 128 - only on the main form, 256 - can be used in calculation formulas, 512 - must stay on the form, 1024 - searchable in global search, 2048 - needs a calculation formula, 4096 - can be used in advanced calculation formulas. """ flag: OrderByEnum """ Default value applied to fields of this type when no value is supplied at create-time. Empty when the type has no default. """ defaultValue: OrderByEnum """ Maximum length or capacity for fields of this type (e.g. string max-length). """ containerSize: OrderByEnum """ True when fields of this type can be used as a grouping column in reports. """ isGroupable: OrderByEnum """True when fields of this type can be used in filters.""" isFilterable: OrderByEnum """True when fields of this type can be used to sort records.""" isSortable: OrderByEnum """True when fields of this type can be selected in queries.""" isSelectable: OrderByEnum } """Paginated list of Type records.""" type TypeEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [TypeEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `TypeEntity` and its cursor.""" type TypeEntityEdge { """The item at the end of the edge""" node: TypeEntity """A cursor for use in pagination""" cursor: String! } """Read operations for UnsubscribedPhone records.""" type UnsubscribedPhoneRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): UnsubscribedPhoneEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [UnsubscribedPhoneEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: UnsubscribedPhoneFilterInput """Sorting of the returned records.""" orderBy: [UnsubscribedPhoneOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [UnsubscribedPhoneEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: UnsubscribedPhoneFilterInput """Sorting of the returned records.""" orderBy: [UnsubscribedPhoneOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): UnsubscribedPhoneEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """Phone number that opted out of receiving text messages.""" type UnsubscribedPhoneEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Phone number that has unsubscribed from receiving SMS messages, in E.164 format. """ phone: String """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for UnsubscribedPhone records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input UnsubscribedPhoneFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [UnsubscribedPhoneFilterInput!] """Matches records that meet all of the listed filters.""" AND: [UnsubscribedPhoneFilterInput!] """Matches records that do not meet this filter.""" NOT: UnsubscribedPhoneFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Phone number that has unsubscribed from receiving SMS messages, in E.164 format. """ phone: EntityFilterStringField """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Sorting of UnsubscribedPhone records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input UnsubscribedPhoneOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Phone number that has unsubscribed from receiving SMS messages, in E.164 format. """ phone: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of UnsubscribedPhone records.""" type UnsubscribedPhoneEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [UnsubscribedPhoneEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `UnsubscribedPhoneEntity` and its cursor.""" type UnsubscribedPhoneEntityEdge { """The item at the end of the edge""" node: UnsubscribedPhoneEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Webhook records.""" type WebhookRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): WebhookEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [WebhookEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: WebhookFilterInput """Sorting of the returned records.""" orderBy: [WebhookOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [WebhookEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: WebhookFilterInput """Sorting of the returned records.""" orderBy: [WebhookOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): WebhookEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Registered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner. Recipient has to receive the webhook in 10 seconds and respond with HTTP 200 (2XX) status. On failed delivery it will be retried up to 10 times within 24 hours. If the receiving side will respond with HTTP 410 status, the webhook will be disabled. Webhook is also disabled when we receive HTTP timeout on 10th retry and there was no successful delivery in last 5 days. """ type WebhookEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ OAuth application that registered this webhook. Set automatically when the webhook is created using OAuth credentials; empty when a team-space API key was used. """ application: ApplicationEntity """ Client who defined the Webhook. Only those notifications are sent which this Client has permission to see. If empty, all space notification are send, even for events of private records. Value is automatically set to authenticated user who created the webhook. It is left empty if global team space API Credentials are used. """ client: ClientEntity """Id of the OAuth application that registered the Webhook.""" applicationId: ID """Id of the user who defined the Webhook.""" clientId: ID """ If True, remote side ssl certificate will not be validated when delivering notifications. """ insecureSsl: Boolean! "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttps://developers.coevera.com/reference/rest/\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n \"entity\": {\n \"Contact\": {\n \"expand\": [\n \"primary_account\",\n \"primary_contact\",\n \"task_relations.task\"\n ],\n \"load-only\": [\n \"id\",\n \"primary_account\",\n \"primary_contact.first_name\",\n \"task_relations.task\"\n ],\n \"filter\": {\n \"email1\": [\"test@example.com\", \"test@example.net\"],\n \"email2\": \"test@example.com\"\n },\n \"filter-op\": {\"email1\": \"eq\"}, # optional, default operator is eq\n \"on-field-change\": [\"email1\"]\n },\n \"Account\": {\n \"filter\": {\n \"owner_id\": [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n }\n }\n },\n \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}\n" options: JSONString """ Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. """ signature: ID """Target URL that webhook event payloads are POSTed to.""" url: String! """ Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space. """ events: [EventEnum!]! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Webhook event a webhook subscribes to, named ; deliveries report it in the Entity.Action form (for example Lead.Create), and the *All values subscribe to every event of their entity. """ enum EventEnum { """Subscribes to every event of every entity in this list.""" All """ Subscribes to every lead event: LeadCreate, LeadUpdate, LeadDelete, LeadBackToLead, LeadOwnerChanged, LeadDocumentLinked and LeadLost. """ LeadAll """Fires when a lead is created.""" LeadCreate """Fires when a lead is updated.""" LeadUpdate """Fires when a lead is deleted.""" LeadDelete """ Fires when an opportunity is moved back to a lead; the event carries the resulting lead. """ LeadBackToLead """ Fires when the owner of a lead changes, including when it is created with an owner other than the user who created it. """ LeadOwnerChanged """ Fires when a document is linked to a lead; the event includes the document as the related entity. """ LeadDocumentLinked """Fires when a lead is archived as lost.""" LeadLost """ Subscribes to every opportunity event: OpportunityCreate, OpportunityUpdate, OpportunityDelete, OpportunityMove, OpportunityQualify, OpportunityOwnerChanged, OpportunityDocumentLinked, OpportunityWon and OpportunityLost. """ OpportunityAll """Fires when an opportunity is created.""" OpportunityCreate """Fires when an opportunity is updated.""" OpportunityUpdate """Fires when an opportunity is deleted.""" OpportunityDelete """ Fires when an opportunity moves to a different sales step; winning an opportunity also raises this event. """ OpportunityMove """ Fires when a lead is qualified into an opportunity; the event carries the new opportunity. """ OpportunityQualify """ Fires when the owner of an opportunity changes, including when it is created with an owner other than the user who created it. """ OpportunityOwnerChanged """ Fires when a document is linked to an opportunity; the event includes the document as the related entity. """ OpportunityDocumentLinked """ Fires when an opportunity is created in or moved to the won step of its pipeline. """ OpportunityWon """ Fires when an opportunity is archived as lost without reaching the won step. """ OpportunityLost """ Subscribes to every contact event: ContactCreate, ContactUpdate, ContactDelete, ContactOwnerChanged and ContactDocumentLinked. """ ContactAll """Fires when a contact is created.""" ContactCreate """Fires when a contact is updated.""" ContactUpdate """Fires when a contact is deleted.""" ContactDelete """ Fires when the owner of a contact changes, including when it is created with an owner other than the user who created it. """ ContactOwnerChanged """ Fires when a document is linked to a contact; the event includes the document as the related entity. """ ContactDocumentLinked """ Subscribes to every account event: AccountCreate, AccountUpdate, AccountDelete, AccountOwnerChanged and AccountDocumentLinked. """ AccountAll """Fires when an account is created.""" AccountCreate """Fires when an account is updated.""" AccountUpdate """Fires when an account is deleted.""" AccountDelete """ Fires when the owner of an account changes, including when it is created with an owner other than the user who created it. """ AccountOwnerChanged """ Fires when a document is linked to an account; the event includes the document as the related entity. """ AccountDocumentLinked """ Subscribes to every task event: TaskCreate, TaskUpdate, TaskDelete, TaskOwnerChanged, TaskDocumentLinked and TaskComment. """ TaskAll """Fires when a task is created.""" TaskCreate """Fires when a task is updated.""" TaskUpdate """Fires when a task is deleted.""" TaskDelete """ Fires when the owner of a task changes, including when it is created with an owner other than the user who created it. """ TaskOwnerChanged """ Fires when a document is linked to a task; the event includes the document as the related entity. """ TaskDocumentLinked """Fires when a comment is added to a task.""" TaskComment """ Subscribes to every appointment event: AppointmentCreate, AppointmentUpdate, AppointmentDelete, AppointmentOwnerChanged, AppointmentDocumentLinked and AppointmentComment. """ AppointmentAll """Fires when an appointment is created.""" AppointmentCreate """Fires when an appointment is updated.""" AppointmentUpdate """Fires when an appointment is deleted.""" AppointmentDelete """ Fires when the owner of an appointment changes, including when it is created with an owner other than the user who created it. """ AppointmentOwnerChanged """ Fires when a document is linked to an appointment; the event includes the document as the related entity. """ AppointmentDocumentLinked """Fires when a comment is added to an appointment.""" AppointmentComment """ Legacy subscription to all message events; memo and email changes are delivered as Memo and Email events instead. """ MessageAll """ Legacy event that is no longer raised; use MemoCreate or EmailCreate instead. """ MessageCreate """ Legacy event that is no longer raised; use MemoUpdate or EmailUpdate instead. """ MessageUpdate """ Legacy event that is no longer raised; use MemoDelete or EmailDelete instead. """ MessageDelete """ Legacy event that is no longer raised; use MemoDocumentLinked or EmailDocumentLinked instead. """ MessageDocumentLinked """ Subscribes to every memo event: MemoCreate, MemoUpdate, MemoDelete, MemoDocumentLinked and MemoComment. """ MemoAll """Fires when a memo is created.""" MemoCreate """Fires when a memo is updated.""" MemoUpdate """Fires when a memo is deleted.""" MemoDelete """ Fires when a document is linked to a memo; the event includes the document as the related entity. """ MemoDocumentLinked """Fires when a comment is added to a memo.""" MemoComment """ Subscribes to every email event: EmailCreate, EmailUpdate, EmailDelete and EmailDocumentLinked. """ EmailAll """Fires when an email is created.""" EmailCreate """Fires when an email is updated.""" EmailUpdate """Fires when an email is deleted.""" EmailDelete """ Fires when a document is linked to an email; the event includes the document as the related entity. """ EmailDocumentLinked """ Subscribes to every opportunity product line event: OpptyProductRelationCreate, OpptyProductRelationUpdate and OpptyProductRelationDelete. """ OpptyProductRelationAll """Fires when a product line of an opportunity is created.""" OpptyProductRelationCreate """Fires when a product line of an opportunity is updated.""" OpptyProductRelationUpdate """Fires when a product line of an opportunity is deleted.""" OpptyProductRelationDelete """ Subscribes to every project event: ProjectCreate, ProjectUpdate, ProjectDelete, ProjectOwnerChanged and ProjectDocumentLinked. """ ProjectAll """Fires when a project is created.""" ProjectCreate """Fires when a project is updated.""" ProjectUpdate """Fires when a project is deleted.""" ProjectDelete """ Fires when the owner of a project changes, including when it is created with an owner other than the user who created it. """ ProjectOwnerChanged """ Fires when a document is linked to a project; the event includes the document as the related entity. """ ProjectDocumentLinked """ Subscribes to every quote event: QuoteCreate, QuoteUpdate, QuoteDelete, QuoteOwnerChanged, QuoteDocumentLinked, QuoteMove, QuoteWon and QuoteLost. """ QuoteAll """Fires when a quote is created.""" QuoteCreate """Fires when a quote is updated.""" QuoteUpdate """Fires when a quote is deleted.""" QuoteDelete """ Fires when the owner of a quote changes, including when it is created with an owner other than the user who created it. """ QuoteOwnerChanged """ Fires when a document is linked to a quote; the event includes the document as the related entity. """ QuoteDocumentLinked """ Fires when a quote moves to a different step of its quote process; winning a quote also raises this event. """ QuoteMove """ Fires when a quote is created in or moved to the won (accepted) step of its quote process. """ QuoteWon """Fires when a quote is archived as lost without reaching the won step.""" QuoteLost """ Subscribes to every custom entity event: CustomEntityCreate, CustomEntityUpdate, CustomEntityDelete, CustomEntityOwnerChanged and CustomEntityDocumentLinked. """ CustomEntityAll """Fires when a custom entity record is created.""" CustomEntityCreate """Fires when a custom entity record is updated.""" CustomEntityUpdate """Fires when a custom entity record is deleted.""" CustomEntityDelete """ Fires when the owner of a custom entity record changes, including when it is created with an owner other than the user who created it. """ CustomEntityOwnerChanged """ Fires when a document is linked to a custom entity record; the event includes the document as the related entity. """ CustomEntityDocumentLinked """ Subscribes to every contact-account link event: ContactAccountRelationCreate, ContactAccountRelationUpdate and ContactAccountRelationDelete. """ ContactAccountRelationAll """Fires when a contact is linked to an account.""" ContactAccountRelationCreate """Fires when the link between a contact and an account is updated.""" ContactAccountRelationUpdate """Fires when a contact is unlinked from an account.""" ContactAccountRelationDelete """ Subscribes to every lead/opportunity account link event: LeadOpptyAccountRelationCreate, LeadOpptyAccountRelationUpdate and LeadOpptyAccountRelationDelete. """ LeadOpptyAccountRelationAll """Fires when an account is linked to a lead or opportunity.""" LeadOpptyAccountRelationCreate """ Fires when the link between an account and a lead or opportunity is updated. """ LeadOpptyAccountRelationUpdate """Fires when an account is unlinked from a lead or opportunity.""" LeadOpptyAccountRelationDelete """ Subscribes to every lead/opportunity contact link event: LeadOpptyContactRelationCreate, LeadOpptyContactRelationUpdate and LeadOpptyContactRelationDelete. """ LeadOpptyContactRelationAll """Fires when a contact is linked to a lead or opportunity.""" LeadOpptyContactRelationCreate """ Fires when the link between a contact and a lead or opportunity is updated. """ LeadOpptyContactRelationUpdate """Fires when a contact is unlinked from a lead or opportunity.""" LeadOpptyContactRelationDelete """ Subscribes to every activity link event: ActivityRelationCreate, ActivityRelationUpdate and ActivityRelationDelete. """ ActivityRelationAll """Fires when a task or appointment is linked to a record.""" ActivityRelationCreate """ Fires when the link between a task or appointment and a record is updated. """ ActivityRelationUpdate """Fires when a task or appointment is unlinked from a record.""" ActivityRelationDelete """ Subscribes to every quote-account link event: QuoteAccountRelationCreate, QuoteAccountRelationUpdate and QuoteAccountRelationDelete. """ QuoteAccountRelationAll """Fires when an account is linked to a quote.""" QuoteAccountRelationCreate """Fires when the link between an account and a quote is updated.""" QuoteAccountRelationUpdate """Fires when an account is unlinked from a quote.""" QuoteAccountRelationDelete """ Subscribes to every quote-contact link event: QuoteContactRelationCreate, QuoteContactRelationUpdate and QuoteContactRelationDelete. """ QuoteContactRelationAll """Fires when a contact is linked to a quote.""" QuoteContactRelationCreate """Fires when the link between a contact and a quote is updated.""" QuoteContactRelationUpdate """Fires when a contact is unlinked from a quote.""" QuoteContactRelationDelete """ Subscribes to every product event: ProductCreate, ProductUpdate and ProductDelete. """ ProductAll """Fires when a product is created.""" ProductCreate """Fires when a product is updated.""" ProductUpdate """Fires when a product is deleted.""" ProductDelete """Subscribes to every note event: NoteCreate, NoteUpdate and NoteDelete.""" NoteAll """Fires when a note is created.""" NoteCreate """Fires when a note is updated.""" NoteUpdate """Fires when a note is deleted.""" NoteDelete """ Subscribes to every currency event: CurrencyCreate, CurrencyUpdate and CurrencyDelete. """ CurrencyAll """Fires when a currency is created.""" CurrencyCreate """Fires when a currency is updated.""" CurrencyUpdate """Fires when a currency is deleted.""" CurrencyDelete """ Subscribes to every exchange rate event: CurrencyExchangeRateCreate, CurrencyExchangeRateUpdate and CurrencyExchangeRateDelete. """ CurrencyExchangeRateAll """Fires when an exchange rate is created.""" CurrencyExchangeRateCreate """Fires when an exchange rate is updated.""" CurrencyExchangeRateUpdate """Fires when an exchange rate is deleted.""" CurrencyExchangeRateDelete """ Subscribes to every exchange rate list event: CurrencyExchangeRatesListCreate, CurrencyExchangeRatesListUpdate and CurrencyExchangeRatesListDelete. """ CurrencyExchangeRatesListAll """Fires when an exchange rate list is created.""" CurrencyExchangeRatesListCreate """Fires when an exchange rate list is updated.""" CurrencyExchangeRatesListUpdate """Fires when an exchange rate list is deleted.""" CurrencyExchangeRatesListDelete """ Subscribes to every price list event: ProductPriceListCreate, ProductPriceListUpdate and ProductPriceListDelete. """ ProductPriceListAll """Fires when a price list is created.""" ProductPriceListCreate """Fires when a price list is updated.""" ProductPriceListUpdate """Fires when a price list is deleted.""" ProductPriceListDelete """ Subscribes to every price list price event: ProductPriceListPriceCreate, ProductPriceListPriceUpdate and ProductPriceListPriceDelete. """ ProductPriceListPriceAll """Fires when a product price in a price list is created.""" ProductPriceListPriceCreate """Fires when a product price in a price list is updated.""" ProductPriceListPriceUpdate """Fires when a product price in a price list is deleted.""" ProductPriceListPriceDelete } """ Filter conditions for Webhook records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input WebhookFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [WebhookFilterInput!] """Matches records that meet all of the listed filters.""" AND: [WebhookFilterInput!] """Matches records that do not meet this filter.""" NOT: WebhookFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """Id of the OAuth application that registered the Webhook.""" applicationId: EntityFilterStringField """Id of the user who defined the Webhook.""" clientId: EntityFilterStringField """ If True, remote side ssl certificate will not be validated when delivering notifications. """ insecureSsl: Boolean """ Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. """ signature: EntityFilterStringField """Target URL that webhook event payloads are POSTed to.""" url: EntityFilterStringField """ OAuth application that registered this webhook. Set automatically when the webhook is created using OAuth credentials; empty when a team-space API key was used. Matches records where a related record meets these conditions. """ application: ApplicationFilterInput """ Client who defined the Webhook. Only those notifications are sent which this Client has permission to see. If empty, all space notification are send, even for events of private records. Value is automatically set to authenticated user who created the webhook. It is left empty if global team space API Credentials are used. Matches records where a related record meets these conditions. """ client: ClientFilterInput } """ Sorting of Webhook records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input WebhookOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ OAuth application that registered this webhook. Set automatically when the webhook is created using OAuth credentials; empty when a team-space API key was used. Sorts by fields of the related record, listed in order of priority. """ application: [ApplicationOrderByNestedInput!] """ Client who defined the Webhook. Only those notifications are sent which this Client has permission to see. If empty, all space notification are send, even for events of private records. Value is automatically set to authenticated user who created the webhook. It is left empty if global team space API Credentials are used. Sorts by fields of the related record, listed in order of priority. """ client: [ClientOrderByNestedInput!] """Id of the OAuth application that registered the Webhook.""" applicationId: OrderByEnum """Id of the user who defined the Webhook.""" clientId: OrderByEnum """ If True, remote side ssl certificate will not be validated when delivering notifications. """ insecureSsl: OrderByEnum """Target URL that webhook event payloads are POSTed to.""" url: OrderByEnum } """Paginated list of Webhook records.""" type WebhookEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [WebhookEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `WebhookEntity` and its cursor.""" type WebhookEntityEdge { """The item at the end of the edge""" node: WebhookEntity """A cursor for use in pagination""" cursor: String! } """Read operations for WebhookEvent records.""" type WebhookEventRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): WebhookEventEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [WebhookEventEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: WebhookEventFilterInput """Sorting of the returned records.""" orderBy: [WebhookEventOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [WebhookEventEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: WebhookEventFilterInput """Sorting of the returned records.""" orderBy: [WebhookEventOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): WebhookEventEntityConnection """ Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. """ getChangedFieldsSinceRevision( """Id of the record.""" id: UUID! """Revision to compare against; only later changes are returned.""" revision: Int! ): [UUID!]! } """ Event a webhook subscribes to; the webhook is called whenever the event occurs. """ type WebhookEventEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs. """ webhook: WebhookEntity """ Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space. """ event: EventEnum! """Id of the parent webhook.""" webhookId: ID! """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """ Filter conditions for WebhookEvent records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input WebhookEventFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [WebhookEventFilterInput!] """Matches records that meet all of the listed filters.""" AND: [WebhookEventFilterInput!] """Matches records that do not meet this filter.""" NOT: WebhookEventFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space. """ event: EntityFilterStringField """Id of the parent webhook.""" webhookId: EntityFilterStringField """ Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs. Matches records where a related record meets these conditions. """ webhook: WebhookFilterInput } """ Sorting of WebhookEvent records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input WebhookEventOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """ Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs. Sorts by fields of the related record, listed in order of priority. """ webhook: [WebhookOrderByNestedInput!] """ Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space. """ event: OrderByEnum """Id of the parent webhook.""" webhookId: OrderByEnum } """ Sorting by a field of the related Webhook record. Set exactly one field in each item. """ input WebhookOrderByNestedInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Id of the OAuth application that registered the Webhook.""" applicationId: OrderByEnum """Id of the user who defined the Webhook.""" clientId: OrderByEnum """ If True, remote side ssl certificate will not be validated when delivering notifications. """ insecureSsl: OrderByEnum """Target URL that webhook event payloads are POSTed to.""" url: OrderByEnum } """Paginated list of WebhookEvent records.""" type WebhookEventEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [WebhookEventEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `WebhookEventEntity` and its cursor.""" type WebhookEventEntityEdge { """The item at the end of the edge""" node: WebhookEventEntity """A cursor for use in pagination""" cursor: String! } """Read operations for Webresource records.""" type WebresourceRepository { """ Returns the record with the given id, or null when there is none. Deleted records are returned as well. """ getById( """Id of the record to return.""" entityId: ID! ): WebresourceEntity """ Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. """ getByIds( """Ids of the records to return.""" entityIds: [ID!]! ): [WebresourceEntity!]! """ Returns the records that match the filter, paged with limit and offset. """ getAll( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: WebresourceFilterInput """Sorting of the returned records.""" orderBy: [WebresourceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [WebresourceEntity!]! """ Returns the records that match the filter as a cursor-paginated connection. """ getByCriteria( """Conditions the returned records must meet.""" filter: WebresourceFilterInput """Sorting of the returned records.""" orderBy: [WebresourceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean """Cursor until which to take entities to result set.""" before: String """Cursor after which to start taking entities to result set.""" after: String """Number of entities to return from beginning of the result set.""" first: Int """Return only the "last" number of entities from result set.""" last: Int ): WebresourceEntityConnection """ Returns the published records that match the filter, paged with limit and offset. """ getPublished( """Maximum number of records to return.""" limit: Int """Number of records to skip from the start of the result.""" offset: Int """Conditions the returned records must meet.""" filter: WebresourceFilterInput """Sorting of the returned records.""" orderBy: [WebresourceOrderByInput!] """When true, deleted records are returned as well. Defaults to false.""" includeDeleted: Boolean ): [WebresourceEntity!]! """ Returns the records that match the filter, with pending unpublished changes applied where a draft exists. """ getDrafts( """Conditions the returned records must meet.""" filter: WebresourceFilterInput """Sorting of the returned records.""" orderBy: [WebresourceOrderByInput!] ): [WebresourceEntity!]! """ Returns the record with the given id, with its pending unpublished changes applied when a draft exists. """ getDraftById( """Id of the record to return.""" entityId: ID! ): WebresourceEntity! } """ Web page embedded in the app for records of an entity, with its URL filled from the record's field values. """ type WebresourceEntity { """ True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. """ isDeleteProtected: Boolean! """ True when the record has unpublished draft changes, including pending translation changes, that can be published. """ hasDraft: Boolean """Unique identifier of entity.""" id: ID! """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab). """ displayParam: Int! """ Name of the entity the web resource is attached to (e.g. "Account", "Lead"). """ entity: String! """Name of the entity and its default text representation.""" name: String! """HTTP method (Get or Post) used to open the url of the web resource.""" requestMethod: RequestMethodEnum """ URL template for the embedded web resource. May reference field values via "{#}" placeholders that are substituted with the current record's values. """ url: String """ True when the web resource is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Permissions the current user has on this record, out of the requested ones. """ instancePermissions( """Permissions to check; the result lists those the current user has.""" permissions: [EntityPermsEnum!]! ): [EntityPermsEnum!]! } """HTTP method used to open a web resource's URL.""" enum RequestMethodEnum { """The URL is opened with a GET request.""" Get """The URL is opened with a POST request.""" Post } """ Filter conditions for Webresource records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. """ input WebresourceFilterInput { """Matches records that meet at least one of the listed filters.""" OR: [WebresourceFilterInput!] """Matches records that meet all of the listed filters.""" AND: [WebresourceFilterInput!] """Matches records that do not meet this filter.""" NOT: WebresourceFilterInput """ Search term matched against the fields that the global search covers for this entity. """ globalSearchQuery: String """Unique identifier of entity.""" id: EntityFilterStringField """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: EntityFilterDateTimeField """Creation time.""" created: EntityFilterDateTimeField """ Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab). """ displayParam: DisplayParamEnumFilterInput """ Name of the entity the web resource is attached to (e.g. "Account", "Lead"). """ entity: EntityFilterStringField """Name of the entity and its default text representation.""" name: EntityFilterStringField """HTTP method (Get or Post) used to open the url of the web resource.""" requestMethod: RequestMethodEnumFilterInput """ URL template for the embedded web resource. May reference field values via "{#}" placeholders that are substituted with the current record's values. """ url: EntityFilterStringField """ True when the web resource is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: EntityFilterNumberField } """ Conditions on an enumeration field. Several conditions given together must all match. """ input DisplayParamEnumFilterInput { """Matches any of the listed values.""" eq: [DisplayParamEnum!] """Matches values that do not meet this condition.""" NOT: DisplayParamEnumFilterInput } """ Display flags of a web resource embedded in a record's detail; values can be combined. """ enum DisplayParamEnum { """The web resource is displayed in full-screen mode.""" FullScreen """ The web resource is hidden when all record values inserted into its URL are empty. """ DoNotShowIfEmpty } """ Conditions on an enumeration field. Several conditions given together must all match. """ input RequestMethodEnumFilterInput { """Matches any of the listed values.""" eq: [RequestMethodEnum!] """Matches values that do not meet this condition.""" NOT: RequestMethodEnumFilterInput } """ Sorting of Webresource records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. """ input WebresourceOrderByInput { """Unique identifier of entity.""" id: OrderByEnum """Specifies if the entity is considered deleted.""" isDeleted: OrderByEnum """Last modification time.""" modified: OrderByEnum """Creation time.""" created: OrderByEnum """Name of the entity and its default text representation.""" name: OrderByEnum """HTTP method (Get or Post) used to open the url of the web resource.""" requestMethod: OrderByEnum """ URL template for the embedded web resource. May reference field values via "{#}" placeholders that are substituted with the current record's values. """ url: OrderByEnum """ True when the web resource is published; false while it exists only as an unpublished draft. """ isPublished: OrderByEnum """Revision when entity was lastly changed.""" revision: OrderByEnum } """Paginated list of Webresource records.""" type WebresourceEntityConnection { """Pagination data for this connection.""" pageInfo: PageInfo! """Contains the nodes in this connection.""" edges: [WebresourceEntityEdge]! """Total number of items in the connection.""" totalCount: Int } """A Relay edge containing a `WebresourceEntity` and its cursor.""" type WebresourceEntityEdge { """The item at the end of the edge""" node: WebresourceEntity """A cursor for use in pagination""" cursor: String! } type Mutation { """ Assigns the account to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipAccount( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipAccountInput! ): ChangeOwnershipAccountPayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingAccount( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingAccountInput! ): ManageSharingAccountPayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreAccount( """ Parameters of the operation; each field is described on the input type. """ input: RestoreAccountInput! ): RestoreAccountPayload """ Creates a copy of the account with the same field values; attached files are not copied. The copy's name gets a copy suffix, numbered when such copies already exist, unless skipCopySuffix is true. """ copyAccount( """ Parameters of the operation; each field is described on the input type. """ input: CopyAccountInput! ): CopyAccountPayload """ Merges a duplicate account into the master account. The master keeps the values sent in master and gets any empty field filled from the duplicate; records linked to the duplicate move to the master and the duplicate is deleted. """ mergeAccount( """ Parameters of the operation; each field is described on the input type. """ input: MergeAccountInput! ): MergeAccountPayload """ Archives the account, optionally archiving or completing its related records in the same request. Archived accounts can be brought back with reactivateAccount. """ archiveAccount( """ Parameters of the operation; each field is described on the input type. """ input: ArchiveAccountInput! ): ArchiveAccountPayload """ Takes the account out of the archive so it is active again. Field validations are not applied. """ reactivateAccount( """ Parameters of the operation; each field is described on the input type. """ input: ReactivateAccountInput! ): ReactivateAccountPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccount( """Field values of the new record.""" input: CreateAccountInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccount( """Id of the record and the field values to change.""" input: UpdateAccountInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccount( """Records to create or update.""" input: [CreateOrUpdateAccountInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountPayload """Deletes the record.""" deleteAccount( """Id of the record to delete.""" input: DeleteAccountInput! ): DeleteAccountPayload """ Archives many accounts in one request, applying the same field values and related-record options to each, as archiveAccount does. """ bulkArchiveAccount( """ Parameters of the operation; each field is described on the input type. """ input: BulkArchiveAccountInput! ): BulkArchiveAccountPayload """ Takes many archived records out of the archive in one request. Field validations are not applied. """ bulkReactivateAccount( """ Parameters of the operation; each field is described on the input type. """ input: BulkReactivateAccountInput! ): BulkReactivateAccountPayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertAccount( """Field values of the new record.""" input: CreateAccountInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertAccountPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountKpi( """Field values of the new record.""" input: CreateAccountKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountKPIPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountKpi( """Id of the record and the field values to change.""" input: UpdateAccountKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountKPIPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountKpi( """Records to create or update.""" input: [CreateOrUpdateAccountKPIInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountKPIInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountKPIPayload """Deletes the record.""" deleteAccountKpi( """Id of the record to delete.""" input: DeleteAccountKPIInput! ): DeleteAccountKPIPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountProductPricing( """Field values of the new record.""" input: CreateAccountProductPricingInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountProductPricingPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountProductPricing( """Id of the record and the field values to change.""" input: UpdateAccountProductPricingInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountProductPricingPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountProductPricing( """Records to create or update.""" input: [CreateOrUpdateAccountProductPricingInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountProductPricingInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountProductPricingPayload """Deletes the record.""" deleteAccountProductPricing( """Id of the record to delete.""" input: DeleteAccountProductPricingInput! ): DeleteAccountProductPricingPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountRelation( """Field values of the new record.""" input: CreateAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountRelation( """Id of the record and the field values to change.""" input: UpdateAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountRelation( """Records to create or update.""" input: [CreateOrUpdateAccountRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountRelationPayload """Deletes the record.""" deleteAccountRelation( """Id of the record to delete.""" input: DeleteAccountRelationInput! ): DeleteAccountRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountRelationLabel( """Field values of the new record.""" input: CreateAccountRelationLabelInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountRelationLabelPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountRelationLabel( """Id of the record and the field values to change.""" input: UpdateAccountRelationLabelInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountRelationLabelPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountRelationLabel( """Records to create or update.""" input: [CreateOrUpdateAccountRelationLabelInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountRelationLabelInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountRelationLabelPayload """Deletes the record.""" deleteAccountRelationLabel( """Id of the record to delete.""" input: DeleteAccountRelationLabelInput! ): DeleteAccountRelationLabelPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountRelationType( """Field values of the new record.""" input: CreateAccountRelationTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountRelationTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountRelationType( """Id of the record and the field values to change.""" input: UpdateAccountRelationTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountRelationTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountRelationType( """Records to create or update.""" input: [CreateOrUpdateAccountRelationTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountRelationTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountRelationTypePayload """Deletes the record.""" deleteAccountRelationType( """Id of the record to delete.""" input: DeleteAccountRelationTypeInput! ): DeleteAccountRelationTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountRole( """Field values of the new record.""" input: CreateAccountRoleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountRolePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountRole( """Id of the record and the field values to change.""" input: UpdateAccountRoleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountRolePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountRole( """Records to create or update.""" input: [CreateOrUpdateAccountRoleInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountRoleInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountRolePayload """Deletes the record.""" deleteAccountRole( """Id of the record to delete.""" input: DeleteAccountRoleInput! ): DeleteAccountRolePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountSharingClientRelation( """Field values of the new record.""" input: CreateAccountSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateAccountSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateAccountSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountSharingClientRelationPayload """Deletes the record.""" deleteAccountSharingClientRelation( """Id of the record to delete.""" input: DeleteAccountSharingClientRelationInput! ): DeleteAccountSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountSharingSalesUnitRelation( """Field values of the new record.""" input: CreateAccountSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateAccountSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateAccountSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountSharingSalesUnitRelationPayload """Deletes the record.""" deleteAccountSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteAccountSharingSalesUnitRelationInput! ): DeleteAccountSharingSalesUnitRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAccountSocialRelation( """Field values of the new record.""" input: CreateAccountSocialRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAccountSocialRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAccountSocialRelation( """Id of the record and the field values to change.""" input: UpdateAccountSocialRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAccountSocialRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAccountSocialRelation( """Records to create or update.""" input: [CreateOrUpdateAccountSocialRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAccountSocialRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAccountSocialRelationPayload """Deletes the record.""" deleteAccountSocialRelation( """Id of the record to delete.""" input: DeleteAccountSocialRelationInput! ): DeleteAccountSocialRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createActivityComment( """Field values of the new record.""" input: CreateActivityCommentInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateActivityCommentPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateActivityComment( """Id of the record and the field values to change.""" input: UpdateActivityCommentInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateActivityCommentPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateActivityComment( """Records to create or update.""" input: [CreateOrUpdateActivityCommentInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteActivityCommentInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateActivityCommentPayload """Deletes the record.""" deleteActivityComment( """Id of the record to delete.""" input: DeleteActivityCommentInput! ): DeleteActivityCommentPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createActivityKpi( """Field values of the new record.""" input: CreateActivityKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateActivityKPIPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateActivityKpi( """Id of the record and the field values to change.""" input: UpdateActivityKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateActivityKPIPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateActivityKpi( """Records to create or update.""" input: [CreateOrUpdateActivityKPIInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteActivityKPIInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateActivityKPIPayload """Deletes the record.""" deleteActivityKpi( """Id of the record to delete.""" input: DeleteActivityKPIInput! ): DeleteActivityKPIPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createActivityRelation( """Field values of the new record.""" input: CreateActivityRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateActivityRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateActivityRelation( """Id of the record and the field values to change.""" input: UpdateActivityRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateActivityRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateActivityRelation( """Records to create or update.""" input: [CreateOrUpdateActivityRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteActivityRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateActivityRelationPayload """Deletes the record.""" deleteActivityRelation( """Id of the record to delete.""" input: DeleteActivityRelationInput! ): DeleteActivityRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedAccountType( """Field values of the new record.""" input: CreateAllowedAccountTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedAccountTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedAccountType( """Id of the record and the field values to change.""" input: UpdateAllowedAccountTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedAccountTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedAccountType( """Records to create or update.""" input: [CreateOrUpdateAllowedAccountTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedAccountTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedAccountTypePayload """Deletes the record.""" deleteAllowedAccountType( """Id of the record to delete.""" input: DeleteAllowedAccountTypeInput! ): DeleteAllowedAccountTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedAppointmentType( """Field values of the new record.""" input: CreateAllowedAppointmentTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedAppointmentTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedAppointmentType( """Id of the record and the field values to change.""" input: UpdateAllowedAppointmentTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedAppointmentTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedAppointmentType( """Records to create or update.""" input: [CreateOrUpdateAllowedAppointmentTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedAppointmentTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedAppointmentTypePayload """Deletes the record.""" deleteAllowedAppointmentType( """Id of the record to delete.""" input: DeleteAllowedAppointmentTypeInput! ): DeleteAllowedAppointmentTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedCompanyEmail( """Field values of the new record.""" input: CreateAllowedCompanyEmailInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedCompanyEmailPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedCompanyEmail( """Id of the record and the field values to change.""" input: UpdateAllowedCompanyEmailInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedCompanyEmailPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedCompanyEmail( """Records to create or update.""" input: [CreateOrUpdateAllowedCompanyEmailInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedCompanyEmailInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedCompanyEmailPayload """Deletes the record.""" deleteAllowedCompanyEmail( """Id of the record to delete.""" input: DeleteAllowedCompanyEmailInput! ): DeleteAllowedCompanyEmailPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedCompanyPhone( """Field values of the new record.""" input: CreateAllowedCompanyPhoneInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedCompanyPhonePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedCompanyPhone( """Id of the record and the field values to change.""" input: UpdateAllowedCompanyPhoneInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedCompanyPhonePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedCompanyPhone( """Records to create or update.""" input: [CreateOrUpdateAllowedCompanyPhoneInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedCompanyPhoneInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedCompanyPhonePayload """Deletes the record.""" deleteAllowedCompanyPhone( """Id of the record to delete.""" input: DeleteAllowedCompanyPhoneInput! ): DeleteAllowedCompanyPhonePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedContactType( """Field values of the new record.""" input: CreateAllowedContactTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedContactTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedContactType( """Id of the record and the field values to change.""" input: UpdateAllowedContactTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedContactTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedContactType( """Records to create or update.""" input: [CreateOrUpdateAllowedContactTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedContactTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedContactTypePayload """Deletes the record.""" deleteAllowedContactType( """Id of the record to delete.""" input: DeleteAllowedContactTypeInput! ): DeleteAllowedContactTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedLeadType( """Field values of the new record.""" input: CreateAllowedLeadTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedLeadTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedLeadType( """Id of the record and the field values to change.""" input: UpdateAllowedLeadTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedLeadTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedLeadType( """Records to create or update.""" input: [CreateOrUpdateAllowedLeadTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedLeadTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedLeadTypePayload """Deletes the record.""" deleteAllowedLeadType( """Id of the record to delete.""" input: DeleteAllowedLeadTypeInput! ): DeleteAllowedLeadTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedPipeline( """Field values of the new record.""" input: CreateAllowedPipelineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedPipelinePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedPipeline( """Id of the record and the field values to change.""" input: UpdateAllowedPipelineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedPipelinePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedPipeline( """Records to create or update.""" input: [CreateOrUpdateAllowedPipelineInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedPipelineInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedPipelinePayload """Deletes the record.""" deleteAllowedPipeline( """Id of the record to delete.""" input: DeleteAllowedPipelineInput! ): DeleteAllowedPipelinePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedQuoteType( """Field values of the new record.""" input: CreateAllowedQuoteTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedQuoteTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedQuoteType( """Id of the record and the field values to change.""" input: UpdateAllowedQuoteTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedQuoteTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedQuoteType( """Records to create or update.""" input: [CreateOrUpdateAllowedQuoteTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedQuoteTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedQuoteTypePayload """Deletes the record.""" deleteAllowedQuoteType( """Id of the record to delete.""" input: DeleteAllowedQuoteTypeInput! ): DeleteAllowedQuoteTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAllowedTaskType( """Field values of the new record.""" input: CreateAllowedTaskTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAllowedTaskTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAllowedTaskType( """Id of the record and the field values to change.""" input: UpdateAllowedTaskTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAllowedTaskTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAllowedTaskType( """Records to create or update.""" input: [CreateOrUpdateAllowedTaskTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAllowedTaskTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAllowedTaskTypePayload """Deletes the record.""" deleteAllowedTaskType( """Id of the record to delete.""" input: DeleteAllowedTaskTypeInput! ): DeleteAllowedTaskTypePayload """ Creates a copy of the API access with the same settings and permissions, named after the original with a copy suffix. The copy gets its own newly issued credentials; its password is returned only in this response. """ copyApiAccess( """ Parameters of the operation; each field is described on the input type. """ input: CopyApiAccessInput! ): CopyApiAccessPayload """ Assigns the appointment to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipAppointment( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipAppointmentInput! ): ChangeOwnershipAppointmentPayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreAppointment( """ Parameters of the operation; each field is described on the input type. """ input: RestoreAppointmentInput! ): RestoreAppointmentPayload """ Records the calling user's response to their invitation to the appointment. Fails when the calling user is not among the invited users. """ respondToAppointmentInvitation( """ Parameters of the operation; each field is described on the input type. """ input: RespondToAppointmentInvitationInput! ): RespondToAppointmentInvitationPayload """ Sets the calling user's reminder on the appointment, or updates it when one exists. Reminders are personal: each user has their own reminder on an appointment. """ setReminderAppointment( """ Parameters of the operation; each field is described on the input type. """ input: SetReminderAppointmentInput! ): SetReminderAppointmentPayload """ Dismisses the calling user's reminder on the appointment so that it no longer fires, including the user's default reminder. Reminders of other users are not affected. """ removeReminderAppointment( """ Parameters of the operation; each field is described on the input type. """ input: RemoveReminderAppointmentInput! ): RemoveReminderAppointmentPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAppointment( """Field values of the new record.""" input: CreateAppointmentInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAppointmentPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAppointment( """Id of the record and the field values to change.""" input: UpdateAppointmentInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAppointmentPayload """ Creates and updates many appointments in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAppointment( """Records to create or update.""" input: [CreateOrUpdateAppointmentInput!]! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput """ When true, also links each saved appointment to the contacts and accounts whose primary email matches the email of one of its invitees. Recurring appointments are not linked. Defaults to false. """ linkAttendees: Boolean ): BulkUpdateAppointmentPayload """Deletes the record.""" deleteAppointment( """Id of the record to delete.""" input: DeleteAppointmentInput! ): DeleteAppointmentPayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertAppointment( """Field values of the new record.""" input: CreateAppointmentInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertAppointmentPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAppointmentClientInviteesRelation( """Field values of the new record.""" input: CreateAppointmentClientInviteesRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAppointmentClientInviteesRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAppointmentClientInviteesRelation( """Id of the record and the field values to change.""" input: UpdateAppointmentClientInviteesRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAppointmentClientInviteesRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAppointmentClientInviteesRelation( """Records to create or update.""" input: [CreateOrUpdateAppointmentClientInviteesRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAppointmentClientInviteesRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAppointmentClientInviteesRelationPayload """Deletes the record.""" deleteAppointmentClientInviteesRelation( """Id of the record to delete.""" input: DeleteAppointmentClientInviteesRelationInput! ): DeleteAppointmentClientInviteesRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAppointmentContactInviteesRelation( """Field values of the new record.""" input: CreateAppointmentContactInviteesRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAppointmentContactInviteesRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAppointmentContactInviteesRelation( """Id of the record and the field values to change.""" input: UpdateAppointmentContactInviteesRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAppointmentContactInviteesRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAppointmentContactInviteesRelation( """Records to create or update.""" input: [CreateOrUpdateAppointmentContactInviteesRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAppointmentContactInviteesRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAppointmentContactInviteesRelationPayload """Deletes the record.""" deleteAppointmentContactInviteesRelation( """Id of the record to delete.""" input: DeleteAppointmentContactInviteesRelationInput! ): DeleteAppointmentContactInviteesRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAppointmentReminder( """Field values of the new record.""" input: CreateAppointmentReminderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAppointmentReminderPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAppointmentReminder( """Id of the record and the field values to change.""" input: UpdateAppointmentReminderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAppointmentReminderPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAppointmentReminder( """Records to create or update.""" input: [CreateOrUpdateAppointmentReminderInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAppointmentReminderInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAppointmentReminderPayload """Deletes the record.""" deleteAppointmentReminder( """Id of the record to delete.""" input: DeleteAppointmentReminderInput! ): DeleteAppointmentReminderPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createAppointmentSchedule( """Field values of the new record.""" input: CreateAppointmentScheduleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateAppointmentSchedulePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateAppointmentSchedule( """Id of the record and the field values to change.""" input: UpdateAppointmentScheduleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateAppointmentSchedulePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateAppointmentSchedule( """Records to create or update.""" input: [CreateOrUpdateAppointmentScheduleInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteAppointmentScheduleInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateAppointmentSchedulePayload """Deletes the record.""" deleteAppointmentSchedule( """Id of the record to delete.""" input: DeleteAppointmentScheduleInput! ): DeleteAppointmentSchedulePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createApproval( """Field values of the new record.""" input: CreateApprovalInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateApprovalPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateApproval( """Id of the record and the field values to change.""" input: UpdateApprovalInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateApprovalPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateApproval( """Records to create or update.""" input: [CreateOrUpdateApprovalInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteApprovalInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateApprovalPayload """Deletes the record.""" deleteApproval( """Id of the record to delete.""" input: DeleteApprovalInput! ): DeleteApprovalPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createApprovalApprover( """Field values of the new record.""" input: CreateApprovalApproverInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateApprovalApproverPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateApprovalApprover( """Id of the record and the field values to change.""" input: UpdateApprovalApproverInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateApprovalApproverPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateApprovalApprover( """Records to create or update.""" input: [CreateOrUpdateApprovalApproverInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteApprovalApproverInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateApprovalApproverPayload """Deletes the record.""" deleteApprovalApprover( """Id of the record to delete.""" input: DeleteApprovalApproverInput! ): DeleteApprovalApproverPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createApprovalProcess( """Field values of the new record.""" input: CreateApprovalProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateApprovalProcessPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateApprovalProcess( """Id of the record and the field values to change.""" input: UpdateApprovalProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateApprovalProcessPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateApprovalProcess( """Records to create or update.""" input: [CreateOrUpdateApprovalProcessInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteApprovalProcessInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateApprovalProcessPayload """Deletes the record.""" deleteApprovalProcess( """Id of the record to delete.""" input: DeleteApprovalProcessInput! ): DeleteApprovalProcessPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createApprovalProcessActivityLogLine( """Field values of the new record.""" input: CreateApprovalProcessActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateApprovalProcessActivityLogLinePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateApprovalProcessActivityLogLine( """Id of the record and the field values to change.""" input: UpdateApprovalProcessActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateApprovalProcessActivityLogLinePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateApprovalProcessActivityLogLine( """Records to create or update.""" input: [CreateOrUpdateApprovalProcessActivityLogLineInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteApprovalProcessActivityLogLineInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateApprovalProcessActivityLogLinePayload """Deletes the record.""" deleteApprovalProcessActivityLogLine( """Id of the record to delete.""" input: DeleteApprovalProcessActivityLogLineInput! ): DeleteApprovalProcessActivityLogLinePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCall( """Field values of the new record.""" input: CreateCallInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCallPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCall( """Id of the record and the field values to change.""" input: UpdateCallInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCallPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCall( """Records to create or update.""" input: [CreateOrUpdateCallInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCallInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCallPayload """Deletes the record.""" deleteCall( """Id of the record to delete.""" input: DeleteCallInput! ): DeleteCallPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createChatConversation( """Field values of the new record.""" input: CreateChatConversationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateChatConversationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateChatConversation( """Id of the record and the field values to change.""" input: UpdateChatConversationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateChatConversationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateChatConversation( """Records to create or update.""" input: [CreateOrUpdateChatConversationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteChatConversationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateChatConversationPayload """Deletes the record.""" deleteChatConversation( """Id of the record to delete.""" input: DeleteChatConversationInput! ): DeleteChatConversationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createClient( """Field values of the new record.""" input: CreateClientInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateClientPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateClient( """Id of the record and the field values to change.""" input: UpdateClientInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateClientPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateClient( """Records to create or update.""" input: [CreateOrUpdateClientInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteClientInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateClientPayload """Deletes the record.""" deleteClient( """Id of the record to delete.""" input: DeleteClientInput! ): DeleteClientPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createClientExcludedOppty( """Field values of the new record.""" input: CreateClientExcludedOpptyInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateClientExcludedOpptyPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateClientExcludedOppty( """Id of the record and the field values to change.""" input: UpdateClientExcludedOpptyInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateClientExcludedOpptyPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateClientExcludedOppty( """Records to create or update.""" input: [CreateOrUpdateClientExcludedOpptyInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteClientExcludedOpptyInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateClientExcludedOpptyPayload """Deletes the record.""" deleteClientExcludedOppty( """Id of the record to delete.""" input: DeleteClientExcludedOpptyInput! ): DeleteClientExcludedOpptyPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createClientStoryRead( """Field values of the new record.""" input: CreateClientStoryReadInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateClientStoryReadPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateClientStoryRead( """Id of the record and the field values to change.""" input: UpdateClientStoryReadInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateClientStoryReadPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateClientStoryRead( """Records to create or update.""" input: [CreateOrUpdateClientStoryReadInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteClientStoryReadInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateClientStoryReadPayload """Deletes the record.""" deleteClientStoryRead( """Id of the record to delete.""" input: DeleteClientStoryReadInput! ): DeleteClientStoryReadPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCloudObject( """Field values of the new record.""" input: CreateCloudObjectInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCloudObjectPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCloudObject( """Id of the record and the field values to change.""" input: UpdateCloudObjectInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCloudObjectPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCloudObject( """Records to create or update.""" input: [CreateOrUpdateCloudObjectInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCloudObjectInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCloudObjectPayload """Deletes the record.""" deleteCloudObject( """Id of the record to delete.""" input: DeleteCloudObjectInput! ): DeleteCloudObjectPayload """Uploads an image and stores it as a new file in the space.""" createImageCloudObject( """ File name, base64-encoded image content and, for images embedded in an e-mail template or rich-text content, the upload source. """ input: CreateImageInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateImageCloudObjectPayload """ Makes the file publicly accessible and returns its public URL. Anyone with the URL can download the file without signing in. """ cloudObjectMakePublic( """ Parameters of the operation; each field is described on the input type. """ input: CloudObjectMakePublicInput! ): CloudObjectMakePublicPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCloudObjectFolder( """Field values of the new record.""" input: CreateCloudObjectFolderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCloudObjectFolderPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCloudObjectFolder( """Id of the record and the field values to change.""" input: UpdateCloudObjectFolderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCloudObjectFolderPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCloudObjectFolder( """Records to create or update.""" input: [CreateOrUpdateCloudObjectFolderInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCloudObjectFolderInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCloudObjectFolderPayload """ Deletes a company documents folder. With deleteContents, its files and subfolders are deleted first, and the folder is kept when any of them cannot be deleted. """ deleteCloudObjectFolder( """Id of the record to delete.""" input: DeleteCloudObjectFolderInput! """ When true, the files and subfolders in the folder are deleted as well. Defaults to false. """ deleteContents: Boolean ): DeleteCloudObjectFolderPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCloudObjectRelation( """Field values of the new record.""" input: CreateCloudObjectRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCloudObjectRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCloudObjectRelation( """Id of the record and the field values to change.""" input: UpdateCloudObjectRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCloudObjectRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCloudObjectRelation( """Records to create or update.""" input: [CreateOrUpdateCloudObjectRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCloudObjectRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCloudObjectRelationPayload """Deletes the record.""" deleteCloudObjectRelation( """Id of the record to delete.""" input: DeleteCloudObjectRelationInput! ): DeleteCloudObjectRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCloudObjectStepRelation( """Id of the record and the field values to change.""" input: UpdateCloudObjectStepRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCloudObjectStepRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCloudObjectStepRelation( """Records to create or update.""" input: [CreateOrUpdateCloudObjectStepRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCloudObjectStepRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCloudObjectStepRelationPayload """Deletes the record.""" deleteCloudObjectStepRelation( """Id of the record to delete.""" input: DeleteCloudObjectStepRelationInput! ): DeleteCloudObjectStepRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCloudObjectTemplate( """Field values of the new record.""" input: CreateCloudObjectTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCloudObjectTemplatePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCloudObjectTemplate( """Id of the record and the field values to change.""" input: UpdateCloudObjectTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCloudObjectTemplatePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCloudObjectTemplate( """Records to create or update.""" input: [CreateOrUpdateCloudObjectTemplateInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCloudObjectTemplateInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCloudObjectTemplatePayload """Deletes the record.""" deleteCloudObjectTemplate( """Id of the record to delete.""" input: DeleteCloudObjectTemplateInput! ): DeleteCloudObjectTemplatePayload """ Moves files and folders into another folder. Without a record, company documents and folders are moved under folderId; with entityId and entityType, the files are moved within that record's documents. """ moveCloudObjects( """ Parameters of the operation; each field is described on the input type. """ input: MoveCloudObjectsInput! ): MoveCloudObjectsPayload """ Deletes files and folders. Files attached to an online form, e-mail template, process, process template, report schedule, e-mail sequence or approval process are not deleted; they are only removed from the records they were linked to. """ deleteCloudObjects( """ Parameters of the operation; each field is described on the input type. """ input: DeleteCloudObjectsInput! ): DeleteCloudObjectsPayload """ Starts packing the selected files and folders, with their folder structure, into a ZIP archive and returns a request id. Poll getBulkDownloadStatus with that id to get the download URL. """ getBulkDownloadUrl( """ Parameters of the operation; each field is described on the input type. """ input: GetBulkDownloadUrlInput! ): GetBulkDownloadUrlPayload """ Returns the progress of a ZIP download started by getBulkDownloadUrl, and the download URL once the archive is ready. """ getBulkDownloadStatus( """ Parameters of the operation; each field is described on the input type. """ input: GetBulkDownloadStatusInput! ): GetBulkDownloadStatusPayload """ Assigns the contact to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipContact( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipContactInput! ): ChangeOwnershipContactPayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingContact( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingContactInput! ): ManageSharingContactPayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreContact( """ Parameters of the operation; each field is described on the input type. """ input: RestoreContactInput! ): RestoreContactPayload """ Creates a copy of the contact with the same field values; attached files are not copied. The copy's last name gets a copy suffix, numbered when such copies already exist, unless skipCopySuffix is true. """ copyContact( """ Parameters of the operation; each field is described on the input type. """ input: CopyContactInput! ): CopyContactPayload """ Merges a duplicate contact into the master contact. The master keeps the values sent in master and gets any empty field filled from the duplicate; records linked to the duplicate move to the master and the duplicate is deleted. """ mergeContact( """ Parameters of the operation; each field is described on the input type. """ input: MergeContactInput! ): MergeContactPayload """ Archives the contact, optionally archiving or completing its related records in the same request. Archived contacts can be brought back with reactivateContact. """ archiveContact( """ Parameters of the operation; each field is described on the input type. """ input: ArchiveContactInput! ): ArchiveContactPayload """ Takes the contact out of the archive so it is active again. Field validations are not applied. """ reactivateContact( """ Parameters of the operation; each field is described on the input type. """ input: ReactivateContactInput! ): ReactivateContactPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContact( """Field values of the new record.""" input: CreateContactInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContact( """Id of the record and the field values to change.""" input: UpdateContactInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContact( """Records to create or update.""" input: [CreateOrUpdateContactInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactPayload """Deletes the record.""" deleteContact( """Id of the record to delete.""" input: DeleteContactInput! ): DeleteContactPayload """ Archives many contacts in one request, applying the same field values and related-record options to each, as archiveContact does. """ bulkArchiveContact( """ Parameters of the operation; each field is described on the input type. """ input: BulkArchiveContactInput! ): BulkArchiveContactPayload """ Takes many archived records out of the archive in one request. Field validations are not applied. """ bulkReactivateContact( """ Parameters of the operation; each field is described on the input type. """ input: BulkReactivateContactInput! ): BulkReactivateContactPayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertContact( """Field values of the new record.""" input: CreateContactInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertContactPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactAccountAccountRoleRelation( """Field values of the new record.""" input: CreateContactAccountAccountRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactAccountAccountRoleRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactAccountAccountRoleRelation( """Id of the record and the field values to change.""" input: UpdateContactAccountAccountRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactAccountAccountRoleRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactAccountAccountRoleRelation( """Records to create or update.""" input: [CreateOrUpdateContactAccountAccountRoleRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactAccountAccountRoleRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactAccountAccountRoleRelationPayload """Deletes the record.""" deleteContactAccountAccountRoleRelation( """Id of the record to delete.""" input: DeleteContactAccountAccountRoleRelationInput! ): DeleteContactAccountAccountRoleRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactAccountRelation( """Field values of the new record.""" input: CreateContactAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactAccountRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactAccountRelation( """Id of the record and the field values to change.""" input: UpdateContactAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactAccountRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactAccountRelation( """Records to create or update.""" input: [CreateOrUpdateContactAccountRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactAccountRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactAccountRelationPayload """Deletes the record.""" deleteContactAccountRelation( """Id of the record to delete.""" input: DeleteContactAccountRelationInput! ): DeleteContactAccountRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactKpi( """Field values of the new record.""" input: CreateContactKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactKPIPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactKpi( """Id of the record and the field values to change.""" input: UpdateContactKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactKPIPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactKpi( """Records to create or update.""" input: [CreateOrUpdateContactKPIInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactKPIInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactKPIPayload """Deletes the record.""" deleteContactKpi( """Id of the record to delete.""" input: DeleteContactKPIInput! ): DeleteContactKPIPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactRelation( """Field values of the new record.""" input: CreateContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactRelation( """Id of the record and the field values to change.""" input: UpdateContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactRelation( """Records to create or update.""" input: [CreateOrUpdateContactRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactRelationPayload """Deletes the record.""" deleteContactRelation( """Id of the record to delete.""" input: DeleteContactRelationInput! ): DeleteContactRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactRelationLabel( """Field values of the new record.""" input: CreateContactRelationLabelInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactRelationLabelPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactRelationLabel( """Id of the record and the field values to change.""" input: UpdateContactRelationLabelInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactRelationLabelPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactRelationLabel( """Records to create or update.""" input: [CreateOrUpdateContactRelationLabelInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactRelationLabelInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactRelationLabelPayload """Deletes the record.""" deleteContactRelationLabel( """Id of the record to delete.""" input: DeleteContactRelationLabelInput! ): DeleteContactRelationLabelPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactRelationType( """Field values of the new record.""" input: CreateContactRelationTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactRelationTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactRelationType( """Id of the record and the field values to change.""" input: UpdateContactRelationTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactRelationTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactRelationType( """Records to create or update.""" input: [CreateOrUpdateContactRelationTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactRelationTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactRelationTypePayload """Deletes the record.""" deleteContactRelationType( """Id of the record to delete.""" input: DeleteContactRelationTypeInput! ): DeleteContactRelationTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactSharingClientRelation( """Field values of the new record.""" input: CreateContactSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateContactSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateContactSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactSharingClientRelationPayload """Deletes the record.""" deleteContactSharingClientRelation( """Id of the record to delete.""" input: DeleteContactSharingClientRelationInput! ): DeleteContactSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactSharingSalesUnitRelation( """Field values of the new record.""" input: CreateContactSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateContactSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateContactSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactSharingSalesUnitRelationPayload """Deletes the record.""" deleteContactSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteContactSharingSalesUnitRelationInput! ): DeleteContactSharingSalesUnitRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createContactSocialRelation( """Field values of the new record.""" input: CreateContactSocialRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateContactSocialRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateContactSocialRelation( """Id of the record and the field values to change.""" input: UpdateContactSocialRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateContactSocialRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateContactSocialRelation( """Records to create or update.""" input: [CreateOrUpdateContactSocialRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteContactSocialRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateContactSocialRelationPayload """Deletes the record.""" deleteContactSocialRelation( """Id of the record to delete.""" input: DeleteContactSocialRelationInput! ): DeleteContactSocialRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCountryCrm( """Field values of the new record.""" input: CreateCountryCrmInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCountryCrmPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCountryCrm( """Id of the record and the field values to change.""" input: UpdateCountryCrmInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCountryCrmPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCountryCrm( """Records to create or update.""" input: [CreateOrUpdateCountryCrmInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCountryCrmInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCountryCrmPayload """Deletes the record.""" deleteCountryCrm( """Id of the record to delete.""" input: DeleteCountryCrmInput! ): DeleteCountryCrmPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCurrency( """Field values of the new record.""" input: CreateCurrencyInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCurrencyPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCurrency( """Id of the record and the field values to change.""" input: UpdateCurrencyInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCurrencyPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCurrency( """Records to create or update.""" input: [CreateOrUpdateCurrencyInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCurrencyInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCurrencyPayload """Deletes the record.""" deleteCurrency( """Id of the record to delete.""" input: DeleteCurrencyInput! ): DeleteCurrencyPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCurrencyExchangeRate( """Field values of the new record.""" input: CreateCurrencyExchangeRateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCurrencyExchangeRatePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCurrencyExchangeRate( """Id of the record and the field values to change.""" input: UpdateCurrencyExchangeRateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCurrencyExchangeRatePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCurrencyExchangeRate( """Records to create or update.""" input: [CreateOrUpdateCurrencyExchangeRateInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCurrencyExchangeRateInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCurrencyExchangeRatePayload """Deletes the record.""" deleteCurrencyExchangeRate( """Id of the record to delete.""" input: DeleteCurrencyExchangeRateInput! ): DeleteCurrencyExchangeRatePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCurrencyExchangeRatesList( """Field values of the new record.""" input: CreateCurrencyExchangeRatesListInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCurrencyExchangeRatesListPayload """ Updates an exchange rate list. Only the fields present in the input are changed. """ updateCurrencyExchangeRatesList( """Id of the record and the field values to change.""" input: UpdateCurrencyExchangeRatesListInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String """ When true (default), changed exchange rates recalculate the base-currency values of foreign-currency fields in the existing records the rate list applies to; when false, those values are kept. """ updateCurrencyFields: Boolean ): UpdateCurrencyExchangeRatesListPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCurrencyExchangeRatesList( """Records to create or update.""" input: [CreateOrUpdateCurrencyExchangeRatesListInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCurrencyExchangeRatesListInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCurrencyExchangeRatesListPayload """Deletes the record.""" deleteCurrencyExchangeRatesList( """Id of the record to delete.""" input: DeleteCurrencyExchangeRatesListInput! ): DeleteCurrencyExchangeRatesListPayload """ Assigns the record to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipCustomEntity( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipCustomEntityInput! ): ChangeOwnershipCustomEntityPayload """ Creates a copy of the custom entity record with the same field values. The copy's name gets a copy suffix unless skipCopySuffix is true; an auto-numbered name gets the next number instead. """ copyCustomEntity( """ Parameters of the operation; each field is described on the input type. """ input: CopyCustomEntityInput! ): CopyCustomEntityPayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingCustomEntity( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingCustomEntityInput! ): ManageSharingCustomEntityPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCustomEntityDataExRelation( """Field values of the new record.""" input: CreateCustomEntityDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCustomEntityDataExRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCustomEntityDataExRelation( """Id of the record and the field values to change.""" input: UpdateCustomEntityDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCustomEntityDataExRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCustomEntityDataExRelation( """Records to create or update.""" input: [CreateOrUpdateCustomEntityDataExRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCustomEntityDataExRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCustomEntityDataExRelationPayload """Deletes the record.""" deleteCustomEntityDataExRelation( """Id of the record to delete.""" input: DeleteCustomEntityDataExRelationInput! ): DeleteCustomEntityDataExRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCustomEntitySharingClientRelation( """Field values of the new record.""" input: CreateCustomEntitySharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCustomEntitySharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCustomEntitySharingClientRelation( """Id of the record and the field values to change.""" input: UpdateCustomEntitySharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCustomEntitySharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCustomEntitySharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateCustomEntitySharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCustomEntitySharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCustomEntitySharingClientRelationPayload """Deletes the record.""" deleteCustomEntitySharingClientRelation( """Id of the record to delete.""" input: DeleteCustomEntitySharingClientRelationInput! ): DeleteCustomEntitySharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createCustomEntitySharingSalesUnitRelation( """Field values of the new record.""" input: CreateCustomEntitySharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateCustomEntitySharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateCustomEntitySharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateCustomEntitySharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateCustomEntitySharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateCustomEntitySharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateCustomEntitySharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteCustomEntitySharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateCustomEntitySharingSalesUnitRelationPayload """Deletes the record.""" deleteCustomEntitySharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteCustomEntitySharingSalesUnitRelationInput! ): DeleteCustomEntitySharingSalesUnitRelationPayload """ Restores a deleted option of a dropdown, radio or multiselect field and places it at the given position in its data set. """ restoreData( """ Parameters of the operation; each field is described on the input type. """ input: RestoreDataInput! ): RestoreDataPayload """ Deletes the record and publishes the deletion immediately; unrelated pending drafts stay unpublished. """ deleteData( """Id of the record to delete.""" input: DeleteDataInput! ): DeleteDataPayload """ Creates a new option of a dropdown, radio or multiselect field and publishes it immediately. The other options of the field are renumbered to make room at its sortOrder. """ createData( """Field values of the new record.""" input: CreateDataInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateDataPayload """ Updates an option of a dropdown, radio or multiselect field and publishes the change immediately. Only the fields present in the input are changed; when sortOrder changes, the other options of the field are renumbered. """ updateData( """Id of the record and the field values to change.""" input: UpdateDataInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): UpdateDataPayload """ Sets how the email record is shared: the sharing mode and the users and sales units it is shared with. Who can read the email body is set separately with manageContentSharingEmail. """ manageSharingEmail( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingEmailInput! ): ManageSharingEmailPayload """ Sets who can read the body of the email. For a mass email the setting is also applied to every individual email sent from it. """ manageContentSharingEmail( """ Parameters of the operation; each field is described on the input type. """ input: ManageContentSharingEmailInput! ): ManageContentSharingEmailPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmail( """Field values of the new record.""" input: CreateEmailInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmail( """Id of the record and the field values to change.""" input: UpdateEmailInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmail( """Records to create or update.""" input: [CreateOrUpdateEmailInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailPayload """Deletes the record.""" deleteEmail( """Id of the record to delete.""" input: DeleteEmailInput! ): DeleteEmailPayload """ Replaces the records linked to the e-mail and to every other e-mail in its conversation. Linked records missing from linkedItems are unlinked. """ updateLinkedItemsEmail( """ Parameters of the operation; each field is described on the input type. """ input: UpdateLinkedItemsEmailInput! ): UpdateLinkedItemsEmailPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailContentSharingClientRelation( """Field values of the new record.""" input: CreateEmailContentSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailContentSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailContentSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateEmailContentSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailContentSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailContentSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateEmailContentSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailContentSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailContentSharingClientRelationPayload """Deletes the record.""" deleteEmailContentSharingClientRelation( """Id of the record to delete.""" input: DeleteEmailContentSharingClientRelationInput! ): DeleteEmailContentSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailContentSharingSalesUnitRelation( """Field values of the new record.""" input: CreateEmailContentSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailContentSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailContentSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateEmailContentSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailContentSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailContentSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateEmailContentSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailContentSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailContentSharingSalesUnitRelationPayload """Deletes the record.""" deleteEmailContentSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteEmailContentSharingSalesUnitRelationInput! ): DeleteEmailContentSharingSalesUnitRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailEvent( """Field values of the new record.""" input: CreateEmailEventInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailEventPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailEvent( """Id of the record and the field values to change.""" input: UpdateEmailEventInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailEventPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailEvent( """Records to create or update.""" input: [CreateOrUpdateEmailEventInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailEventInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailEventPayload """Deletes the record.""" deleteEmailEvent( """Id of the record to delete.""" input: DeleteEmailEventInput! ): DeleteEmailEventPayload """ Creates a new email label. A label with the same name, ignoring case, as another label of the same owner under the same parent label is rejected. """ createEmailLabel( """Field values of the new record.""" input: CreateEmailLabelInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailLabelPayload """ Updates an existing email label. Only the fields present in the input are changed; a rename or move that gives the label the same name, ignoring case, as another label under the same parent label is rejected. """ updateEmailLabel( """Id of the record and the field values to change.""" input: UpdateEmailLabelInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailLabelPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailLabel( """Records to create or update.""" input: [CreateOrUpdateEmailLabelInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailLabelInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailLabelPayload """Deletes the record.""" deleteEmailLabel( """Id of the record to delete.""" input: DeleteEmailLabelInput! ): DeleteEmailLabelPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailLabelRelation( """Field values of the new record.""" input: CreateEmailLabelRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailLabelRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailLabelRelation( """Id of the record and the field values to change.""" input: UpdateEmailLabelRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailLabelRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailLabelRelation( """Records to create or update.""" input: [CreateOrUpdateEmailLabelRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailLabelRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailLabelRelationPayload """Deletes the record.""" deleteEmailLabelRelation( """Id of the record to delete.""" input: DeleteEmailLabelRelationInput! ): DeleteEmailLabelRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailSequence( """Field values of the new record.""" input: CreateEmailSequenceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailSequencePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailSequence( """Id of the record and the field values to change.""" input: UpdateEmailSequenceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailSequencePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailSequence( """Records to create or update.""" input: [CreateOrUpdateEmailSequenceInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailSequenceInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailSequencePayload """Deletes the record.""" deleteEmailSequence( """Id of the record to delete.""" input: DeleteEmailSequenceInput! ): DeleteEmailSequencePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailSequenceActivityLog( """Field values of the new record.""" input: CreateEmailSequenceActivityLogInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailSequenceActivityLogPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailSequenceActivityLog( """Id of the record and the field values to change.""" input: UpdateEmailSequenceActivityLogInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailSequenceActivityLogPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailSequenceActivityLog( """Records to create or update.""" input: [CreateOrUpdateEmailSequenceActivityLogInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailSequenceActivityLogInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailSequenceActivityLogPayload """Deletes the record.""" deleteEmailSequenceActivityLog( """Id of the record to delete.""" input: DeleteEmailSequenceActivityLogInput! ): DeleteEmailSequenceActivityLogPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailSequenceActivityLogLine( """Field values of the new record.""" input: CreateEmailSequenceActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailSequenceActivityLogLinePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailSequenceActivityLogLine( """Id of the record and the field values to change.""" input: UpdateEmailSequenceActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailSequenceActivityLogLinePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailSequenceActivityLogLine( """Records to create or update.""" input: [CreateOrUpdateEmailSequenceActivityLogLineInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailSequenceActivityLogLineInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailSequenceActivityLogLinePayload """Deletes the record.""" deleteEmailSequenceActivityLogLine( """Id of the record to delete.""" input: DeleteEmailSequenceActivityLogLineInput! ): DeleteEmailSequenceActivityLogLinePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailSequenceEnrolled( """Field values of the new record.""" input: CreateEmailSequenceEnrolledInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailSequenceEnrolledPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailSequenceEnrolled( """Id of the record and the field values to change.""" input: UpdateEmailSequenceEnrolledInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailSequenceEnrolledPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailSequenceEnrolled( """Records to create or update.""" input: [CreateOrUpdateEmailSequenceEnrolledInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailSequenceEnrolledInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailSequenceEnrolledPayload """Deletes the record.""" deleteEmailSequenceEnrolled( """Id of the record to delete.""" input: DeleteEmailSequenceEnrolledInput! ): DeleteEmailSequenceEnrolledPayload """ Returns the template body as HTML with its merge fields filled from the given record. The template is not changed; merge fields without a value show the field name. """ personalizeBodyEmailTemplate( """ Parameters of the operation; each field is described on the input type. """ input: PersonalizeBodyEmailTemplateInput! ): PersonalizeBodyEmailTemplatePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailTemplate( """Field values of the new record.""" input: CreateEmailTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailTemplatePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailTemplate( """Id of the record and the field values to change.""" input: UpdateEmailTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailTemplatePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailTemplate( """Records to create or update.""" input: [CreateOrUpdateEmailTemplateInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailTemplateInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailTemplatePayload """Deletes the record.""" deleteEmailTemplate( """Id of the record to delete.""" input: DeleteEmailTemplateInput! ): DeleteEmailTemplatePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailTemplateFolder( """Field values of the new record.""" input: CreateEmailTemplateFolderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailTemplateFolderPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailTemplateFolder( """Id of the record and the field values to change.""" input: UpdateEmailTemplateFolderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailTemplateFolderPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailTemplateFolder( """Records to create or update.""" input: [CreateOrUpdateEmailTemplateFolderInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailTemplateFolderInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailTemplateFolderPayload """ Deletes an email template folder. With deleteContents, its templates and subfolders are deleted first, and the folder is kept when any of them cannot be deleted. """ deleteEmailTemplateFolder( """Id of the record to delete.""" input: DeleteEmailTemplateFolderInput! """ When true, the templates and subfolders in the folder are deleted as well. Defaults to false. """ deleteContents: Boolean ): DeleteEmailTemplateFolderPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailTemplateSharingClientRelation( """Field values of the new record.""" input: CreateEmailTemplateSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailTemplateSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailTemplateSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateEmailTemplateSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailTemplateSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailTemplateSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateEmailTemplateSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailTemplateSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailTemplateSharingClientRelationPayload """Deletes the record.""" deleteEmailTemplateSharingClientRelation( """Id of the record to delete.""" input: DeleteEmailTemplateSharingClientRelationInput! ): DeleteEmailTemplateSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailTemplateSharingSalesUnitRelation( """Field values of the new record.""" input: CreateEmailTemplateSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailTemplateSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailTemplateSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateEmailTemplateSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailTemplateSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailTemplateSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateEmailTemplateSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailTemplateSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailTemplateSharingSalesUnitRelationPayload """Deletes the record.""" deleteEmailTemplateSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteEmailTemplateSharingSalesUnitRelationInput! ): DeleteEmailTemplateSharingSalesUnitRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEmailThreadMailboxClientReadState( """Field values of the new record.""" input: CreateEmailThreadMailboxClientReadStateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEmailThreadMailboxClientReadStatePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEmailThreadMailboxClientReadState( """Id of the record and the field values to change.""" input: UpdateEmailThreadMailboxClientReadStateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEmailThreadMailboxClientReadStatePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEmailThreadMailboxClientReadState( """Records to create or update.""" input: [CreateOrUpdateEmailThreadMailboxClientReadStateInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEmailThreadMailboxClientReadStateInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEmailThreadMailboxClientReadStatePayload """Deletes the record.""" deleteEmailThreadMailboxClientReadState( """Id of the record to delete.""" input: DeleteEmailThreadMailboxClientReadStateInput! ): DeleteEmailThreadMailboxClientReadStatePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEntityFitness( """Id of the record and the field values to change.""" input: UpdateEntityFitnessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEntityFitnessPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEntityFitnessIndicator( """Field values of the new record.""" input: CreateEntityFitnessIndicatorInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEntityFitnessIndicatorPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEntityFitnessIndicator( """Id of the record and the field values to change.""" input: UpdateEntityFitnessIndicatorInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEntityFitnessIndicatorPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEntityFitnessIndicator( """Records to create or update.""" input: [CreateOrUpdateEntityFitnessIndicatorInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEntityFitnessIndicatorInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEntityFitnessIndicatorPayload """Deletes the record.""" deleteEntityFitnessIndicator( """Id of the record to delete.""" input: DeleteEntityFitnessIndicatorInput! ): DeleteEntityFitnessIndicatorPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEntityHealth( """Id of the record and the field values to change.""" input: UpdateEntityHealthInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEntityHealthPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createEntityScoring( """Field values of the new record.""" input: CreateEntityScoringInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateEntityScoringPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateEntityScoring( """Id of the record and the field values to change.""" input: UpdateEntityScoringInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateEntityScoringPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateEntityScoring( """Records to create or update.""" input: [CreateOrUpdateEntityScoringInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteEntityScoringInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateEntityScoringPayload """Deletes the record.""" deleteEntityScoring( """Id of the record to delete.""" input: DeleteEntityScoringInput! ): DeleteEntityScoringPayload """ Deletes the record and publishes the deletion immediately; unrelated pending drafts stay unpublished. """ deleteField( """Id of the record to delete.""" input: DeleteDraftFieldInput! ): DeleteFieldPayload """ Creates a new record and publishes it immediately; unrelated pending drafts stay unpublished. """ createField( """Field values of the new record.""" input: CreateDraftFieldInput! ): CreateFieldPayload """ Updates an existing record and publishes the change immediately; unrelated pending drafts stay unpublished. Only the fields present in the input are changed. """ updateField( """Id of the record and the field values to change.""" input: UpdateDraftFieldInput! ): UpdateFieldPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createFieldMapping( """Field values of the new record.""" input: CreateFieldMappingInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateFieldMappingPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateFieldMapping( """Id of the record and the field values to change.""" input: UpdateFieldMappingInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateFieldMappingPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateFieldMapping( """Records to create or update.""" input: [CreateOrUpdateFieldMappingInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteFieldMappingInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateFieldMappingPayload """Deletes the record.""" deleteFieldMapping( """Id of the record to delete.""" input: DeleteFieldMappingInput! ): DeleteFieldMappingPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createForecast( """Field values of the new record.""" input: CreateForecastInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateForecastPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateForecast( """Id of the record and the field values to change.""" input: UpdateForecastInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateForecastPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateForecast( """Records to create or update.""" input: [CreateOrUpdateForecastInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteForecastInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateForecastPayload """Deletes the record.""" deleteForecast( """Id of the record to delete.""" input: DeleteForecastInput! ): DeleteForecastPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createFormView( """Field values of the new record.""" input: CreateFormViewInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateFormViewPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateFormView( """Id of the record and the field values to change.""" input: UpdateFormViewInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateFormViewPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateFormView( """Records to create or update.""" input: [CreateOrUpdateFormViewInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteFormViewInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateFormViewPayload """Deletes the record.""" deleteFormView( """Id of the record to delete.""" input: DeleteFormViewInput! ): DeleteFormViewPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createFormViewSharingClientRelation( """Field values of the new record.""" input: CreateFormViewSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateFormViewSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateFormViewSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateFormViewSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateFormViewSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateFormViewSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateFormViewSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteFormViewSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateFormViewSharingClientRelationPayload """Deletes the record.""" deleteFormViewSharingClientRelation( """Id of the record to delete.""" input: DeleteFormViewSharingClientRelationInput! ): DeleteFormViewSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createFormViewSharingSalesUnitRelation( """Field values of the new record.""" input: CreateFormViewSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateFormViewSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateFormViewSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateFormViewSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateFormViewSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateFormViewSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateFormViewSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteFormViewSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateFormViewSharingSalesUnitRelationPayload """Deletes the record.""" deleteFormViewSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteFormViewSharingSalesUnitRelationInput! ): DeleteFormViewSharingSalesUnitRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createGhostContact( """Field values of the new record.""" input: CreateGhostContactInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateGhostContactPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateGhostContact( """Id of the record and the field values to change.""" input: UpdateGhostContactInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateGhostContactPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateGhostContact( """Records to create or update.""" input: [CreateOrUpdateGhostContactInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteGhostContactInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateGhostContactPayload """Deletes the record.""" deleteGhostContact( """Id of the record to delete.""" input: DeleteGhostContactInput! ): DeleteGhostContactPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createGhostContactAccountAccountRoleRelation( """Field values of the new record.""" input: CreateGhostContactAccountAccountRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateGhostContactAccountAccountRoleRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateGhostContactAccountAccountRoleRelation( """Id of the record and the field values to change.""" input: UpdateGhostContactAccountAccountRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateGhostContactAccountAccountRoleRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateGhostContactAccountAccountRoleRelation( """Records to create or update.""" input: [CreateOrUpdateGhostContactAccountAccountRoleRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteGhostContactAccountAccountRoleRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateGhostContactAccountAccountRoleRelationPayload """Deletes the record.""" deleteGhostContactAccountAccountRoleRelation( """Id of the record to delete.""" input: DeleteGhostContactAccountAccountRoleRelationInput! ): DeleteGhostContactAccountAccountRoleRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createGhostContactAccountRelation( """Field values of the new record.""" input: CreateGhostContactAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateGhostContactAccountRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateGhostContactAccountRelation( """Id of the record and the field values to change.""" input: UpdateGhostContactAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateGhostContactAccountRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateGhostContactAccountRelation( """Records to create or update.""" input: [CreateOrUpdateGhostContactAccountRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteGhostContactAccountRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateGhostContactAccountRelationPayload """Deletes the record.""" deleteGhostContactAccountRelation( """Id of the record to delete.""" input: DeleteGhostContactAccountRelationInput! ): DeleteGhostContactAccountRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createGhostLeadOpptyContactRelation( """Field values of the new record.""" input: CreateGhostLeadOpptyContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateGhostLeadOpptyContactRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateGhostLeadOpptyContactRelation( """Id of the record and the field values to change.""" input: UpdateGhostLeadOpptyContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateGhostLeadOpptyContactRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateGhostLeadOpptyContactRelation( """Records to create or update.""" input: [CreateOrUpdateGhostLeadOpptyContactRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteGhostLeadOpptyContactRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateGhostLeadOpptyContactRelationPayload """Deletes the record.""" deleteGhostLeadOpptyContactRelation( """Id of the record to delete.""" input: DeleteGhostLeadOpptyContactRelationInput! ): DeleteGhostLeadOpptyContactRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createGhostLeadOpptyContactSalesRoleRelation( """Field values of the new record.""" input: CreateGhostLeadOpptyContactSalesRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateGhostLeadOpptyContactSalesRoleRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateGhostLeadOpptyContactSalesRoleRelation( """Id of the record and the field values to change.""" input: UpdateGhostLeadOpptyContactSalesRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateGhostLeadOpptyContactSalesRoleRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateGhostLeadOpptyContactSalesRoleRelation( """Records to create or update.""" input: [CreateOrUpdateGhostLeadOpptyContactSalesRoleRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteGhostLeadOpptyContactSalesRoleRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateGhostLeadOpptyContactSalesRoleRelationPayload """Deletes the record.""" deleteGhostLeadOpptyContactSalesRoleRelation( """Id of the record to delete.""" input: DeleteGhostLeadOpptyContactSalesRoleRelationInput! ): DeleteGhostLeadOpptyContactSalesRoleRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createImportMappingMask( """Field values of the new record.""" input: CreateImportMappingMaskInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateImportMappingMaskPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateImportMappingMask( """Id of the record and the field values to change.""" input: UpdateImportMappingMaskInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateImportMappingMaskPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateImportMappingMask( """Records to create or update.""" input: [CreateOrUpdateImportMappingMaskInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteImportMappingMaskInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateImportMappingMaskPayload """Deletes the record.""" deleteImportMappingMask( """Id of the record to delete.""" input: DeleteImportMappingMaskInput! ): DeleteImportMappingMaskPayload """ Releases the lead from its owner, leaving it unassigned in its sales unit so another user can take it over. A Private sharing mode is switched to Standard. """ releaseOwnershipLead( """ Parameters of the operation; each field is described on the input type. """ input: ReleaseOwnershipLeadInput! ): ReleaseOwnershipLeadPayload """ Assigns the record to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipLead( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipLeadInput! ): ChangeOwnershipLeadPayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingLead( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingLeadInput! ): ManageSharingLeadPayload """ Sets the label flags of the record. All three flags are replaced, so send false for flags that should be cleared. """ changeLabelFlagLead( """ Parameters of the operation; each field is described on the input type. """ input: ChangeLabelFlagLeadInput! ): ChangeLabelFlagLeadPayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreLead( """ Parameters of the operation; each field is described on the input type. """ input: RestoreLeadInput! ): RestoreLeadPayload """ Creates a copy of the lead with the same field values; attached files are not copied. The copy's name gets a copy suffix, numbered when such copies already exist, unless skipCopySuffix is true. """ copyLead( """ Parameters of the operation; each field is described on the input type. """ input: CopyLeadInput! ): CopyLeadPayload """ Archives the lead, closing it as lost. Archived leads can be brought back with reactivateLead. """ archiveLead( """ Parameters of the operation; each field is described on the input type. """ input: ArchiveLeadInput! ): ArchiveLeadPayload """ Takes the lead out of the archive so it is open again. Field validations are not applied. """ reactivateLead( """ Parameters of the operation; each field is described on the input type. """ input: ReactivateLeadInput! ): ReactivateLeadPayload """ Converts the lead into an opportunity that keeps the lead's id, shared field values and linked records; the lead itself is removed. The target step must be in a sales pipeline and cannot be its last (won) step. """ qualifyLead( """ Parameters of the operation; each field is described on the input type. """ input: QualifyLeadInput! ): QualifyLeadPayload """ Moves the lead to another step of its current lead process. Moving forward enforces the checklists and required fields of the steps passed; use changeLeadProcess to switch to another process. """ moveLead( """ Parameters of the operation; each field is described on the input type. """ input: MoveLeadInput! ): MoveLeadPayload """ Moves the lead to another lead process by changing its lead type and step, optionally changing its owner at the same time. Both leadTypeId and stepId must be sent. """ changeLeadProcess( """ Parameters of the operation; each field is described on the input type. """ input: ChangeLeadProcessInput! ): ChangeLeadProcessPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLead( """Field values of the new record.""" input: CreateLeadInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLead( """Id of the record and the field values to change.""" input: UpdateLeadInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLead( """Records to create or update.""" input: [CreateOrUpdateLeadInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadPayload """Deletes the record.""" deleteLead( """Id of the record to delete.""" input: DeleteLeadInput! ): DeleteLeadPayload """Archives many leads in one request, as archiveLead does.""" bulkArchiveLead( """ Parameters of the operation; each field is described on the input type. """ input: BulkArchiveLeadInput! ): BulkArchiveLeadPayload """ Takes many archived records out of the archive in one request. Field validations are not applied. """ bulkReactivateLead( """ Parameters of the operation; each field is described on the input type. """ input: BulkReactivateLeadInput! ): BulkReactivateLeadPayload """ Converts many leads into opportunities in one request, as qualifyLead does, applying the same target step and field values to each. """ bulkQualifyLead( """ Parameters of the operation; each field is described on the input type. """ input: BulkQualifyLeadInput! ): BulkQualifyLeadPayload """ Moves many leads to another step of their lead process in one request, as moveLead does. """ bulkMoveLead( """ Parameters of the operation; each field is described on the input type. """ input: BulkMoveLeadInput! ): BulkMoveLeadPayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertLead( """Field values of the new record.""" input: CreateLeadInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertLeadPayload """ Takes an archived lead or opportunity out of the archive so it is open again. Field validations are not applied. """ reactivateLeadOppty( """ Parameters of the operation; each field is described on the input type. """ input: ReactivateLeadOpptyInput! ): ReactivateLeadOpptyPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptyAccountRelation( """Field values of the new record.""" input: CreateLeadOpptyAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptyAccountRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptyAccountRelation( """Id of the record and the field values to change.""" input: UpdateLeadOpptyAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptyAccountRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptyAccountRelation( """Records to create or update.""" input: [CreateOrUpdateLeadOpptyAccountRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptyAccountRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptyAccountRelationPayload """Deletes the record.""" deleteLeadOpptyAccountRelation( """Id of the record to delete.""" input: DeleteLeadOpptyAccountRelationInput! ): DeleteLeadOpptyAccountRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptyContactGroupRelation( """Field values of the new record.""" input: CreateLeadOpptyContactGroupRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptyContactGroupRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptyContactGroupRelation( """Id of the record and the field values to change.""" input: UpdateLeadOpptyContactGroupRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptyContactGroupRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptyContactGroupRelation( """Records to create or update.""" input: [CreateOrUpdateLeadOpptyContactGroupRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptyContactGroupRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptyContactGroupRelationPayload """Deletes the record.""" deleteLeadOpptyContactGroupRelation( """Id of the record to delete.""" input: DeleteLeadOpptyContactGroupRelationInput! ): DeleteLeadOpptyContactGroupRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptyContactRelation( """Field values of the new record.""" input: CreateLeadOpptyContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptyContactRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptyContactRelation( """Id of the record and the field values to change.""" input: UpdateLeadOpptyContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptyContactRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptyContactRelation( """Records to create or update.""" input: [CreateOrUpdateLeadOpptyContactRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptyContactRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptyContactRelationPayload """Deletes the record.""" deleteLeadOpptyContactRelation( """Id of the record to delete.""" input: DeleteLeadOpptyContactRelationInput! ): DeleteLeadOpptyContactRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptyContactSalesRoleRelation( """Field values of the new record.""" input: CreateLeadOpptyContactSalesRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptyContactSalesRoleRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptyContactSalesRoleRelation( """Id of the record and the field values to change.""" input: UpdateLeadOpptyContactSalesRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptyContactSalesRoleRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptyContactSalesRoleRelation( """Records to create or update.""" input: [CreateOrUpdateLeadOpptyContactSalesRoleRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptyContactSalesRoleRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptyContactSalesRoleRelationPayload """Deletes the record.""" deleteLeadOpptyContactSalesRoleRelation( """Id of the record to delete.""" input: DeleteLeadOpptyContactSalesRoleRelationInput! ): DeleteLeadOpptyContactSalesRoleRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptyKpi( """Field values of the new record.""" input: CreateLeadOpptyKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptyKPIPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptyKpi( """Id of the record and the field values to change.""" input: UpdateLeadOpptyKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptyKPIPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptyKpi( """Records to create or update.""" input: [CreateOrUpdateLeadOpptyKPIInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptyKPIInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptyKPIPayload """Deletes the record.""" deleteLeadOpptyKpi( """Id of the record to delete.""" input: DeleteLeadOpptyKPIInput! ): DeleteLeadOpptyKPIPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptySharingClientRelation( """Field values of the new record.""" input: CreateLeadOpptySharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptySharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptySharingClientRelation( """Id of the record and the field values to change.""" input: UpdateLeadOpptySharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptySharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptySharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateLeadOpptySharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptySharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptySharingClientRelationPayload """Deletes the record.""" deleteLeadOpptySharingClientRelation( """Id of the record to delete.""" input: DeleteLeadOpptySharingClientRelationInput! ): DeleteLeadOpptySharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptySharingSalesUnitRelation( """Field values of the new record.""" input: CreateLeadOpptySharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptySharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptySharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateLeadOpptySharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptySharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptySharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateLeadOpptySharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptySharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptySharingSalesUnitRelationPayload """Deletes the record.""" deleteLeadOpptySharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteLeadOpptySharingSalesUnitRelationInput! ): DeleteLeadOpptySharingSalesUnitRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadOpptyStepCheckListRelation( """Field values of the new record.""" input: CreateLeadOpptyStepCheckListRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadOpptyStepCheckListRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadOpptyStepCheckListRelation( """Id of the record and the field values to change.""" input: UpdateLeadOpptyStepCheckListRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadOpptyStepCheckListRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadOpptyStepCheckListRelation( """Records to create or update.""" input: [CreateOrUpdateLeadOpptyStepCheckListRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadOpptyStepCheckListRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadOpptyStepCheckListRelationPayload """Deletes the record.""" deleteLeadOpptyStepCheckListRelation( """Id of the record to delete.""" input: DeleteLeadOpptyStepCheckListRelationInput! ): DeleteLeadOpptyStepCheckListRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createLeadProcess( """Field values of the new record.""" input: CreateLeadProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateLeadProcessPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateLeadProcess( """Id of the record and the field values to change.""" input: UpdateLeadProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateLeadProcessPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateLeadProcess( """Records to create or update.""" input: [CreateOrUpdateLeadProcessInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteLeadProcessInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateLeadProcessPayload """Deletes the record.""" deleteLeadProcess( """Id of the record to delete.""" input: DeleteLeadProcessInput! ): DeleteLeadProcessPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createMasterRight( """Field values of the new record.""" input: CreateMasterRightInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateMasterRightPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateMasterRight( """Id of the record and the field values to change.""" input: UpdateMasterRightInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMasterRightPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateMasterRight( """Records to create or update.""" input: [CreateOrUpdateMasterRightInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteMasterRightInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateMasterRightPayload """Deletes the record.""" deleteMasterRight( """Id of the record to delete.""" input: DeleteMasterRightInput! ): DeleteMasterRightPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateMedia( """Id of the record and the field values to change.""" input: UpdateMediaInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMediaPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateMedia( """Records to create or update.""" input: [CreateOrUpdateMediaInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteMediaInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateMediaPayload """Deletes the record.""" deleteMedia( """Id of the record to delete.""" input: DeleteMediaInput! ): DeleteMediaPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createMemo( """Field values of the new record.""" input: CreateMemoInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateMemoPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateMemo( """Id of the record and the field values to change.""" input: UpdateMemoInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMemoPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateMemo( """Records to create or update.""" input: [CreateOrUpdateMemoInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteMemoInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateMemoPayload """Deletes the record.""" deleteMemo( """Id of the record to delete.""" input: DeleteMemoInput! ): DeleteMemoPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createMemoComment( """Field values of the new record.""" input: CreateMemoCommentInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateMemoCommentPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateMemoComment( """Id of the record and the field values to change.""" input: UpdateMemoCommentInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMemoCommentPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateMemoComment( """Records to create or update.""" input: [CreateOrUpdateMemoCommentInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteMemoCommentInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateMemoCommentPayload """Deletes the record.""" deleteMemoComment( """Id of the record to delete.""" input: DeleteMemoCommentInput! ): DeleteMemoCommentPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createMessageRelation( """Field values of the new record.""" input: CreateMessageRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateMessageRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateMessageRelation( """Id of the record and the field values to change.""" input: UpdateMessageRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMessageRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateMessageRelation( """Records to create or update.""" input: [CreateOrUpdateMessageRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteMessageRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateMessageRelationPayload """Deletes the record.""" deleteMessageRelation( """Id of the record to delete.""" input: DeleteMessageRelationInput! ): DeleteMessageRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createMessageSharingClientRelation( """Field values of the new record.""" input: CreateMessageSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateMessageSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateMessageSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateMessageSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMessageSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateMessageSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateMessageSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteMessageSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateMessageSharingClientRelationPayload """Deletes the record.""" deleteMessageSharingClientRelation( """Id of the record to delete.""" input: DeleteMessageSharingClientRelationInput! ): DeleteMessageSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createMessageSharingSalesUnitRelation( """Field values of the new record.""" input: CreateMessageSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateMessageSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateMessageSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateMessageSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMessageSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateMessageSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateMessageSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteMessageSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateMessageSharingSalesUnitRelationPayload """Deletes the record.""" deleteMessageSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteMessageSharingSalesUnitRelationInput! ): DeleteMessageSharingSalesUnitRelationPayload """Copies existing note to a new one.""" copyNote( """ Parameters of the operation; each field is described on the input type. """ input: CopyNoteInput! ): CopyNotePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createNote( """Field values of the new record.""" input: CreateNoteInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateNotePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateNote( """Id of the record and the field values to change.""" input: UpdateNoteInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateNotePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateNote( """Records to create or update.""" input: [CreateOrUpdateNoteInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteNoteInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateNotePayload """Deletes the record.""" deleteNote( """Id of the record to delete.""" input: DeleteNoteInput! ): DeleteNotePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOnlineForm( """Field values of the new record.""" input: CreateOnlineFormInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOnlineFormPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOnlineForm( """Id of the record and the field values to change.""" input: UpdateOnlineFormInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOnlineFormPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOnlineForm( """Records to create or update.""" input: [CreateOrUpdateOnlineFormInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOnlineFormInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOnlineFormPayload """Deletes the record.""" deleteOnlineForm( """Id of the record to delete.""" input: DeleteOnlineFormInput! ): DeleteOnlineFormPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOnlineFormActivityLogLine( """Field values of the new record.""" input: CreateOnlineFormActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOnlineFormActivityLogLinePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOnlineFormActivityLogLine( """Id of the record and the field values to change.""" input: UpdateOnlineFormActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOnlineFormActivityLogLinePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOnlineFormActivityLogLine( """Records to create or update.""" input: [CreateOrUpdateOnlineFormActivityLogLineInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOnlineFormActivityLogLineInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOnlineFormActivityLogLinePayload """Deletes the record.""" deleteOnlineFormActivityLogLine( """Id of the record to delete.""" input: DeleteOnlineFormActivityLogLineInput! ): DeleteOnlineFormActivityLogLinePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOnlineFormDataExRelation( """Field values of the new record.""" input: CreateOnlineFormDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOnlineFormDataExRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOnlineFormDataExRelation( """Id of the record and the field values to change.""" input: UpdateOnlineFormDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOnlineFormDataExRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOnlineFormDataExRelation( """Records to create or update.""" input: [CreateOrUpdateOnlineFormDataExRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOnlineFormDataExRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOnlineFormDataExRelationPayload """Deletes the record.""" deleteOnlineFormDataExRelation( """Id of the record to delete.""" input: DeleteOnlineFormDataExRelationInput! ): DeleteOnlineFormDataExRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOnlineFormRelation( """Field values of the new record.""" input: CreateOnlineFormRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOnlineFormRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOnlineFormRelation( """Id of the record and the field values to change.""" input: UpdateOnlineFormRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOnlineFormRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOnlineFormRelation( """Records to create or update.""" input: [CreateOrUpdateOnlineFormRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOnlineFormRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOnlineFormRelationPayload """Deletes the record.""" deleteOnlineFormRelation( """Id of the record to delete.""" input: DeleteOnlineFormRelationInput! ): DeleteOnlineFormRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOnlineFormStyle( """Field values of the new record.""" input: CreateOnlineFormStyleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOnlineFormStylePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOnlineFormStyle( """Id of the record and the field values to change.""" input: UpdateOnlineFormStyleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOnlineFormStylePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOnlineFormStyle( """Records to create or update.""" input: [CreateOrUpdateOnlineFormStyleInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOnlineFormStyleInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOnlineFormStylePayload """Deletes the record.""" deleteOnlineFormStyle( """Id of the record to delete.""" input: DeleteOnlineFormStyleInput! ): DeleteOnlineFormStylePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOnlineFormType( """Field values of the new record.""" input: CreateOnlineFormTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOnlineFormTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOnlineFormType( """Id of the record and the field values to change.""" input: UpdateOnlineFormTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOnlineFormTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOnlineFormType( """Records to create or update.""" input: [CreateOrUpdateOnlineFormTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOnlineFormTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOnlineFormTypePayload """Deletes the record.""" deleteOnlineFormType( """Id of the record to delete.""" input: DeleteOnlineFormTypeInput! ): DeleteOnlineFormTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOnlineFormTypeEmailRelation( """Field values of the new record.""" input: CreateOnlineFormTypeEmailRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOnlineFormTypeEmailRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOnlineFormTypeEmailRelation( """Id of the record and the field values to change.""" input: UpdateOnlineFormTypeEmailRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOnlineFormTypeEmailRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOnlineFormTypeEmailRelation( """Records to create or update.""" input: [CreateOrUpdateOnlineFormTypeEmailRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOnlineFormTypeEmailRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOnlineFormTypeEmailRelationPayload """Deletes the record.""" deleteOnlineFormTypeEmailRelation( """Id of the record to delete.""" input: DeleteOnlineFormTypeEmailRelationInput! ): DeleteOnlineFormTypeEmailRelationPayload """ Assigns the record to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipOpportunityInput! ): ChangeOwnershipOpportunityPayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingOpportunityInput! ): ManageSharingOpportunityPayload """ Sets the label flags of the record. All three flags are replaced, so send false for flags that should be cleared. """ changeLabelFlagOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: ChangeLabelFlagOpportunityInput! ): ChangeLabelFlagOpportunityPayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: RestoreOpportunityInput! ): RestoreOpportunityPayload """ Archives the opportunity, closing it as lost. Conditionally required fields are enforced. """ archiveOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: ArchiveOpportunityInput! ): ArchiveOpportunityPayload """ Moves the opportunity to another step of its current sales pipeline. Moving forward enforces the checklists and required fields of the steps passed; use changePipelineOpportunity to switch pipelines. """ moveOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: MoveOpportunityInput! ): MoveOpportunityPayload """ Moves the opportunity to a step of another sales pipeline, optionally changing its owner at the same time. """ changePipelineOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: ChangePipelineOpportunityInput! ): ChangePipelineOpportunityPayload """ Converts the opportunity back to a lead. The lead keeps the opportunity's id, shared field values and linked records; quotes are unlinked and opportunity-only data such as recurrence and revenue schedule is removed. """ backToLead( """ Parameters of the operation; each field is described on the input type. """ input: BackToLeadInput! ): BackToLeadPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOpportunity( """Field values of the new record.""" input: CreateOpportunityInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOpportunityPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOpportunity( """Id of the record and the field values to change.""" input: UpdateOpportunityInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOpportunityPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOpportunity( """Records to create or update.""" input: [CreateOrUpdateOpportunityInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOpportunityInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOpportunityPayload """Deletes the record.""" deleteOpportunity( """Id of the record to delete.""" input: DeleteOpportunityInput! ): DeleteOpportunityPayload """ Archives many opportunities in one request, as archiveOpportunity does. """ bulkArchiveOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: BulkArchiveOpportunityInput! ): BulkArchiveOpportunityPayload """ Takes many archived opportunities out of the archive in one request. Field validations are not applied. """ bulkReactivateOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: BulkReactivateOpportunityInput! ): BulkReactivateOpportunityPayload """ Converts many opportunities back to leads in one request. Each lead keeps the opportunity's id, shared field values and linked records; quotes are unlinked and opportunity-only data such as recurrence and revenue schedule is removed. """ bulkBackToLead( """ Parameters of the operation; each field is described on the input type. """ input: BulkBackToLeadInput! ): BulkBackToLeadPayload """ Moves many opportunities to another step of their sales pipeline in one request, as moveOpportunity does. """ bulkMoveOpportunity( """ Parameters of the operation; each field is described on the input type. """ input: BulkMoveOpportunityInput! ): BulkMoveOpportunityPayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertOpportunity( """Field values of the new record.""" input: CreateOpportunityInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertOpportunityPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOpptyProductRelation( """Field values of the new record.""" input: CreateOpptyProductRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOpptyProductRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOpptyProductRelation( """Id of the record and the field values to change.""" input: UpdateOpptyProductRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOpptyProductRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOpptyProductRelation( """Records to create or update.""" input: [CreateOrUpdateOpptyProductRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOpptyProductRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOpptyProductRelationPayload """Deletes the record.""" deleteOpptyProductRelation( """Id of the record to delete.""" input: DeleteOpptyProductRelationInput! ): DeleteOpptyProductRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOpptyProductRelationDataExRelation( """Field values of the new record.""" input: CreateOpptyProductRelationDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOpptyProductRelationDataExRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOpptyProductRelationDataExRelation( """Id of the record and the field values to change.""" input: UpdateOpptyProductRelationDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOpptyProductRelationDataExRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOpptyProductRelationDataExRelation( """Records to create or update.""" input: [CreateOrUpdateOpptyProductRelationDataExRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOpptyProductRelationDataExRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOpptyProductRelationDataExRelationPayload """Deletes the record.""" deleteOpptyProductRelationDataExRelation( """Id of the record to delete.""" input: DeleteOpptyProductRelationDataExRelationInput! ): DeleteOpptyProductRelationDataExRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createOpptyRecurrence( """Field values of the new record.""" input: CreateOpptyRecurrenceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateOpptyRecurrencePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateOpptyRecurrence( """Id of the record and the field values to change.""" input: UpdateOpptyRecurrenceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateOpptyRecurrencePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateOpptyRecurrence( """Records to create or update.""" input: [CreateOrUpdateOpptyRecurrenceInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteOpptyRecurrenceInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateOpptyRecurrencePayload """Deletes the record.""" deleteOpptyRecurrence( """Id of the record to delete.""" input: DeleteOpptyRecurrenceInput! ): DeleteOpptyRecurrencePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createParentAccountRelationType( """Field values of the new record.""" input: CreateParentAccountRelationTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateParentAccountRelationTypePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateParentAccountRelationType( """Id of the record and the field values to change.""" input: UpdateParentAccountRelationTypeInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateParentAccountRelationTypePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateParentAccountRelationType( """Records to create or update.""" input: [CreateOrUpdateParentAccountRelationTypeInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteParentAccountRelationTypeInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateParentAccountRelationTypePayload """Deletes the record.""" deleteParentAccountRelationType( """Id of the record to delete.""" input: DeleteParentAccountRelationTypeInput! ): DeleteParentAccountRelationTypePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createPhone( """Field values of the new record.""" input: CreatePhoneInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreatePhonePayload """ Updates an existing record. Only the fields present in the input are changed. """ updatePhone( """Id of the record and the field values to change.""" input: UpdatePhoneInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdatePhonePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdatePhone( """Records to create or update.""" input: [CreateOrUpdatePhoneInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeletePhoneInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdatePhonePayload """Deletes the record.""" deletePhone( """Id of the record to delete.""" input: DeletePhoneInput! ): DeletePhonePayload """ Updates a WhatsApp phone. Only WhatsApp phones can be updated this way, and their forwarding settings cannot be set. """ updateMessagingPhone( """Id of the WhatsApp phone and the field values to change.""" input: UpdatePhoneInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated phone. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateMessagingPhonePayload """ Deletes a WhatsApp phone and disconnects its WhatsApp account from the space. Only WhatsApp phones can be deleted this way. """ deleteMessagingPhone( """Id of the WhatsApp phone to delete.""" input: DeletePhoneInput! ): DeleteMessagingPhonePayload """ Re-enables a WhatsApp phone that was disabled. Fails when the phone is in an error state. """ enableMessagingPhone( """Id of the WhatsApp phone; other fields are ignored.""" input: UpdatePhoneInput! ): EnableMessagingPhonePayload """ Disables a WhatsApp phone without deleting it; enableMessagingPhone turns it back on. Fails when the phone is in an error state. """ disableMessagingPhone( """Id of the WhatsApp phone; other fields are ignored.""" input: UpdatePhoneInput! ): DisableMessagingPhonePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createPipeline( """Field values of the new record.""" input: CreatePipelineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreatePipelinePayload """ Updates an existing record. Only the fields present in the input are changed. """ updatePipeline( """Id of the record and the field values to change.""" input: UpdatePipelineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdatePipelinePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdatePipeline( """Records to create or update.""" input: [CreateOrUpdatePipelineInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeletePipelineInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdatePipelinePayload """Deletes the record.""" deletePipeline( """Id of the record to delete.""" input: DeletePipelineInput! ): DeletePipelinePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProcess( """Field values of the new record.""" input: CreateProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProcessPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProcess( """Id of the record and the field values to change.""" input: UpdateProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProcessPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProcess( """Records to create or update.""" input: [CreateOrUpdateProcessInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProcessInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProcessPayload """Deletes the record.""" deleteProcess( """Id of the record to delete.""" input: DeleteProcessInput! ): DeleteProcessPayload """ Creates a new automation process from a process template, copying the template's steps and attached documents. The new process is created disabled. """ createProcessFromTemplate( """ Name, description, type and owner of the new process, and the id of the template to create it from. """ input: CreateProcessFromTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProcessFromTemplatePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProcessActivityLog( """Field values of the new record.""" input: CreateProcessActivityLogInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProcessActivityLogPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProcessActivityLog( """Id of the record and the field values to change.""" input: UpdateProcessActivityLogInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProcessActivityLogPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProcessActivityLog( """Records to create or update.""" input: [CreateOrUpdateProcessActivityLogInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProcessActivityLogInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProcessActivityLogPayload """Deletes the record.""" deleteProcessActivityLog( """Id of the record to delete.""" input: DeleteProcessActivityLogInput! ): DeleteProcessActivityLogPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProcessActivityLogLine( """Field values of the new record.""" input: CreateProcessActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProcessActivityLogLinePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProcessActivityLogLine( """Id of the record and the field values to change.""" input: UpdateProcessActivityLogLineInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProcessActivityLogLinePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProcessActivityLogLine( """Records to create or update.""" input: [CreateOrUpdateProcessActivityLogLineInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProcessActivityLogLineInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProcessActivityLogLinePayload """Deletes the record.""" deleteProcessActivityLogLine( """Id of the record to delete.""" input: DeleteProcessActivityLogLineInput! ): DeleteProcessActivityLogLinePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProcessTemplate( """Field values of the new record.""" input: CreateProcessTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProcessTemplatePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProcessTemplate( """Id of the record and the field values to change.""" input: UpdateProcessTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProcessTemplatePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProcessTemplate( """Records to create or update.""" input: [CreateOrUpdateProcessTemplateInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProcessTemplateInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProcessTemplatePayload """Deletes the record.""" deleteProcessTemplate( """Id of the record to delete.""" input: DeleteProcessTemplateInput! ): DeleteProcessTemplatePayload """Creates a new product, optionally adding it to price lists.""" createProduct( """Field values of the new record.""" input: CreateProductInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Price lists to add the new product to, with a zero price in every currency. Leave empty to add it to none. """ priceLists: SetProductPriceList ): CreateProductPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProduct( """Id of the record and the field values to change.""" input: UpdateProductInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProductPayload """ Creates and updates many products in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProduct( """Records to create or update.""" input: [CreateOrUpdateProductInput!]! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput """ Price lists to add the newly created products to, with a zero price in every currency. Updated products are not changed. Leave empty to add them to none. """ priceLists: SetProductPriceList ): BulkUpdateProductPayload """Deletes the record.""" deleteProduct( """Id of the record to delete.""" input: DeleteProductInput! ): DeleteProductPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProductCategory( """Field values of the new record.""" input: CreateProductCategoryInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProductCategoryPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProductCategory( """Id of the record and the field values to change.""" input: UpdateProductCategoryInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProductCategoryPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProductCategory( """Records to create or update.""" input: [CreateOrUpdateProductCategoryInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProductCategoryInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProductCategoryPayload """Deletes the record.""" deleteProductCategory( """Id of the record to delete.""" input: DeleteProductCategoryInput! ): DeleteProductCategoryPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProductPipelineRelation( """Field values of the new record.""" input: CreateProductPipelineRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProductPipelineRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProductPipelineRelation( """Id of the record and the field values to change.""" input: UpdateProductPipelineRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProductPipelineRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProductPipelineRelation( """Records to create or update.""" input: [CreateOrUpdateProductPipelineRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProductPipelineRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProductPipelineRelationPayload """Deletes the record.""" deleteProductPipelineRelation( """Id of the record to delete.""" input: DeleteProductPipelineRelationInput! ): DeleteProductPipelineRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProductPriceList( """Field values of the new record.""" input: CreateProductPriceListInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProductPriceListPayload """ Updates a price list. Only the fields present in the input are changed. """ updateProductPriceList( """Id of the record and the field values to change.""" input: UpdateProductPriceListInput! """ Whether the prices of the price list are also applied to existing opportunities and quotes that use it. Defaults to DontUpdatePrices. """ action: UpdateProductPriceListActionEnum """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProductPriceListPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProductPriceList( """Records to create or update.""" input: [CreateOrUpdateProductPriceListInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProductPriceListInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProductPriceListPayload """Deletes the record.""" deleteProductPriceList( """Id of the record to delete.""" input: DeleteProductPriceListInput! ): DeleteProductPriceListPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProductPriceListPrice( """Field values of the new record.""" input: CreateProductPriceListPriceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProductPriceListPricePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProductPriceListPrice( """Id of the record and the field values to change.""" input: UpdateProductPriceListPriceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProductPriceListPricePayload """ Creates, updates and deletes many price-list prices in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProductPriceListPrice( """Records to create or update.""" input: [CreateOrUpdateProductPriceListPriceInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProductPriceListPriceInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null """ Whether the saved prices are also applied to existing opportunities and quotes that use the price list. Defaults to DontUpdatePrices. """ action: UpdateProductPriceListActionEnum = DontUpdatePrices ): BulkUpdateProductPriceListPricePayload """Deletes the record.""" deleteProductPriceListPrice( """Id of the record to delete.""" input: DeleteProductPriceListPriceInput! ): DeleteProductPriceListPricePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createClientFavorite( """Field values of the new record.""" input: CreateClientFavoriteInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateClientFavoritePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateClientFavorite( """Id of the record and the field values to change.""" input: UpdateClientFavoriteInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateClientFavoritePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateClientFavorite( """Records to create or update.""" input: [CreateOrUpdateClientFavoriteInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteClientFavoriteInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateClientFavoritePayload """Deletes the record.""" deleteClientFavorite( """Id of the record to delete.""" input: DeleteClientFavoriteInput! ): DeleteClientFavoritePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProfileRelation( """Field values of the new record.""" input: CreateProfileRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProfileRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProfileRelation( """Id of the record and the field values to change.""" input: UpdateProfileRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProfileRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProfileRelation( """Records to create or update.""" input: [CreateOrUpdateProfileRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProfileRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProfileRelationPayload """Deletes the record.""" deleteProfileRelation( """Id of the record to delete.""" input: DeleteProfileRelationInput! ): DeleteProfileRelationPayload """ Assigns the record to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipProject( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipProjectInput! ): ChangeOwnershipProjectPayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingProject( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingProjectInput! ): ManageSharingProjectPayload """ Marks as completed every unfinished task of the project that belongs to the given objective. Without an objective, completes the project's tasks that are not assigned to any objective. """ completeTasksProject( """ Parameters of the operation; each field is described on the input type. """ input: CompleteTasksProjectInput! ): BulkUpdateEntitiesPayload """ Marks the project as completed. Without new dates, a project that is in progress gets today as its end date; completing an already completed project fails. """ completeProject( """ Parameters of the operation; each field is described on the input type. """ input: CompleteProjectInput! ): BulkUpdateEntitiesPayload """ Reopens a completed project with a new period. A project counts as completed when it was completed explicitly or its end date has passed. """ reopenProject( """ Parameters of the operation; each field is described on the input type. """ input: ReopenProjectInput! ): ReopenProjectPayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreProject( """ Parameters of the operation; each field is described on the input type. """ input: RestoreProjectInput! ): RestoreProjectPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProject( """Field values of the new record.""" input: CreateProjectInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProjectPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProject( """Id of the record and the field values to change.""" input: UpdateProjectInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProjectPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProject( """Records to create or update.""" input: [CreateOrUpdateProjectInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProjectInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProjectPayload """Deletes the record.""" deleteProject( """Id of the record to delete.""" input: DeleteProjectInput! ): DeleteProjectPayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertProject( """Field values of the new record.""" input: CreateProjectInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertProjectPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProjectContactRelation( """Field values of the new record.""" input: CreateProjectContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProjectContactRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProjectContactRelation( """Id of the record and the field values to change.""" input: UpdateProjectContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProjectContactRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProjectContactRelation( """Records to create or update.""" input: [CreateOrUpdateProjectContactRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProjectContactRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProjectContactRelationPayload """Deletes the record.""" deleteProjectContactRelation( """Id of the record to delete.""" input: DeleteProjectContactRelationInput! ): DeleteProjectContactRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProjectKpi( """Field values of the new record.""" input: CreateProjectKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProjectKPIPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProjectKpi( """Id of the record and the field values to change.""" input: UpdateProjectKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProjectKPIPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProjectKpi( """Records to create or update.""" input: [CreateOrUpdateProjectKPIInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProjectKPIInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProjectKPIPayload """Deletes the record.""" deleteProjectKpi( """Id of the record to delete.""" input: DeleteProjectKPIInput! ): DeleteProjectKPIPayload """ Moves the objective to a new position in its project's list of objectives. """ updateProjectObjectiveSort( """ Parameters of the operation; each field is described on the input type. """ input: UpdateProjectObjectiveSortInput! ): UpdateProjectObjectiveSortPayload """ Creates a copy of the project objective, named with a copy suffix and placed after the other objectives of the project. """ copyProjectObjective( """ Parameters of the operation; each field is described on the input type. """ input: CopyProjectObjectiveInput! ): CopyProjectObjectivePayload """ Moves one or more activities of a project to a position within an objective, or out of all objectives. The moved activities keep the order in which they are listed. """ updateProjectObjectiveActivitiesSort( """ Parameters of the operation; each field is described on the input type. """ input: UpdateProjectObjectiveActivitiesSortInput! ): UpdateProjectObjectiveActivitiesSortPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProjectObjective( """Field values of the new record.""" input: CreateProjectObjectiveInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProjectObjectivePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProjectObjective( """Id of the record and the field values to change.""" input: UpdateProjectObjectiveInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProjectObjectivePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProjectObjective( """Records to create or update.""" input: [CreateOrUpdateProjectObjectiveInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProjectObjectiveInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProjectObjectivePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProjectSharingClientRelation( """Field values of the new record.""" input: CreateProjectSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProjectSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProjectSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateProjectSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProjectSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProjectSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateProjectSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProjectSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProjectSharingClientRelationPayload """Deletes the record.""" deleteProjectSharingClientRelation( """Id of the record to delete.""" input: DeleteProjectSharingClientRelationInput! ): DeleteProjectSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createProjectSharingSalesUnitRelation( """Field values of the new record.""" input: CreateProjectSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateProjectSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateProjectSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateProjectSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateProjectSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateProjectSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateProjectSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteProjectSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateProjectSharingSalesUnitRelationPayload """Deletes the record.""" deleteProjectSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteProjectSharingSalesUnitRelationInput! ): DeleteProjectSharingSalesUnitRelationPayload """ Assigns the quote to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipQuote( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipQuoteInput! ): ChangeOwnershipQuotePayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingQuote( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingQuoteInput! ): ManageSharingQuotePayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreQuote( """ Parameters of the operation; each field is described on the input type. """ input: RestoreQuoteInput! ): RestoreQuotePayload """ Archives the quote, closing it as lost, and can archive its opportunity at the same time. Conditionally required fields are enforced. """ archiveQuote( """ Parameters of the operation; each field is described on the input type. """ input: ArchiveQuoteInput! ): ArchiveQuotePayload """ Takes the quote out of the archive so it is open again. Field validations are not applied. """ reactivateQuote( """ Parameters of the operation; each field is described on the input type. """ input: ReactivateQuoteInput! ): ReactivateQuotePayload """ Moves the quote to another step of its current quote process. Moving forward enforces conditionally required fields; use changeQuoteProcess to switch processes. """ moveQuote( """ Parameters of the operation; each field is described on the input type. """ input: MoveQuoteInput! ): MoveQuotePayload """ Moves the quote to a step of another quote process, optionally changing its owner at the same time. """ changePipelineQuote( """ Parameters of the operation; each field is described on the input type. """ input: ChangePipelineQuoteInput! ): ChangePipelineQuotePayload """ Moves the quote to another quote process by changing its quote type and step, optionally changing its owner at the same time. Both quoteTypeId and stepId must be sent. """ changeQuoteProcess( """ Parameters of the operation; each field is described on the input type. """ input: ChangeQuoteProcessInput! ): ChangeQuoteProcessPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuote( """Field values of the new record.""" input: CreateQuoteInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuotePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuote( """Id of the record and the field values to change.""" input: UpdateQuoteInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuotePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuote( """Records to create or update.""" input: [CreateOrUpdateQuoteInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuotePayload """Deletes the record.""" deleteQuote( """Id of the record to delete.""" input: DeleteQuoteInput! ): DeleteQuotePayload """Archives many quotes in one request, as archiveQuote does.""" bulkArchiveQuote( """ Parameters of the operation; each field is described on the input type. """ input: BulkArchiveQuoteInput! ): BulkArchiveQuotePayload """ Takes many archived quotes out of the archive in one request. Field validations are not applied. """ bulkReactivateQuote( """ Parameters of the operation; each field is described on the input type. """ input: BulkReactivateQuoteInput! ): BulkReactivateQuotePayload """ Moves many quotes to another step of their quote process in one request, as moveQuote does. """ bulkMoveQuote( """ Parameters of the operation; each field is described on the input type. """ input: BulkMoveQuoteInput! ): BulkMoveQuotePayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertQuote( """Field values of the new record.""" input: CreateQuoteInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertQuotePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuoteAccountRelation( """Field values of the new record.""" input: CreateQuoteAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuoteAccountRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuoteAccountRelation( """Id of the record and the field values to change.""" input: UpdateQuoteAccountRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuoteAccountRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuoteAccountRelation( """Records to create or update.""" input: [CreateOrUpdateQuoteAccountRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteAccountRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuoteAccountRelationPayload """Deletes the record.""" deleteQuoteAccountRelation( """Id of the record to delete.""" input: DeleteQuoteAccountRelationInput! ): DeleteQuoteAccountRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuoteContactRelation( """Field values of the new record.""" input: CreateQuoteContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuoteContactRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuoteContactRelation( """Id of the record and the field values to change.""" input: UpdateQuoteContactRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuoteContactRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuoteContactRelation( """Records to create or update.""" input: [CreateOrUpdateQuoteContactRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteContactRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuoteContactRelationPayload """Deletes the record.""" deleteQuoteContactRelation( """Id of the record to delete.""" input: DeleteQuoteContactRelationInput! ): DeleteQuoteContactRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuoteDataExRelation( """Field values of the new record.""" input: CreateQuoteDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuoteDataExRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuoteDataExRelation( """Id of the record and the field values to change.""" input: UpdateQuoteDataExRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuoteDataExRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuoteDataExRelation( """Records to create or update.""" input: [CreateOrUpdateQuoteDataExRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteDataExRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuoteDataExRelationPayload """Deletes the record.""" deleteQuoteDataExRelation( """Id of the record to delete.""" input: DeleteQuoteDataExRelationInput! ): DeleteQuoteDataExRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuoteKpi( """Field values of the new record.""" input: CreateQuoteKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuoteKPIPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuoteKpi( """Id of the record and the field values to change.""" input: UpdateQuoteKPIInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuoteKPIPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuoteKpi( """Records to create or update.""" input: [CreateOrUpdateQuoteKPIInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteKPIInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuoteKPIPayload """Deletes the record.""" deleteQuoteKpi( """Id of the record to delete.""" input: DeleteQuoteKPIInput! ): DeleteQuoteKPIPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuoteProcess( """Field values of the new record.""" input: CreateQuoteProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuoteProcessPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuoteProcess( """Id of the record and the field values to change.""" input: UpdateQuoteProcessInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuoteProcessPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuoteProcess( """Records to create or update.""" input: [CreateOrUpdateQuoteProcessInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteProcessInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuoteProcessPayload """Deletes the record.""" deleteQuoteProcess( """Id of the record to delete.""" input: DeleteQuoteProcessInput! ): DeleteQuoteProcessPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuoteSharingClientRelation( """Field values of the new record.""" input: CreateQuoteSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuoteSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuoteSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateQuoteSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuoteSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuoteSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateQuoteSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuoteSharingClientRelationPayload """Deletes the record.""" deleteQuoteSharingClientRelation( """Id of the record to delete.""" input: DeleteQuoteSharingClientRelationInput! ): DeleteQuoteSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createQuoteSharingSalesUnitRelation( """Field values of the new record.""" input: CreateQuoteSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateQuoteSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateQuoteSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateQuoteSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateQuoteSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateQuoteSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateQuoteSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteQuoteSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateQuoteSharingSalesUnitRelationPayload """Deletes the record.""" deleteQuoteSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteQuoteSharingSalesUnitRelationInput! ): DeleteQuoteSharingSalesUnitRelationPayload """ Transfers the report to another user. Nothing changes when that user already owns it. """ changeOwnershipReport( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipReportInput! ): ChangeOwnershipReportPayload """ Sets up or replaces the calling user's scheduled email delivery of the report. Schedules are personal: each user has their own schedule on a report. """ setScheduleReport( """ Parameters of the operation; each field is described on the input type. """ input: SetScheduleReportInput! ): SetScheduleReportPayload """ Removes the calling user's scheduled email delivery of the report, so no further emails are sent. Does nothing when no schedule is set. """ removeScheduleReport( """ Parameters of the operation; each field is described on the input type. """ input: RemoveScheduleReportInput! ): RemoveScheduleReportPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createReportSchedule( """Field values of the new record.""" input: CreateReportScheduleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateReportSchedulePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateReportSchedule( """Id of the record and the field values to change.""" input: UpdateReportScheduleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateReportSchedulePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateReportSchedule( """Records to create or update.""" input: [CreateOrUpdateReportScheduleInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteReportScheduleInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateReportSchedulePayload """Deletes the record.""" deleteReportSchedule( """Id of the record to delete.""" input: DeleteReportScheduleInput! ): DeleteReportSchedulePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createSalesRole( """Field values of the new record.""" input: CreateSalesRoleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateSalesRolePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateSalesRole( """Id of the record and the field values to change.""" input: UpdateSalesRoleInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateSalesRolePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateSalesRole( """Records to create or update.""" input: [CreateOrUpdateSalesRoleInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteSalesRoleInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateSalesRolePayload """Deletes the record.""" deleteSalesRole( """Id of the record to delete.""" input: DeleteSalesRoleInput! ): DeleteSalesRolePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createSalesUnit( """Field values of the new record.""" input: CreateSalesUnitInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateSalesUnitPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateSalesUnit( """Id of the record and the field values to change.""" input: UpdateSalesUnitInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateSalesUnitPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateSalesUnit( """Records to create or update.""" input: [CreateOrUpdateSalesUnitInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteSalesUnitInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateSalesUnitPayload """Deletes the record.""" deleteSalesUnit( """Id of the record to delete.""" input: DeleteSalesUnitInput! ): DeleteSalesUnitPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createSolution( """Field values of the new record.""" input: CreateSolutionInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateSolutionPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateSolution( """Id of the record and the field values to change.""" input: UpdateSolutionInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateSolutionPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateSolution( """Records to create or update.""" input: [CreateOrUpdateSolutionInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteSolutionInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateSolutionPayload """Deletes the record.""" deleteSolution( """Id of the record to delete.""" input: DeleteSolutionInput! ): DeleteSolutionPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createSolutionTemplate( """Field values of the new record.""" input: CreateSolutionTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateSolutionTemplatePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateSolutionTemplate( """Id of the record and the field values to change.""" input: UpdateSolutionTemplateInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateSolutionTemplatePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateSolutionTemplate( """Records to create or update.""" input: [CreateOrUpdateSolutionTemplateInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteSolutionTemplateInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateSolutionTemplatePayload """Deletes the record.""" deleteSolutionTemplate( """Id of the record to delete.""" input: DeleteSolutionTemplateInput! ): DeleteSolutionTemplatePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createStep( """Field values of the new record.""" input: CreateStepInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateStepPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateStep( """Id of the record and the field values to change.""" input: UpdateStepInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateStepPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateStep( """Records to create or update.""" input: [CreateOrUpdateStepInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteStepInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateStepPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createStepChecklist( """Field values of the new record.""" input: CreateStepChecklistInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateStepChecklistPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateStepChecklist( """Id of the record and the field values to change.""" input: UpdateStepChecklistInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateStepChecklistPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateStepChecklist( """Records to create or update.""" input: [CreateOrUpdateStepChecklistInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteStepChecklistInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateStepChecklistPayload """Deletes the record.""" deleteStepChecklist( """Id of the record to delete.""" input: DeleteStepChecklistInput! ): DeleteStepChecklistPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createStepChecklistSalesRoleRelation( """Field values of the new record.""" input: CreateStepChecklistSalesRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateStepChecklistSalesRoleRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateStepChecklistSalesRoleRelation( """Id of the record and the field values to change.""" input: UpdateStepChecklistSalesRoleRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateStepChecklistSalesRoleRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateStepChecklistSalesRoleRelation( """Records to create or update.""" input: [CreateOrUpdateStepChecklistSalesRoleRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteStepChecklistSalesRoleRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateStepChecklistSalesRoleRelationPayload """Deletes the record.""" deleteStepChecklistSalesRoleRelation( """Id of the record to delete.""" input: DeleteStepChecklistSalesRoleRelationInput! ): DeleteStepChecklistSalesRoleRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTag( """Field values of the new record.""" input: CreateTagInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTagPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTag( """Id of the record and the field values to change.""" input: UpdateTagInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTagPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTag( """Records to create or update.""" input: [CreateOrUpdateTagInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTagInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTagPayload """Deletes the record.""" deleteTag( """Id of the record to delete.""" input: DeleteTagInput! ): DeleteTagPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTagRelation( """Field values of the new record.""" input: CreateTagRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTagRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTagRelation( """Id of the record and the field values to change.""" input: UpdateTagRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTagRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTagRelation( """Records to create or update.""" input: [CreateOrUpdateTagRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTagRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTagRelationPayload """Deletes the record.""" deleteTagRelation( """Id of the record to delete.""" input: DeleteTagRelationInput! ): DeleteTagRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTarget( """Field values of the new record.""" input: CreateTargetInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTargetPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTarget( """Id of the record and the field values to change.""" input: UpdateTargetInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTargetPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTarget( """Records to create or update.""" input: [CreateOrUpdateTargetInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTargetInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTargetPayload """Deletes the target.""" deleteTarget( """Id of the record to delete.""" input: DeleteTargetInput! """ When true, the child targets of the target are deleted as well; when false, they are kept and only detached from it. """ deleteChildren: Boolean! ): DeleteTargetPayload """ Updates the calculation settings of one or more targets: which indicators are included, whether the target value is locked, the chart granularity and the calculated and custom indicator values. All these settings are overwritten; the target's period and filter are kept. """ updateDetailSettingsTarget( """ One item per target, identified by its id, carrying the complete new values. """ input: [UpdateTargetSettingsInput!]! ): UpdateDetailSettingsTargetPayload """ Activates a draft target so its progress is tracked over the period computed from its period settings; activating a group target also activates its inactive user targets. On a target that was finished early, the finish is undone for it and for its child targets whose period has not ended yet. """ activateTarget( """ Parameters of the operation; each field is described on the input type. """ input: ActivateTargetInput! ): ActivateTargetPayload """ Activates several user targets at once, as activateTarget does for each. Group targets and targets that cannot be activated are skipped without an error. """ bulkActivateUserTarget( """ Parameters of the operation; each field is described on the input type. """ input: BulkActivateUserTargetInput! ): BulkActivateUserTargetPayload """ Finishes an active target early, ending its tracking as of today. Fails when the target is not active. """ finishTarget( """ Parameters of the operation; each field is described on the input type. """ input: FinishTargetInput! ): FinishTargetPayload """ Finishes several active user targets at once, as finishTarget does for each. Group targets and targets that cannot be finished are skipped without an error. """ bulkFinishUserTarget( """ Parameters of the operation; each field is described on the input type. """ input: BulkFinishUserTargetInput! ): BulkFinishUserTargetPayload """ Creates an inactive draft copy of the target, owned by the calling user, with the same assignee, description and settings. Copying a group target also creates draft copies of its user targets, named with a copy suffix. """ copyTarget( """ Parameters of the operation; each field is described on the input type. """ input: CopyTargetInput! ): CopyTargetPayload """ Removes a user target from a group target. The user target itself is kept. """ removeTarget( """ Parameters of the operation; each field is described on the input type. """ input: RemoveTargetInput! ): RemoveTargetPayload """ Removes several user targets from their group targets at once. The user targets themselves are kept. """ bulkRemoveTarget( """ Parameters of the operation; each field is described on the input type. """ input: BulkRemoveTargetInput! ): BulkRemoveTargetPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTargetRelation( """Field values of the new record.""" input: CreateTargetRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTargetRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTargetRelation( """Id of the record and the field values to change.""" input: UpdateTargetRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTargetRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTargetRelation( """Records to create or update.""" input: [CreateOrUpdateTargetRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTargetRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTargetRelationPayload """Deletes the record.""" deleteTargetRelation( """Id of the record to delete.""" input: DeleteTargetRelationInput! ): DeleteTargetRelationPayload """ Assigns the task to a new owner and sales unit. The new owner must be a member or manager of that sales unit. """ changeOwnershipTask( """ Parameters of the operation; each field is described on the input type. """ input: ChangeOwnershipTaskInput! ): ChangeOwnershipTaskPayload """Removes the owner from the task, leaving it unassigned.""" releaseOwnershipTask( """ Parameters of the operation; each field is described on the input type. """ input: ReleaseOwnershipTaskInput! ): ReleaseOwnershipTaskPayload """ Sets how the record is shared: the sharing mode and the users and sales units it is shared with. A list that is sent replaces the current one; an omitted list is left unchanged. """ manageSharingTask( """ Parameters of the operation; each field is described on the input type. """ input: ManageSharingTaskInput! ): ManageSharingTaskPayload """ Restores a deleted record, making it visible again with its previous data and relations. """ restoreTask( """ Parameters of the operation; each field is described on the input type. """ input: RestoreTaskInput! ): RestoreTaskPayload """ Sets the calling user's reminder on the task, or updates it when one exists. Reminders are personal: each user has their own reminder on a task. """ setReminderTask( """ Parameters of the operation; each field is described on the input type. """ input: SetReminderTaskInput! ): SetReminderTaskPayload """ Dismisses the calling user's reminder on the task so that it no longer fires, including the user's default reminder. Reminders of other users are not affected. """ removeReminderTask( """ Parameters of the operation; each field is described on the input type. """ input: RemoveReminderTaskInput! ): RemoveReminderTaskPayload """ Changes the status of the task, for example to InProgress or Completed. """ setTaskStatus( """ Parameters of the operation; each field is described on the input type. """ input: SetTaskStatusInput! ): SetTaskStatusPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTask( """Field values of the new record.""" input: CreateTaskInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTaskPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTask( """Id of the record and the field values to change.""" input: UpdateTaskInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTaskPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTask( """Records to create or update.""" input: [CreateOrUpdateTaskInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTaskInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTaskPayload """Deletes the record.""" deleteTask( """Id of the record to delete.""" input: DeleteTaskInput! ): DeleteTaskPayload """ Creates a new record from an existing record of another type, then optionally archives or deletes the source. When the source is deleted, its activities, documents and notes move to the new record. """ convertTask( """Field values of the new record.""" input: CreateTaskInput! """Entity type of the record being converted.""" sourceEntity: EntityNameEnum! """Id of the record being converted.""" sourceEntityId: UUID! """ What happens to the source record: Nothing keeps it, Archive archives it, Delete moves its linked records to the new record and deletes it. """ operation: RecordConversionOperationEnum! """ With the Archive operation, which related records of the source are archived or completed as well. Only the options that apply to the source type are used. """ options: RecordConversionOptions! """ API name of the source custom entity; leave empty when the source is a standard entity. """ sourceEntityApiName: String = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = null ): ConvertTaskPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTaskRecurrence( """Field values of the new record.""" input: CreateTaskRecurrenceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTaskRecurrencePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTaskRecurrence( """Id of the record and the field values to change.""" input: UpdateTaskRecurrenceInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTaskRecurrencePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTaskRecurrence( """Records to create or update.""" input: [CreateOrUpdateTaskRecurrenceInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTaskRecurrenceInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTaskRecurrencePayload """Deletes the record.""" deleteTaskRecurrence( """Id of the record to delete.""" input: DeleteTaskRecurrenceInput! ): DeleteTaskRecurrencePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTaskReminder( """Field values of the new record.""" input: CreateTaskReminderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTaskReminderPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTaskReminder( """Id of the record and the field values to change.""" input: UpdateTaskReminderInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTaskReminderPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTaskReminder( """Records to create or update.""" input: [CreateOrUpdateTaskReminderInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTaskReminderInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTaskReminderPayload """Deletes the record.""" deleteTaskReminder( """Id of the record to delete.""" input: DeleteTaskReminderInput! ): DeleteTaskReminderPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTaskSharingClientRelation( """Field values of the new record.""" input: CreateTaskSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTaskSharingClientRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTaskSharingClientRelation( """Id of the record and the field values to change.""" input: UpdateTaskSharingClientRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTaskSharingClientRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTaskSharingClientRelation( """Records to create or update.""" input: [CreateOrUpdateTaskSharingClientRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTaskSharingClientRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTaskSharingClientRelationPayload """Deletes the record.""" deleteTaskSharingClientRelation( """Id of the record to delete.""" input: DeleteTaskSharingClientRelationInput! ): DeleteTaskSharingClientRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTaskSharingSalesUnitRelation( """Field values of the new record.""" input: CreateTaskSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTaskSharingSalesUnitRelationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTaskSharingSalesUnitRelation( """Id of the record and the field values to change.""" input: UpdateTaskSharingSalesUnitRelationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTaskSharingSalesUnitRelationPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTaskSharingSalesUnitRelation( """Records to create or update.""" input: [CreateOrUpdateTaskSharingSalesUnitRelationInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTaskSharingSalesUnitRelationInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTaskSharingSalesUnitRelationPayload """Deletes the record.""" deleteTaskSharingSalesUnitRelation( """Id of the record to delete.""" input: DeleteTaskSharingSalesUnitRelationInput! ): DeleteTaskSharingSalesUnitRelationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTextMessage( """Field values of the new record.""" input: CreateTextMessageInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTextMessagePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTextMessage( """Id of the record and the field values to change.""" input: UpdateTextMessageInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTextMessagePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTextMessageConversation( """Field values of the new record.""" input: CreateTextMessageConversationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTextMessageConversationPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTextMessageConversation( """Id of the record and the field values to change.""" input: UpdateTextMessageConversationInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTextMessageConversationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createTextMessageConversationRelations( """Field values of the new record.""" input: CreateTextMessageConversationRelationsInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateTextMessageConversationRelationsPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateTextMessageConversationRelations( """Id of the record and the field values to change.""" input: UpdateTextMessageConversationRelationsInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateTextMessageConversationRelationsPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateTextMessageConversationRelations( """Records to create or update.""" input: [CreateOrUpdateTextMessageConversationRelationsInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteTextMessageConversationRelationsInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateTextMessageConversationRelationsPayload """Deletes the record.""" deleteTextMessageConversationRelations( """Id of the record to delete.""" input: DeleteTextMessageConversationRelationsInput! ): DeleteTextMessageConversationRelationsPayload """ Deletes the record and publishes the deletion immediately; unrelated pending drafts stay unpublished. """ deleteTranslation( """Id of the record to delete.""" input: DeleteDraftTranslationInput! ): DeleteTranslationPayload """ Creates a new record and publishes it immediately; unrelated pending drafts stay unpublished. """ createTranslation( """Field values of the new record.""" input: CreateDraftTranslationInput! ): CreateTranslationPayload """ Updates an existing record and publishes the change immediately; unrelated pending drafts stay unpublished. Only the fields present in the input are changed. """ updateTranslation( """Id of the record and the field values to change.""" input: UpdateDraftTranslationInput! ): UpdateTranslationPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createUnsubscribedPhone( """Field values of the new record.""" input: CreateUnsubscribedPhoneInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateUnsubscribedPhonePayload """ Updates an existing record. Only the fields present in the input are changed. """ updateUnsubscribedPhone( """Id of the record and the field values to change.""" input: UpdateUnsubscribedPhoneInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateUnsubscribedPhonePayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateUnsubscribedPhone( """Records to create or update.""" input: [CreateOrUpdateUnsubscribedPhoneInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteUnsubscribedPhoneInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateUnsubscribedPhonePayload """Deletes the record.""" deleteUnsubscribedPhone( """Id of the record to delete.""" input: DeleteUnsubscribedPhoneInput! ): DeleteUnsubscribedPhonePayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createWebhook( """Field values of the new record.""" input: CreateWebhookInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateWebhookPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateWebhook( """Id of the record and the field values to change.""" input: UpdateWebhookInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateWebhookPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateWebhook( """Records to create or update.""" input: [CreateOrUpdateWebhookInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteWebhookInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateWebhookPayload """Deletes the record.""" deleteWebhook( """Id of the record to delete.""" input: DeleteWebhookInput! ): DeleteWebhookPayload """ Creates a new record. For a relation record, an existing relation between the same records is restored and returned instead. """ createWebhookEvent( """Field values of the new record.""" input: CreateWebhookEventInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] ): CreateWebhookEventPayload """ Updates an existing record. Only the fields present in the input are changed. """ updateWebhookEvent( """Id of the record and the field values to change.""" input: UpdateWebhookEventInput! """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] """ Id of an open list view whose data is refreshed with the updated record. Integrations can leave it empty. """ sessionIdToUpdate: String ): UpdateWebhookEventPayload """ Creates, updates and deletes many records in one request. Items with an id are updated; items without an id are created, or matched to an existing record when match is set. """ bulkUpdateWebhookEvent( """Records to create or update.""" input: [CreateOrUpdateWebhookEventInput!]! """Records to delete; deletions run before the updates.""" deleteInput: [DeleteWebhookEventInput!] = null """Validations to skip while saving. Leave empty for full validation.""" validationLevel: [ValidationLevel!] = [] """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Finds existing records for items without an id, so they are updated instead of created. Requires ROLLBACK_FAILED. """ match: MatchingInput = null ): BulkUpdateWebhookEventPayload """Deletes the record.""" deleteWebhookEvent( """Id of the record to delete.""" input: DeleteWebhookEventInput! ): DeleteWebhookEventPayload } """Result of the changeOwnershipAccount mutation.""" type ChangeOwnershipAccountPayload { """The account with its new owner.""" result: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipAccount mutation.""" input ChangeOwnershipAccountInput { """User who becomes the new owner of the account.""" ownerId: ID! """Sales unit the account is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the account as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """ When true, the new owner and sales unit are also applied to the account's open tasks and appointments, its notes, its open leads and opportunities, its linked contacts and its direct child accounts. Linked records that cannot be transferred are skipped without failing the mutation. """ transferLinkedRecords: Boolean! """Identifier of the AccountEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingAccount mutation.""" type ManageSharingAccountPayload { """The record with its updated sharing.""" result: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingAccount mutation.""" input ManageSharingAccountInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateAccountSharingClientRelationNoAccountBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!] """Identifier of the AccountEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new AccountSharingClientRelation record, created together with the record it belongs to. """ input CreateAccountSharingClientRelationNoAccountBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AccountSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateAccountSharingSalesUnitRelationNoAccountBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the restoreAccount mutation.""" type RestoreAccountPayload { """The restored record.""" result: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreAccount mutation.""" input RestoreAccountInput { """Identifier of the AccountEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyAccount mutation.""" type CopyAccountPayload { """The new account.""" result: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyAccount mutation.""" input CopyAccountInput { """ When true, the copy keeps the original name without the copy suffix. Defaults to false. """ skipCopySuffix: Boolean """Identifier of the AccountEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the mergeAccount mutation.""" type MergeAccountPayload { """The merged master account.""" result: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the mergeAccount mutation.""" input MergeAccountInput { """Id of the account to keep and the field values it should end up with.""" master: UpdateAccountInput! """ Id of the duplicate account that is merged into the master and then deleted. """ slaveId: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an Account record and the field values to change.""" input UpdateAccountInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture or company logo associated with the account.""" picture: CreateCloudObjectInput """ Manual classification grade assigned to the account. Used in segmentation and reporting. """ accountClass: AccountClassEnum """Id of the account type assigned to this account.""" accountTypeId: ID """Street address of the account.""" address: String """City of the account address.""" city: String """Free-form notes describing the account.""" comments: String """Country of the account address.""" country: String """Id of the currency exchange rate list applied to this account.""" currencyExchangeRatesListId: ID """ Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. """ customerTypeId: ID """ Primary email address of the account. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """ Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. """ homePage: String """Id of the industry classification.""" industryId: ID """ True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ Time when an AI-suggested account hierarchy was last applied to this account. """ lastAiAccountHierarchyApplied: DateTime """Time when an AI-suggested org chart was last applied to this account.""" lastAiOrgChartApplied: DateTime """Name of the entity and its default text representation.""" name: String """Id of the account owner.""" ownerId: ID """ Id of the parent account in the corporate hierarchy. Empty for top-level accounts. """ parentAccountId: ID """Id of the parent-account relationship type.""" parentAccountRelationTypeId: ID """ Primary phone number of the account. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """ Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. """ quickParentAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the account address.""" stateProvince: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the account address.""" zipCode: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Social network profiles linked to this account (e.g. LinkedIn, Facebook). """ socialMedia: UpdateAccountSocialRelationNoIdBackrefInput """ Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!] """ Users that have been granted shared access to this account. Editable only when shareMode allows user sharing. """ sharingClients: [CreateAccountSharingClientRelationNoAccountBackrefInput!] """Documents linked to this account.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this account.""" tags: [CreateTagRelationNoAccountBackrefInput!] """Saved view profiles this account currently matches.""" staticProfiles: [CreateProfileRelationNoAccountBackrefInput!] } """ Id of an AccountSocialRelation record and the field values to change, updated together with the record it belongs to. """ input UpdateAccountSocialRelationNoIdBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the account.""" angellistUrl: String """Crunchbase profile URL of the account.""" crunchbaseUrl: String """Disqus profile URL of the account.""" disqusUrl: String """Facebook page or profile id of the account.""" facebookId: String """Facebook profile URL of the account.""" facebookUrl: String """Flickr profile URL of the account.""" flickrUrl: String """Foursquare profile URL of the account.""" foursquareUrl: String """Google business or profile id of the account.""" googleId: String """Google+ profile URL of the account.""" googlePlusUrl: String """Gravatar profile URL of the account.""" gravatarUrl: String """Klout profile URL of the account.""" kloutUrl: String """LinkedIn company or profile id of the account.""" linkedinId: String """LinkedIn profile URL of the account.""" linkedinUrl: String """Pinterest profile URL of the account.""" pinterestUrl: String """Quora profile URL of the account.""" quoraUrl: String """Reddit profile URL of the account.""" redditUrl: String """Skype contact URL or username of the account.""" skypeUrl: String """SlideShare profile URL of the account.""" slideshareUrl: String """Twitter (X) user id of the account.""" twitterId: String """Twitter (X) profile URL of the account.""" twitterUrl: String """Vimeo profile URL of the account.""" vimeoUrl: String """WordPress site URL of the account.""" wordpressUrl: String """XING profile URL of the account.""" xingUrl: String """Yahoo profile URL of the account.""" yahooUrl: String """Yelp business URL of the account.""" yelpUrl: String """YouTube channel URL of the account.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoAccountBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ProfileRelation record, created together with the record it belongs to. """ input CreateProfileRelationNoAccountBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID } """Result of the archiveAccount mutation.""" type ArchiveAccountPayload { """The archived account.""" result: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the archiveAccount mutation.""" input ArchiveAccountInput { """ Id of the account and optional field values to save together with the archive. """ entity: UpdateAccountInput! """Completes all unfinished projects of the account.""" completeAllRelatedProjects: Boolean! """Archives open leads whose primary account is this account.""" archiveAllRelatedLeads: Boolean! """Archives open opportunities whose primary account is this account.""" archiveAllRelatedOpportunities: Boolean! """Archives open quotes whose primary account is this account.""" archiveAllRelatedQuotes: Boolean! """Archives contacts whose primary account is this account.""" archiveAllRelatedContacts: Boolean! """Marks all tasks linked to the account as completed.""" completeAllRelatedTasks: Boolean! """ Marks tasks of contacts whose primary account is this account as completed. """ completeAllRelatedContactsTasks: Boolean """ Marks tasks of leads whose primary account is this account as completed. """ completeAllRelatedLeadsTasks: Boolean """ Marks tasks of opportunities whose primary account is this account as completed. """ completeAllRelatedOpportunitiesTasks: Boolean """ Marks tasks of quotes whose primary account is this account as completed. """ completeAllRelatedQuotesTasks: Boolean """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the reactivateAccount mutation.""" type ReactivateAccountPayload { """The reactivated account.""" result: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the reactivateAccount mutation.""" input ReactivateAccountInput { """Id of the archived account.""" id: UUID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccount mutation.""" type CreateAccountPayload { """The created record.""" account: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Account record.""" input CreateAccountInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture or company logo associated with the account.""" picture: CreateCloudObjectInput """ Manual classification grade assigned to the account. Used in segmentation and reporting. """ accountClass: AccountClassEnum """Id of the account type assigned to this account.""" accountTypeId: ID """Street address of the account.""" address: String """City of the account address.""" city: String """Free-form notes describing the account.""" comments: String """Country of the account address.""" country: String """Id of the currency exchange rate list applied to this account.""" currencyExchangeRatesListId: ID """ Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. """ customerTypeId: ID """ Primary email address of the account. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """ Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. """ homePage: String """Id of the industry classification.""" industryId: ID """ True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ Time when an AI-suggested account hierarchy was last applied to this account. """ lastAiAccountHierarchyApplied: DateTime """Time when an AI-suggested org chart was last applied to this account.""" lastAiOrgChartApplied: DateTime """Name of the entity and its default text representation.""" name: String! """Id of the account owner.""" ownerId: ID! """ Id of the parent account in the corporate hierarchy. Empty for top-level accounts. """ parentAccountId: ID """Id of the parent-account relationship type.""" parentAccountRelationTypeId: ID """ Primary phone number of the account. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """ Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. """ quickParentAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the account address.""" stateProvince: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the account address.""" zipCode: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Social network profiles linked to this account (e.g. LinkedIn, Facebook). """ socialMedia: CreateAccountSocialRelationNoIdBackrefInput """ Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!] """ Users that have been granted shared access to this account. Editable only when shareMode allows user sharing. """ sharingClients: [CreateAccountSharingClientRelationNoAccountBackrefInput!] """Documents linked to this account.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this account.""" tags: [CreateTagRelationNoAccountBackrefInput!] """Saved view profiles this account currently matches.""" staticProfiles: [CreateProfileRelationNoAccountBackrefInput!] } """ Field values of a new AccountSocialRelation record, created together with the record it belongs to. """ input CreateAccountSocialRelationNoIdBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the account.""" angellistUrl: String """Crunchbase profile URL of the account.""" crunchbaseUrl: String """Disqus profile URL of the account.""" disqusUrl: String """Facebook page or profile id of the account.""" facebookId: String """Facebook profile URL of the account.""" facebookUrl: String """Flickr profile URL of the account.""" flickrUrl: String """Foursquare profile URL of the account.""" foursquareUrl: String """Google business or profile id of the account.""" googleId: String """Google+ profile URL of the account.""" googlePlusUrl: String """Gravatar profile URL of the account.""" gravatarUrl: String """Klout profile URL of the account.""" kloutUrl: String """LinkedIn company or profile id of the account.""" linkedinId: String """LinkedIn profile URL of the account.""" linkedinUrl: String """Pinterest profile URL of the account.""" pinterestUrl: String """Quora profile URL of the account.""" quoraUrl: String """Reddit profile URL of the account.""" redditUrl: String """Skype contact URL or username of the account.""" skypeUrl: String """SlideShare profile URL of the account.""" slideshareUrl: String """Twitter (X) user id of the account.""" twitterId: String """Twitter (X) profile URL of the account.""" twitterUrl: String """Vimeo profile URL of the account.""" vimeoUrl: String """WordPress site URL of the account.""" wordpressUrl: String """XING profile URL of the account.""" xingUrl: String """Yahoo profile URL of the account.""" yahooUrl: String """Yelp business URL of the account.""" yelpUrl: String """YouTube channel URL of the account.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """ Validation checks to skip or add when saving records; pass a list and the selected values combine. """ enum ValidationLevel { """No validation is skipped; this is the default when the list is empty.""" FULL """ On update, validates only the fields whose values change in the request. """ SKIP_UNCHANGED_FIELDS """ Skips validation rules configured on the record type's form, such as fields marked as required, and step checklist requirements. """ SKIP_USER_DEFINED_VALIDATIONS """ Allows setting fields that are normally read-only, except fields that are always system-managed. """ SKIP_READONLY_VALIDATION """ Skips checks on related records, such as rejecting links to deleted records; ids of records that do not exist are still rejected. """ SKIP_RELATIONSHIP_VALIDATION """ Skips checks on field values (required, empty, minimum/maximum and format); the value type is still checked. """ SKIP_FIELD_VALUE_VALIDATION """ Saves the record even when a calculated field fails to evaluate or yields an empty value for a required field. """ SKIP_INVALID_RECALCULATIONS """ Allows moving a lead, opportunity or quote forward past steps whose required checklist items are not completed. """ SKIP_STEP_CHECKLIST_VALIDATION """ Also enforces conditional required-field and visibility rules defined on the form; slower, so it is off by default. """ INCLUDE_CONDITIONAL_FIELD_REQUIREMENTS """ Skips the check that values of unique fields are not already used by another record. """ SKIP_UNIQUE_VALIDATION """Calculated fields are not recalculated when the record is saved.""" SKIP_RECALCULATION """ Combines all SKIP_* values except SKIP_UNIQUE_VALIDATION and SKIP_RECALCULATION; ids of records that do not exist are still rejected. """ SKIP_ALL } """Result of the updateAccount mutation.""" type UpdateAccountPayload { """The updated record.""" account: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkUpdateAccount mutation.""" type BulkUpdateAccountPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Outcome of a bulk update: the created, updated and deleted records, and the failed items. """ type BulkUpdateResults { """Records created, each with its position in input.""" created: [BulkUpdateResultMap]! """Items of input that failed, with their position and error.""" errors: [BulkErrorResult]! """Ids of the updated records.""" updated: [UUID]! """Ids of the deleted records.""" deleted: [UUID]! """Items of deleteInput that failed, with their position and error.""" errorsOnDelete: [BulkErrorResult]! } """A record created by a bulk operation.""" type BulkUpdateResultMap { """Position of the item in input, starting at 0.""" index: Int! """Id of the created record.""" id: ID! } """ Field values of an Account record to create, or to update when its id is set. """ input CreateOrUpdateAccountInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture or company logo associated with the account.""" picture: CreateCloudObjectInput """ Manual classification grade assigned to the account. Used in segmentation and reporting. """ accountClass: AccountClassEnum """Id of the account type assigned to this account.""" accountTypeId: ID """Street address of the account.""" address: String """City of the account address.""" city: String """Free-form notes describing the account.""" comments: String """Country of the account address.""" country: String """Id of the currency exchange rate list applied to this account.""" currencyExchangeRatesListId: ID """ Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. """ customerTypeId: ID """ Primary email address of the account. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """ Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. """ homePage: String """Id of the industry classification.""" industryId: ID """ True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ Time when an AI-suggested account hierarchy was last applied to this account. """ lastAiAccountHierarchyApplied: DateTime """Time when an AI-suggested org chart was last applied to this account.""" lastAiOrgChartApplied: DateTime """Name of the entity and its default text representation.""" name: String """Id of the account owner.""" ownerId: ID """ Id of the parent account in the corporate hierarchy. Empty for top-level accounts. """ parentAccountId: ID """Id of the parent-account relationship type.""" parentAccountRelationTypeId: ID """ Primary phone number of the account. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """ Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. """ quickParentAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the account address.""" stateProvince: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the account address.""" zipCode: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Social network profiles linked to this account (e.g. LinkedIn, Facebook). """ socialMedia: UpdateAccountSocialRelationNoIdBackrefInput """ Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!] """ Users that have been granted shared access to this account. Editable only when shareMode allows user sharing. """ sharingClients: [CreateAccountSharingClientRelationNoAccountBackrefInput!] """Documents linked to this account.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this account.""" tags: [CreateTagRelationNoAccountBackrefInput!] """Saved view profiles this account currently matches.""" staticProfiles: [CreateProfileRelationNoAccountBackrefInput!] } """Id of the Account record to delete.""" input DeleteAccountInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """How a bulk operation handles items that fail.""" enum RollbackMethod { """Any failed item fails the whole request; nothing is saved.""" ROLLBACK_ALL """ Failed items are skipped and reported in errors; the other items are saved. """ ROLLBACK_FAILED } """How items without an id are matched to existing records.""" input MatchingInput { """ Api names of the fields whose values identify an existing record; each input item must contain all of them. """ identityKey: [String!]! """ Api name of a field holding an external id; with identityKey, a record matching either one is used. """ thirdPartyKey: String """What to do when more than one existing record matches.""" onMultiMatch: MultiMatchEnum! } """ What a bulkUpdate upsert does when more than one existing record matches the matching key. """ enum MultiMatchEnum { """Updates only the oldest matching record, by creation time.""" UpdateOldest """Updates only the newest matching record, by creation time.""" UpdateNewest """ Updates every matching record; the request fails when more than 100 records match. """ UpdateAll """ Fails the item when more than one record matches; a single match is updated. """ RaiseError """ Returns the matching records without changing them; no record is created when nothing matches. """ OnlyReturn """ Returns the matching records without changing them; a new record is created when nothing matches. """ SkipUpdate """ Updates only the newest matching record and ignores input fields with null, empty or zero values. """ UpdateNewestIgnoreEmpty } """Result of the deleteAccount mutation.""" type DeleteAccountPayload { """The deleted record.""" account: AccountEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkArchiveAccount mutation.""" type BulkArchiveAccountPayload { """Ids of the archived accounts and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkArchiveAccount mutation.""" input BulkArchiveAccountInput { """ Accounts to archive: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """Field values saved on every archived account.""" entity: CreateOrUpdateAccountInput! """Completes all unfinished projects of each account.""" completeAllRelatedProjects: Boolean = false """Archives open leads whose primary account is one of the accounts.""" archiveAllRelatedLeads: Boolean = false """ Archives open opportunities whose primary account is one of the accounts. """ archiveAllRelatedOpportunities: Boolean = false """Archives open quotes whose primary account is one of the accounts.""" archiveAllRelatedQuotes: Boolean = false """Archives contacts whose primary account is one of the accounts.""" archiveAllRelatedContacts: Boolean = false """Marks all tasks linked to each account as completed.""" completeAllRelatedTasks: Boolean = false """Marks tasks of the accounts' primary contacts as completed.""" completeAllRelatedContactsTasks: Boolean = false """Marks tasks of the accounts' leads as completed.""" completeAllRelatedLeadsTasks: Boolean = false """Marks tasks of the accounts' opportunities as completed.""" completeAllRelatedOpportunitiesTasks: Boolean = false """Marks tasks of the accounts' quotes as completed.""" completeAllRelatedQuotesTasks: Boolean = false """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkReactivateAccount mutation.""" type BulkReactivateAccountPayload { """Ids of the reactivated records and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkReactivateAccount mutation.""" input BulkReactivateAccountInput { """ Records to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the convertAccount mutation.""" type ConvertAccountPayload { """The created record.""" account: AccountEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ What happens to the source record after it is converted into a new record. """ enum RecordConversionOperationEnum { """The source record is kept unchanged.""" Nothing """ The source record is archived; options decide which related records are archived or completed too. """ Archive """ The source record's activities, documents and notes move to the new record, then the source is deleted. """ Delete } """ Related records of the source that are archived or completed together with it when a record is converted with the Archive operation. """ input RecordConversionOptions { """For an account source, archives contacts whose primary account is it.""" archiveAllRelatedContacts: Boolean """Not applicable: has no effect.""" archiveAllRelatedAccounts: Boolean """ For an account or contact source, archives open leads whose primary account or contact is it. """ archiveAllRelatedLeads: Boolean """ For an account or contact source, archives open opportunities whose primary account or contact is it; for a quote source, archives its open opportunity. """ archiveAllRelatedOpportunities: Boolean """ For an account or contact source, archives open quotes whose primary account or contact is it; for an opportunity source, archives its open quotes. """ archiveAllRelatedQuotes: Boolean """For an account source, completes its unfinished projects.""" completeAllRelatedProjects: Boolean """Marks all tasks linked to the source record as completed.""" completeAllRelatedTasks: Boolean } """Result of the createAccountKpi mutation.""" type CreateAccountKPIPayload { """The created record.""" accountKpi: AccountKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountKPI record.""" input CreateAccountKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account this KPI event relates to.""" accountId: ID! """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: AccountKpiEnum! """Id of the account owner at the time of the event.""" ownerId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountKpi mutation.""" type UpdateAccountKPIPayload { """The updated record.""" accountKpi: AccountKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AccountKPI record and the field values to change.""" input UpdateAccountKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account this KPI event relates to.""" accountId: ID """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: AccountKpiEnum """Id of the account owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountKpi mutation.""" type BulkUpdateAccountKPIPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountKPI record to create, or to update when its id is set. """ input CreateOrUpdateAccountKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account this KPI event relates to.""" accountId: ID """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: AccountKpiEnum """Id of the account owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountKPI record to delete.""" input DeleteAccountKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountKpi mutation.""" type DeleteAccountKPIPayload { """The deleted record.""" accountKpi: AccountKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountProductPricing mutation.""" type CreateAccountProductPricingPayload { """The created record.""" accountProductPricing: AccountProductPricingEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountProductPricing record.""" input CreateAccountProductPricingInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the price override applies to.""" accountId: ID! """Id of the currency the override price is expressed in.""" currencyId: ID! """ Price applied for this product when sold to this account, in the specified currency. """ price: Float """Id of the product whose price is overridden for the account.""" productId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountProductPricing mutation.""" type UpdateAccountProductPricingPayload { """The updated record.""" accountProductPricing: AccountProductPricingEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AccountProductPricing record and the field values to change.""" input UpdateAccountProductPricingInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the price override applies to.""" accountId: ID """Id of the currency the override price is expressed in.""" currencyId: ID """ Price applied for this product when sold to this account, in the specified currency. """ price: Float """Id of the product whose price is overridden for the account.""" productId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountProductPricing mutation.""" type BulkUpdateAccountProductPricingPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountProductPricing record to create, or to update when its id is set. """ input CreateOrUpdateAccountProductPricingInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the price override applies to.""" accountId: ID """Id of the currency the override price is expressed in.""" currencyId: ID """ Price applied for this product when sold to this account, in the specified currency. """ price: Float """Id of the product whose price is overridden for the account.""" productId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountProductPricing record to delete.""" input DeleteAccountProductPricingInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountProductPricing mutation.""" type DeleteAccountProductPricingPayload { """The deleted record.""" accountProductPricing: AccountProductPricingEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountRelation mutation.""" type CreateAccountRelationPayload { """The created record.""" accountRelation: AccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountRelation record.""" input CreateAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the first related account.""" account1Id: ID! """Id of the second related account.""" account2Id: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountRelation mutation.""" type UpdateAccountRelationPayload { """The updated record.""" accountRelation: AccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AccountRelation record and the field values to change.""" input UpdateAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the first related account.""" account1Id: ID """Id of the second related account.""" account2Id: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountRelation mutation.""" type BulkUpdateAccountRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountRelation record to create, or to update when its id is set. """ input CreateOrUpdateAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the first related account.""" account1Id: ID """Id of the second related account.""" account2Id: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountRelation record to delete.""" input DeleteAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountRelation mutation.""" type DeleteAccountRelationPayload { """The deleted record.""" accountRelation: AccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountRelationLabel mutation.""" type CreateAccountRelationLabelPayload { """The created record.""" accountRelationLabel: AccountRelationLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountRelationLabel record.""" input CreateAccountRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account relationship being labelled.""" accountRelation: CreateAccountRelationInput! """Id of the account relationship.""" accountRelationId: ID! """Id of the relationship type.""" accountRelationTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountRelationLabel mutation.""" type UpdateAccountRelationLabelPayload { """The updated record.""" accountRelationLabel: AccountRelationLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AccountRelationLabel record and the field values to change.""" input UpdateAccountRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account relationship being labelled.""" accountRelation: CreateAccountRelationInput """Id of the account relationship.""" accountRelationId: ID """Id of the relationship type.""" accountRelationTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountRelationLabel mutation.""" type BulkUpdateAccountRelationLabelPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountRelationLabel record to create, or to update when its id is set. """ input CreateOrUpdateAccountRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Account relationship being labelled.""" accountRelation: CreateAccountRelationInput """Id of the account relationship.""" accountRelationId: ID """Id of the relationship type.""" accountRelationTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountRelationLabel record to delete.""" input DeleteAccountRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountRelationLabel mutation.""" type DeleteAccountRelationLabelPayload { """The deleted record.""" accountRelationLabel: AccountRelationLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountRelationType mutation.""" type CreateAccountRelationTypePayload { """The created record.""" accountRelationType: AccountRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountRelationType record.""" input CreateAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """ Display label of the account-to-account relationship type (e.g. Partner, Supplier). """ label: String """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountRelationType mutation.""" type UpdateAccountRelationTypePayload { """The updated record.""" accountRelationType: AccountRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AccountRelationType record and the field values to change.""" input UpdateAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """ Display label of the account-to-account relationship type (e.g. Partner, Supplier). """ label: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountRelationType mutation.""" type BulkUpdateAccountRelationTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountRelationType record to create, or to update when its id is set. """ input CreateOrUpdateAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """ Display label of the account-to-account relationship type (e.g. Partner, Supplier). """ label: String """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountRelationType record to delete.""" input DeleteAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountRelationType mutation.""" type DeleteAccountRelationTypePayload { """The deleted record.""" accountRelationType: AccountRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountRole mutation.""" type CreateAccountRolePayload { """The created record.""" accountRole: AccountRoleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountRole record.""" input CreateAccountRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """Name of the entity and its default text representation.""" label: String! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountRole mutation.""" type UpdateAccountRolePayload { """The updated record.""" accountRole: AccountRoleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AccountRole record and the field values to change.""" input UpdateAccountRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" label: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountRole mutation.""" type BulkUpdateAccountRolePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountRole record to create, or to update when its id is set. """ input CreateOrUpdateAccountRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" label: String """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountRole record to delete.""" input DeleteAccountRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountRole mutation.""" type DeleteAccountRolePayload { """The deleted record.""" accountRole: AccountRoleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountSharingClientRelation mutation.""" type CreateAccountSharingClientRelationPayload { """The created record.""" accountSharingClientRelation: AccountSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountSharingClientRelation record.""" input CreateAccountSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared account.""" accountId: ID! """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountSharingClientRelation mutation.""" type UpdateAccountSharingClientRelationPayload { """The updated record.""" accountSharingClientRelation: AccountSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an AccountSharingClientRelation record and the field values to change. """ input UpdateAccountSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared account.""" accountId: ID """Id of the user.""" clientId: ID """ Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountSharingClientRelation mutation.""" type BulkUpdateAccountSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateAccountSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared account.""" accountId: ID """Id of the user.""" clientId: ID """ Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountSharingClientRelation record to delete.""" input DeleteAccountSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountSharingClientRelation mutation.""" type DeleteAccountSharingClientRelationPayload { """The deleted record.""" accountSharingClientRelation: AccountSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountSharingSalesUnitRelation mutation.""" type CreateAccountSharingSalesUnitRelationPayload { """The created record.""" accountSharingSalesUnitRelation: AccountSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountSharingSalesUnitRelation record.""" input CreateAccountSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared account.""" accountId: ID! """ Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountSharingSalesUnitRelation mutation.""" type UpdateAccountSharingSalesUnitRelationPayload { """The updated record.""" accountSharingSalesUnitRelation: AccountSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an AccountSharingSalesUnitRelation record and the field values to change. """ input UpdateAccountSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared account.""" accountId: ID """ Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountSharingSalesUnitRelation mutation.""" type BulkUpdateAccountSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateAccountSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared account.""" accountId: ID """ Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountSharingSalesUnitRelation record to delete.""" input DeleteAccountSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAccountSharingSalesUnitRelation mutation.""" type DeleteAccountSharingSalesUnitRelationPayload { """The deleted record.""" accountSharingSalesUnitRelation: AccountSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAccountSocialRelation mutation.""" type CreateAccountSocialRelationPayload { """The created record.""" accountSocialRelation: AccountSocialRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AccountSocialRelation record.""" input CreateAccountSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Account id.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the account.""" angellistUrl: String """Crunchbase profile URL of the account.""" crunchbaseUrl: String """Disqus profile URL of the account.""" disqusUrl: String """Facebook page or profile id of the account.""" facebookId: String """Facebook profile URL of the account.""" facebookUrl: String """Flickr profile URL of the account.""" flickrUrl: String """Foursquare profile URL of the account.""" foursquareUrl: String """Google business or profile id of the account.""" googleId: String """Google+ profile URL of the account.""" googlePlusUrl: String """Gravatar profile URL of the account.""" gravatarUrl: String """Klout profile URL of the account.""" kloutUrl: String """LinkedIn company or profile id of the account.""" linkedinId: String """LinkedIn profile URL of the account.""" linkedinUrl: String """Pinterest profile URL of the account.""" pinterestUrl: String """Quora profile URL of the account.""" quoraUrl: String """Reddit profile URL of the account.""" redditUrl: String """Skype contact URL or username of the account.""" skypeUrl: String """SlideShare profile URL of the account.""" slideshareUrl: String """Twitter (X) user id of the account.""" twitterId: String """Twitter (X) profile URL of the account.""" twitterUrl: String """Vimeo profile URL of the account.""" vimeoUrl: String """WordPress site URL of the account.""" wordpressUrl: String """XING profile URL of the account.""" xingUrl: String """Yahoo profile URL of the account.""" yahooUrl: String """Yelp business URL of the account.""" yelpUrl: String """YouTube channel URL of the account.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAccountSocialRelation mutation.""" type UpdateAccountSocialRelationPayload { """The updated record.""" accountSocialRelation: AccountSocialRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AccountSocialRelation record and the field values to change.""" input UpdateAccountSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Account id.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the account.""" angellistUrl: String """Crunchbase profile URL of the account.""" crunchbaseUrl: String """Disqus profile URL of the account.""" disqusUrl: String """Facebook page or profile id of the account.""" facebookId: String """Facebook profile URL of the account.""" facebookUrl: String """Flickr profile URL of the account.""" flickrUrl: String """Foursquare profile URL of the account.""" foursquareUrl: String """Google business or profile id of the account.""" googleId: String """Google+ profile URL of the account.""" googlePlusUrl: String """Gravatar profile URL of the account.""" gravatarUrl: String """Klout profile URL of the account.""" kloutUrl: String """LinkedIn company or profile id of the account.""" linkedinId: String """LinkedIn profile URL of the account.""" linkedinUrl: String """Pinterest profile URL of the account.""" pinterestUrl: String """Quora profile URL of the account.""" quoraUrl: String """Reddit profile URL of the account.""" redditUrl: String """Skype contact URL or username of the account.""" skypeUrl: String """SlideShare profile URL of the account.""" slideshareUrl: String """Twitter (X) user id of the account.""" twitterId: String """Twitter (X) profile URL of the account.""" twitterUrl: String """Vimeo profile URL of the account.""" vimeoUrl: String """WordPress site URL of the account.""" wordpressUrl: String """XING profile URL of the account.""" xingUrl: String """Yahoo profile URL of the account.""" yahooUrl: String """Yelp business URL of the account.""" yelpUrl: String """YouTube channel URL of the account.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAccountSocialRelation mutation.""" type BulkUpdateAccountSocialRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AccountSocialRelation record to create, or to update when its id is set. """ input CreateOrUpdateAccountSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Account id.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the account.""" angellistUrl: String """Crunchbase profile URL of the account.""" crunchbaseUrl: String """Disqus profile URL of the account.""" disqusUrl: String """Facebook page or profile id of the account.""" facebookId: String """Facebook profile URL of the account.""" facebookUrl: String """Flickr profile URL of the account.""" flickrUrl: String """Foursquare profile URL of the account.""" foursquareUrl: String """Google business or profile id of the account.""" googleId: String """Google+ profile URL of the account.""" googlePlusUrl: String """Gravatar profile URL of the account.""" gravatarUrl: String """Klout profile URL of the account.""" kloutUrl: String """LinkedIn company or profile id of the account.""" linkedinId: String """LinkedIn profile URL of the account.""" linkedinUrl: String """Pinterest profile URL of the account.""" pinterestUrl: String """Quora profile URL of the account.""" quoraUrl: String """Reddit profile URL of the account.""" redditUrl: String """Skype contact URL or username of the account.""" skypeUrl: String """SlideShare profile URL of the account.""" slideshareUrl: String """Twitter (X) user id of the account.""" twitterId: String """Twitter (X) profile URL of the account.""" twitterUrl: String """Vimeo profile URL of the account.""" vimeoUrl: String """WordPress site URL of the account.""" wordpressUrl: String """XING profile URL of the account.""" xingUrl: String """Yahoo profile URL of the account.""" yahooUrl: String """Yelp business URL of the account.""" yelpUrl: String """YouTube channel URL of the account.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """Id of the AccountSocialRelation record to delete.""" input DeleteAccountSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Account id.""" id: ID! } """Result of the deleteAccountSocialRelation mutation.""" type DeleteAccountSocialRelationPayload { """The deleted record.""" accountSocialRelation: AccountSocialRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createActivityComment mutation.""" type CreateActivityCommentPayload { """The created record.""" activityComment: ActivityCommentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ActivityComment record.""" input CreateActivityCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment or task the comment belongs to.""" activityId: ID! """Free-form text body of the comment.""" comment: String! """Id of the comment author.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateActivityComment mutation.""" type UpdateActivityCommentPayload { """The updated record.""" activityComment: ActivityCommentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an ActivityComment record and the field values to change.""" input UpdateActivityCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment or task the comment belongs to.""" activityId: ID """Free-form text body of the comment.""" comment: String """Id of the comment author.""" ownerId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateActivityComment mutation.""" type BulkUpdateActivityCommentPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an ActivityComment record to create, or to update when its id is set. """ input CreateOrUpdateActivityCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment or task the comment belongs to.""" activityId: ID """Free-form text body of the comment.""" comment: String """Id of the comment author.""" ownerId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ActivityComment record to delete.""" input DeleteActivityCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the appointment or task the comment belongs to.""" activityId: ID } """Result of the deleteActivityComment mutation.""" type DeleteActivityCommentPayload { """The deleted record.""" activityComment: ActivityCommentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createActivityKpi mutation.""" type CreateActivityKPIPayload { """The created record.""" activityKpi: ActivityKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ActivityKPI record.""" input CreateActivityKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment or task the KPI event relates to.""" activityId: ID! """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified. """ kpi: ActivityKpiEnum! """Id of the activity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateActivityKpi mutation.""" type UpdateActivityKPIPayload { """The updated record.""" activityKpi: ActivityKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an ActivityKPI record and the field values to change.""" input UpdateActivityKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment or task the KPI event relates to.""" activityId: ID """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified. """ kpi: ActivityKpiEnum """Id of the activity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateActivityKpi mutation.""" type BulkUpdateActivityKPIPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an ActivityKPI record to create, or to update when its id is set. """ input CreateOrUpdateActivityKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment or task the KPI event relates to.""" activityId: ID """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified. """ kpi: ActivityKpiEnum """Id of the activity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ActivityKPI record to delete.""" input DeleteActivityKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the appointment or task the KPI event relates to.""" activityId: ID } """Result of the deleteActivityKpi mutation.""" type DeleteActivityKPIPayload { """The deleted record.""" activityKpi: ActivityKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createActivityRelation mutation.""" type CreateActivityRelationPayload { """The created record.""" activityRelation: ActivityRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ActivityRelation record.""" input CreateActivityRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Project objective the activity advances, or empty.""" projectObjective: CreateProjectObjectiveInput """Id of the linked account.""" accountId: ID """Id of the appointment or task on this link.""" activityId: ID! """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project.""" projectId: ID """ Id of the project objective the activity advances, or empty when it is not linked to one. """ projectObjectiveId: ID """Id of the linked quote.""" quoteId: ID """ Display order of the activity within its project objective. Required only when projectId is set. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """Field values of a new ProjectObjective record.""" input CreateProjectObjectiveInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """ Id of the project this objective belongs to. Set on create; cannot be changed afterwards. """ projectId: ID! """ Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. """ sortOrder: Int! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateActivityRelation mutation.""" type UpdateActivityRelationPayload { """The updated record.""" activityRelation: ActivityRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an ActivityRelation record and the field values to change.""" input UpdateActivityRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Project objective the activity advances, or empty.""" projectObjective: CreateProjectObjectiveInput """Id of the linked account.""" accountId: ID """Id of the appointment or task on this link.""" activityId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project.""" projectId: ID """ Id of the project objective the activity advances, or empty when it is not linked to one. """ projectObjectiveId: ID """Id of the linked quote.""" quoteId: ID """ Display order of the activity within its project objective. Required only when projectId is set. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateActivityRelation mutation.""" type BulkUpdateActivityRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an ActivityRelation record to create, or to update when its id is set. """ input CreateOrUpdateActivityRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Project objective the activity advances, or empty.""" projectObjective: CreateProjectObjectiveInput """Id of the linked account.""" accountId: ID """Id of the appointment or task on this link.""" activityId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project.""" projectId: ID """ Id of the project objective the activity advances, or empty when it is not linked to one. """ projectObjectiveId: ID """Id of the linked quote.""" quoteId: ID """ Display order of the activity within its project objective. Required only when projectId is set. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """Id of the ActivityRelation record to delete.""" input DeleteActivityRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the appointment or task on this link.""" activityId: ID """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: ID } """Result of the deleteActivityRelation mutation.""" type DeleteActivityRelationPayload { """The deleted record.""" activityRelation: ActivityRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedAccountType mutation.""" type CreateAllowedAccountTypePayload { """The created record.""" allowedAccountType: AllowedAccountTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedAccountType record.""" input CreateAllowedAccountTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account type the user role can use.""" accountTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedAccountType mutation.""" type UpdateAllowedAccountTypePayload { """The updated record.""" allowedAccountType: AllowedAccountTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedAccountType record and the field values to change.""" input UpdateAllowedAccountTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account type the user role can use.""" accountTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedAccountType mutation.""" type BulkUpdateAllowedAccountTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedAccountType record to create, or to update when its id is set. """ input CreateOrUpdateAllowedAccountTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account type the user role can use.""" accountTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedAccountType record to delete.""" input DeleteAllowedAccountTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedAccountType mutation.""" type DeleteAllowedAccountTypePayload { """The deleted record.""" allowedAccountType: AllowedAccountTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedAppointmentType mutation.""" type CreateAllowedAppointmentTypePayload { """The created record.""" allowedAppointmentType: AllowedAppointmentTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedAppointmentType record.""" input CreateAllowedAppointmentTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment type the user role can use.""" appointmentTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedAppointmentType mutation.""" type UpdateAllowedAppointmentTypePayload { """The updated record.""" allowedAppointmentType: AllowedAppointmentTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedAppointmentType record and the field values to change.""" input UpdateAllowedAppointmentTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment type the user role can use.""" appointmentTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedAppointmentType mutation.""" type BulkUpdateAllowedAppointmentTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedAppointmentType record to create, or to update when its id is set. """ input CreateOrUpdateAllowedAppointmentTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment type the user role can use.""" appointmentTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedAppointmentType record to delete.""" input DeleteAllowedAppointmentTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedAppointmentType mutation.""" type DeleteAllowedAppointmentTypePayload { """The deleted record.""" allowedAppointmentType: AllowedAppointmentTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedCompanyEmail mutation.""" type CreateAllowedCompanyEmailPayload { """The created record.""" allowedCompanyEmail: AllowedCompanyEmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedCompanyEmail record.""" input CreateAllowedCompanyEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the company email address.""" companyEmailId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedCompanyEmail mutation.""" type UpdateAllowedCompanyEmailPayload { """The updated record.""" allowedCompanyEmail: AllowedCompanyEmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedCompanyEmail record and the field values to change.""" input UpdateAllowedCompanyEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the company email address.""" companyEmailId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedCompanyEmail mutation.""" type BulkUpdateAllowedCompanyEmailPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedCompanyEmail record to create, or to update when its id is set. """ input CreateOrUpdateAllowedCompanyEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the company email address.""" companyEmailId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedCompanyEmail record to delete.""" input DeleteAllowedCompanyEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedCompanyEmail mutation.""" type DeleteAllowedCompanyEmailPayload { """The deleted record.""" allowedCompanyEmail: AllowedCompanyEmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedCompanyPhone mutation.""" type CreateAllowedCompanyPhonePayload { """The created record.""" allowedCompanyPhone: AllowedCompanyPhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedCompanyPhone record.""" input CreateAllowedCompanyPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID! """Id of the company phone.""" phoneId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedCompanyPhone mutation.""" type UpdateAllowedCompanyPhonePayload { """The updated record.""" allowedCompanyPhone: AllowedCompanyPhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedCompanyPhone record and the field values to change.""" input UpdateAllowedCompanyPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID """Id of the company phone.""" phoneId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedCompanyPhone mutation.""" type BulkUpdateAllowedCompanyPhonePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedCompanyPhone record to create, or to update when its id is set. """ input CreateOrUpdateAllowedCompanyPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID """Id of the company phone.""" phoneId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedCompanyPhone record to delete.""" input DeleteAllowedCompanyPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedCompanyPhone mutation.""" type DeleteAllowedCompanyPhonePayload { """The deleted record.""" allowedCompanyPhone: AllowedCompanyPhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedContactType mutation.""" type CreateAllowedContactTypePayload { """The created record.""" allowedContactType: AllowedContactTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedContactType record.""" input CreateAllowedContactTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact type the user role can use.""" contactTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedContactType mutation.""" type UpdateAllowedContactTypePayload { """The updated record.""" allowedContactType: AllowedContactTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedContactType record and the field values to change.""" input UpdateAllowedContactTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact type the user role can use.""" contactTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedContactType mutation.""" type BulkUpdateAllowedContactTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedContactType record to create, or to update when its id is set. """ input CreateOrUpdateAllowedContactTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact type the user role can use.""" contactTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedContactType record to delete.""" input DeleteAllowedContactTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedContactType mutation.""" type DeleteAllowedContactTypePayload { """The deleted record.""" allowedContactType: AllowedContactTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedLeadType mutation.""" type CreateAllowedLeadTypePayload { """The created record.""" allowedLeadType: AllowedLeadTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedLeadType record.""" input CreateAllowedLeadTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the lead type the user role can use.""" leadTypeId: ID! """Id of the user role.""" masterRightId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedLeadType mutation.""" type UpdateAllowedLeadTypePayload { """The updated record.""" allowedLeadType: AllowedLeadTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedLeadType record and the field values to change.""" input UpdateAllowedLeadTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the lead type the user role can use.""" leadTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedLeadType mutation.""" type BulkUpdateAllowedLeadTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedLeadType record to create, or to update when its id is set. """ input CreateOrUpdateAllowedLeadTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the lead type the user role can use.""" leadTypeId: ID """Id of the user role.""" masterRightId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedLeadType record to delete.""" input DeleteAllowedLeadTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedLeadType mutation.""" type DeleteAllowedLeadTypePayload { """The deleted record.""" allowedLeadType: AllowedLeadTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedPipeline mutation.""" type CreateAllowedPipelinePayload { """The created record.""" allowedPipeline: AllowedPipelineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedPipeline record.""" input CreateAllowedPipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the user role can access documents attached to steps of this pipeline. """ accessStepDocuments: Boolean """Id of the user role.""" masterRightId: ID! """Id of the pipeline the user role can use.""" pipelineId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedPipeline mutation.""" type UpdateAllowedPipelinePayload { """The updated record.""" allowedPipeline: AllowedPipelineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedPipeline record and the field values to change.""" input UpdateAllowedPipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the user role can access documents attached to steps of this pipeline. """ accessStepDocuments: Boolean """Id of the user role.""" masterRightId: ID """Id of the pipeline the user role can use.""" pipelineId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedPipeline mutation.""" type BulkUpdateAllowedPipelinePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedPipeline record to create, or to update when its id is set. """ input CreateOrUpdateAllowedPipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the user role can access documents attached to steps of this pipeline. """ accessStepDocuments: Boolean """Id of the user role.""" masterRightId: ID """Id of the pipeline the user role can use.""" pipelineId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedPipeline record to delete.""" input DeleteAllowedPipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedPipeline mutation.""" type DeleteAllowedPipelinePayload { """The deleted record.""" allowedPipeline: AllowedPipelineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedQuoteType mutation.""" type CreateAllowedQuoteTypePayload { """The created record.""" allowedQuoteType: AllowedQuoteTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedQuoteType record.""" input CreateAllowedQuoteTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID! """Id of the quote type the user role can use.""" quoteTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedQuoteType mutation.""" type UpdateAllowedQuoteTypePayload { """The updated record.""" allowedQuoteType: AllowedQuoteTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedQuoteType record and the field values to change.""" input UpdateAllowedQuoteTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID """Id of the quote type the user role can use.""" quoteTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedQuoteType mutation.""" type BulkUpdateAllowedQuoteTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedQuoteType record to create, or to update when its id is set. """ input CreateOrUpdateAllowedQuoteTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID """Id of the quote type the user role can use.""" quoteTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedQuoteType record to delete.""" input DeleteAllowedQuoteTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedQuoteType mutation.""" type DeleteAllowedQuoteTypePayload { """The deleted record.""" allowedQuoteType: AllowedQuoteTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAllowedTaskType mutation.""" type CreateAllowedTaskTypePayload { """The created record.""" allowedTaskType: AllowedTaskTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AllowedTaskType record.""" input CreateAllowedTaskTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID! """Id of the task type the user role can use.""" taskTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAllowedTaskType mutation.""" type UpdateAllowedTaskTypePayload { """The updated record.""" allowedTaskType: AllowedTaskTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AllowedTaskType record and the field values to change.""" input UpdateAllowedTaskTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID """Id of the task type the user role can use.""" taskTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAllowedTaskType mutation.""" type BulkUpdateAllowedTaskTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AllowedTaskType record to create, or to update when its id is set. """ input CreateOrUpdateAllowedTaskTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user role.""" masterRightId: ID """Id of the task type the user role can use.""" taskTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the AllowedTaskType record to delete.""" input DeleteAllowedTaskTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAllowedTaskType mutation.""" type DeleteAllowedTaskTypePayload { """The deleted record.""" allowedTaskType: AllowedTaskTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyApiAccess mutation.""" type CopyApiAccessPayload { """The new API access.""" result: ApiAccessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyApiAccess mutation.""" input CopyApiAccessInput { """Identifier of the ApiAccessEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipAppointment mutation.""" type ChangeOwnershipAppointmentPayload { """The appointment with its new owner.""" result: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipAppointment mutation.""" input ChangeOwnershipAppointmentInput { """User who becomes the new owner of the appointment.""" ownerId: ID! """Sales unit the appointment is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) is added to the invited users with no response yet, unless already invited. """ keepOwnerAsAttendee: Boolean! """Identifier of the AppointmentEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the restoreAppointment mutation.""" type RestoreAppointmentPayload { """The restored record.""" result: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreAppointment mutation.""" input RestoreAppointmentInput { """Identifier of the AppointmentEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the respondToAppointmentInvitation mutation.""" type RespondToAppointmentInvitationPayload { """The appointment with the updated response.""" result: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the respondToAppointmentInvitation mutation.""" input RespondToAppointmentInvitationInput { """ The response: Accepted, Rejected, or NoResponse to clear an earlier answer. """ response: InviteeResponseEnum! """Identifier of the AppointmentEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the setReminderAppointment mutation.""" type SetReminderAppointmentPayload { """The appointment with the updated reminder.""" result: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the setReminderAppointment mutation.""" input SetReminderAppointmentInput { """ How long before the appointment start the reminder fires, in seconds. When a first reminder is created without an offset and without the Scheduled status, the user's default appointment reminder is used. """ endDateOffset: Int """ State of the reminder: Scheduled, Snoozed or Dismissed. Omit to keep the current state. """ status: ReminderStatusEnum """When a snoozed reminder fires again; used with the Snoozed status.""" snoozeDate: DateTime """Identifier of the AppointmentEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the removeReminderAppointment mutation.""" type RemoveReminderAppointmentPayload { """The appointment with the dismissed reminder.""" result: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the removeReminderAppointment mutation.""" input RemoveReminderAppointmentInput { """Identifier of the AppointmentEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAppointment mutation.""" type CreateAppointmentPayload { """The created record.""" appointment: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Appointment record.""" input CreateAppointmentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment type.""" activityTypeId: ID """Id of the currency exchange rate list applied to this appointment.""" currencyExchangeRatesListId: ID """Free-form description of the appointment.""" description: String """Duration of the appointment, derived from start/end dates.""" duration: Float """End timestamp of the appointment.""" endDate: DateTime! """ True when invitees are allowed to edit the appointment. Defaults to false. """ inviteesCanEdit: Boolean """ True when the recurrence series is still generating new occurrences. Read-only. """ isRecurrenceActive: Boolean """ True when this occurrence has been modified independently of the recurring series. Read-only. """ isRecurrenceException: Boolean """Free-text physical location of the appointment.""" location: String """ Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached. """ meetingUrl: AppointmentMeetingInput """ Original date of this occurrence in the recurring series. Set automatically. """ occurenceDate: DateTime """ Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails. """ organizer: String """Id of the appointment owner.""" ownerId: ID! """Id of the master appointment.""" recurrenceMasterId: ID """ iCalendar RRULE string describing the recurrence pattern (e.g. "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments. """ recurrenceRule: String """IANA timezone the recurrence rule is evaluated in.""" recurrenceTzid: String """Id of the appointment schedule.""" scheduleId: ID """ IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to evaluate availability against the schedule. """ scheduleTzid: String """Start timestamp of the appointment.""" startDate: DateTime """Short summary line shown in calendars and lists.""" subject: String! """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Accounts this appointment is linked to.""" accountRelations: [CreateActivityRelationNoActivityBackrefInput!] """Contacts this appointment is linked to.""" contactRelations: [CreateActivityRelationNoActivityBackrefInput!] """Leads this appointment is linked to.""" leadRelations: [CreateActivityRelationNoActivityBackrefInput!] """Opportunities this appointment is linked to.""" opportunityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ Projects this appointment is linked to, including the per-objective ordering. """ projectRelations: [CreateActivityRelationNoActivityBackrefInput!] """Quotes this appointment is linked to.""" quoteRelations: [CreateActivityRelationNoActivityBackrefInput!] """Custom entity records this appointment is linked to.""" customEntityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record. """ inviteesContacts: [CreateAppointmentContactInviteesRelationNoAppointmentBackrefInput!] """Internal-user invitees on this appointment.""" inviteesClients: [CreateAppointmentClientInviteesRelationNoAppointmentBackrefInput!] """ Reminder set by the current authenticated user for this appointment. Per-user; empty when no reminder has been set. """ reminder: CreateAppointmentReminderNoAppointmentBackrefInput """Documents linked to this appointment.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this appointment.""" comments: [CreateActivityCommentNoActivityBackrefInput!] """Tag labels applied to this appointment.""" tags: [CreateTagRelationNoAppointmentBackrefInput!] } """ Online meeting to link to an appointment: an existing meeting, or the service in which a new one is created. """ input AppointmentMeetingInput { """ Join URL of an existing online meeting. Leave empty to have a new meeting created with the selected service; when that fails, no meeting is attached. """ joinUrl: String """Online meeting service: Microsoft Teams (MsTeams) or Zoom.""" type: AppointmentMeetingTypeEnum! } """ Field values of a new ActivityRelation record, created together with the record it belongs to. """ input CreateActivityRelationNoActivityBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Project objective the activity advances, or empty.""" projectObjective: CreateProjectObjectiveInput """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the activity is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project.""" projectId: ID """ Id of the project objective the activity advances, or empty when it is not linked to one. """ projectObjectiveId: ID """Id of the linked quote.""" quoteId: ID """ Display order of the activity within its project objective. Required only when projectId is set. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AppointmentContactInviteesRelation record, created together with the record it belongs to. """ input CreateAppointmentContactInviteesRelationNoAppointmentBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the matched contact.""" contactId: ID """ Email address of the invitee. Required and used as the natural key for the link. """ email: String! """Given name of the invitee, when supplied.""" firstName: String """ How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled). """ inviteeType: AppointmentInviteeTypeEnum """Family name of the invitee, when supplied.""" lastName: String """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AppointmentClientInviteesRelation record, created together with the record it belongs to. """ input CreateAppointmentClientInviteesRelationNoAppointmentBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AppointmentReminder record, created together with the record it belongs to. """ input CreateAppointmentReminderNoAppointmentBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Seconds before the appointment start when the reminder should fire.""" endDateOffset: Int! """Id of the user who set the reminder.""" ownerId: ID! """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ActivityComment record, created together with the record it belongs to. """ input CreateActivityCommentNoActivityBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form text body of the comment.""" comment: String! """Id of the comment author.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoAppointmentBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAppointment mutation.""" type UpdateAppointmentPayload { """The updated record.""" appointment: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an Appointment record and the field values to change.""" input UpdateAppointmentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment type.""" activityTypeId: ID """Id of the currency exchange rate list applied to this appointment.""" currencyExchangeRatesListId: ID """Free-form description of the appointment.""" description: String """Duration of the appointment, derived from start/end dates.""" duration: Float """End timestamp of the appointment.""" endDate: DateTime """ True when invitees are allowed to edit the appointment. Defaults to false. """ inviteesCanEdit: Boolean """ True when the recurrence series is still generating new occurrences. Read-only. """ isRecurrenceActive: Boolean """ True when this occurrence has been modified independently of the recurring series. Read-only. """ isRecurrenceException: Boolean """Free-text physical location of the appointment.""" location: String """ Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached. """ meetingUrl: AppointmentMeetingInput """ Original date of this occurrence in the recurring series. Set automatically. """ occurenceDate: DateTime """ Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails. """ organizer: String """Id of the appointment owner.""" ownerId: ID """Id of the master appointment.""" recurrenceMasterId: ID """ iCalendar RRULE string describing the recurrence pattern (e.g. "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments. """ recurrenceRule: String """IANA timezone the recurrence rule is evaluated in.""" recurrenceTzid: String """Id of the appointment schedule.""" scheduleId: ID """ IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to evaluate availability against the schedule. """ scheduleTzid: String """Start timestamp of the appointment.""" startDate: DateTime """Short summary line shown in calendars and lists.""" subject: String """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Accounts this appointment is linked to.""" accountRelations: [CreateActivityRelationNoActivityBackrefInput!] """Contacts this appointment is linked to.""" contactRelations: [CreateActivityRelationNoActivityBackrefInput!] """Leads this appointment is linked to.""" leadRelations: [CreateActivityRelationNoActivityBackrefInput!] """Opportunities this appointment is linked to.""" opportunityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ Projects this appointment is linked to, including the per-objective ordering. """ projectRelations: [CreateActivityRelationNoActivityBackrefInput!] """Quotes this appointment is linked to.""" quoteRelations: [CreateActivityRelationNoActivityBackrefInput!] """Custom entity records this appointment is linked to.""" customEntityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record. """ inviteesContacts: [CreateAppointmentContactInviteesRelationNoAppointmentBackrefInput!] """Internal-user invitees on this appointment.""" inviteesClients: [CreateAppointmentClientInviteesRelationNoAppointmentBackrefInput!] """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """Documents linked to this appointment.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this appointment.""" comments: [CreateActivityCommentNoActivityBackrefInput!] """Tag labels applied to this appointment.""" tags: [CreateTagRelationNoAppointmentBackrefInput!] } """Result of the bulkUpdateAppointment mutation.""" type BulkUpdateAppointmentPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an Appointment record to create, or to update when its id is set. """ input CreateOrUpdateAppointmentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment type.""" activityTypeId: ID """Id of the currency exchange rate list applied to this appointment.""" currencyExchangeRatesListId: ID """Free-form description of the appointment.""" description: String """Duration of the appointment, derived from start/end dates.""" duration: Float """End timestamp of the appointment.""" endDate: DateTime """ True when invitees are allowed to edit the appointment. Defaults to false. """ inviteesCanEdit: Boolean """ True when the recurrence series is still generating new occurrences. Read-only. """ isRecurrenceActive: Boolean """ True when this occurrence has been modified independently of the recurring series. Read-only. """ isRecurrenceException: Boolean """Free-text physical location of the appointment.""" location: String """ Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached. """ meetingUrl: AppointmentMeetingInput """ Original date of this occurrence in the recurring series. Set automatically. """ occurenceDate: DateTime """ Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails. """ organizer: String """Id of the appointment owner.""" ownerId: ID """Id of the master appointment.""" recurrenceMasterId: ID """ iCalendar RRULE string describing the recurrence pattern (e.g. "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments. """ recurrenceRule: String """IANA timezone the recurrence rule is evaluated in.""" recurrenceTzid: String """Id of the appointment schedule.""" scheduleId: ID """ IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to evaluate availability against the schedule. """ scheduleTzid: String """Start timestamp of the appointment.""" startDate: DateTime """Short summary line shown in calendars and lists.""" subject: String """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Accounts this appointment is linked to.""" accountRelations: [CreateActivityRelationNoActivityBackrefInput!] """Contacts this appointment is linked to.""" contactRelations: [CreateActivityRelationNoActivityBackrefInput!] """Leads this appointment is linked to.""" leadRelations: [CreateActivityRelationNoActivityBackrefInput!] """Opportunities this appointment is linked to.""" opportunityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ Projects this appointment is linked to, including the per-objective ordering. """ projectRelations: [CreateActivityRelationNoActivityBackrefInput!] """Quotes this appointment is linked to.""" quoteRelations: [CreateActivityRelationNoActivityBackrefInput!] """Custom entity records this appointment is linked to.""" customEntityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record. """ inviteesContacts: [CreateAppointmentContactInviteesRelationNoAppointmentBackrefInput!] """Internal-user invitees on this appointment.""" inviteesClients: [CreateAppointmentClientInviteesRelationNoAppointmentBackrefInput!] """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ Reminder set by the current authenticated user for this appointment. Per-user; empty when no reminder has been set. """ reminder: UpdateAppointmentReminderNoAppointmentBackrefInput """Documents linked to this appointment.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this appointment.""" comments: [CreateActivityCommentNoActivityBackrefInput!] """Tag labels applied to this appointment.""" tags: [CreateTagRelationNoAppointmentBackrefInput!] } """ Id of an AppointmentReminder record and the field values to change, updated together with the record it belongs to. """ input UpdateAppointmentReminderNoAppointmentBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Seconds before the appointment start when the reminder should fire.""" endDateOffset: Int """Id of the user who set the reminder.""" ownerId: ID """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the deleteAppointment mutation.""" type DeleteAppointmentPayload { """The deleted record.""" appointment: AppointmentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of the Appointment record to delete.""" input DeleteAppointmentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the convertAppointment mutation.""" type ConvertAppointmentPayload { """The created record.""" appointment: AppointmentEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAppointmentClientInviteesRelation mutation.""" type CreateAppointmentClientInviteesRelationPayload { """The created record.""" appointmentClientInviteesRelation: AppointmentClientInviteesRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AppointmentClientInviteesRelation record.""" input CreateAppointmentClientInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment the user has been invited to.""" appointmentId: ID! """Id of the user.""" clientId: ID! """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAppointmentClientInviteesRelation mutation.""" type UpdateAppointmentClientInviteesRelationPayload { """The updated record.""" appointmentClientInviteesRelation: AppointmentClientInviteesRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an AppointmentClientInviteesRelation record and the field values to change. """ input UpdateAppointmentClientInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment the user has been invited to.""" appointmentId: ID """Id of the user.""" clientId: ID """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAppointmentClientInviteesRelation mutation.""" type BulkUpdateAppointmentClientInviteesRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AppointmentClientInviteesRelation record to create, or to update when its id is set. """ input CreateOrUpdateAppointmentClientInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment the user has been invited to.""" appointmentId: ID """Id of the user.""" clientId: ID """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the AppointmentClientInviteesRelation record to delete.""" input DeleteAppointmentClientInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAppointmentClientInviteesRelation mutation.""" type DeleteAppointmentClientInviteesRelationPayload { """The deleted record.""" appointmentClientInviteesRelation: AppointmentClientInviteesRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAppointmentContactInviteesRelation mutation.""" type CreateAppointmentContactInviteesRelationPayload { """The created record.""" appointmentContactInviteesRelation: AppointmentContactInviteesRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AppointmentContactInviteesRelation record.""" input CreateAppointmentContactInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment the contact has been invited to.""" appointmentId: ID! """Id of the matched contact.""" contactId: ID """ Email address of the invitee. Required and used as the natural key for the link. """ email: String! """Given name of the invitee, when supplied.""" firstName: String """ How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled). """ inviteeType: AppointmentInviteeTypeEnum """Family name of the invitee, when supplied.""" lastName: String """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAppointmentContactInviteesRelation mutation.""" type UpdateAppointmentContactInviteesRelationPayload { """The updated record.""" appointmentContactInviteesRelation: AppointmentContactInviteesRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an AppointmentContactInviteesRelation record and the field values to change. """ input UpdateAppointmentContactInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment the contact has been invited to.""" appointmentId: ID """Id of the matched contact.""" contactId: ID """ Email address of the invitee. Required and used as the natural key for the link. """ email: String """Given name of the invitee, when supplied.""" firstName: String """ How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled). """ inviteeType: AppointmentInviteeTypeEnum """Family name of the invitee, when supplied.""" lastName: String """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAppointmentContactInviteesRelation mutation.""" type BulkUpdateAppointmentContactInviteesRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AppointmentContactInviteesRelation record to create, or to update when its id is set. """ input CreateOrUpdateAppointmentContactInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment the contact has been invited to.""" appointmentId: ID """Id of the matched contact.""" contactId: ID """ Email address of the invitee. Required and used as the natural key for the link. """ email: String """Given name of the invitee, when supplied.""" firstName: String """ How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled). """ inviteeType: AppointmentInviteeTypeEnum """Family name of the invitee, when supplied.""" lastName: String """ Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. """ response: InviteeResponseEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the AppointmentContactInviteesRelation record to delete.""" input DeleteAppointmentContactInviteesRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAppointmentContactInviteesRelation mutation.""" type DeleteAppointmentContactInviteesRelationPayload { """The deleted record.""" appointmentContactInviteesRelation: AppointmentContactInviteesRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAppointmentReminder mutation.""" type CreateAppointmentReminderPayload { """The created record.""" appointmentReminder: AppointmentReminderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AppointmentReminder record.""" input CreateAppointmentReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment this reminder belongs to.""" appointmentId: ID! """Seconds before the appointment start when the reminder should fire.""" endDateOffset: Int! """Id of the user who set the reminder.""" ownerId: ID! """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateAppointmentReminder mutation.""" type UpdateAppointmentReminderPayload { """The updated record.""" appointmentReminder: AppointmentReminderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AppointmentReminder record and the field values to change.""" input UpdateAppointmentReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment this reminder belongs to.""" appointmentId: ID """Seconds before the appointment start when the reminder should fire.""" endDateOffset: Int """Id of the user who set the reminder.""" ownerId: ID """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateAppointmentReminder mutation.""" type BulkUpdateAppointmentReminderPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AppointmentReminder record to create, or to update when its id is set. """ input CreateOrUpdateAppointmentReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment this reminder belongs to.""" appointmentId: ID """Seconds before the appointment start when the reminder should fire.""" endDateOffset: Int """Id of the user who set the reminder.""" ownerId: ID """ Timestamp when a snoozed reminder should fire again. Empty when not snoozed. """ snoozeDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the AppointmentReminder record to delete.""" input DeleteAppointmentReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAppointmentReminder mutation.""" type DeleteAppointmentReminderPayload { """The deleted record.""" appointmentReminder: AppointmentReminderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createAppointmentSchedule mutation.""" type CreateAppointmentSchedulePayload { """The created record.""" appointmentSchedule: AppointmentScheduleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new AppointmentSchedule record.""" input CreateAppointmentScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Description applied to appointments booked through this schedule.""" appointmentDescription: String! """Duration of each booked appointment.""" appointmentDuration: Float """Location applied to appointments booked through this schedule.""" appointmentLocation: String! """ Where booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. """ appointmentLocationType: AppointmentScheduleLocationTypeEnum """Id of the user receiving the booking.""" appointmentOwnerId: ID! """Subject applied to appointments booked through this schedule.""" appointmentSubject: String! """ When true, booked appointments use the scheduleName as their subject instead of appointmentSubject. """ appointmentSubjectUsesScheduleName: Boolean! """ Id of the appointment type used for appointments booked through the schedule. """ appointmentTypeId: ID! """ IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined. """ availabilityTzid: String """ Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeAfter: Int! """ Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeBefore: Int! """ What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). """ confirmationPageType: AppointmentScheduleConfirmationPageTypeEnum """ Custom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect. """ confirmationPageUrl: String """ Master switch for the schedule. Disabled schedules do not accept new bookings. """ isEnabled: Boolean! """ Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). """ minimumNoticeTime: Int! """ Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name. """ name: String! """Id of the schedule owner.""" ownerId: ID! """ With Offset planning, how many days ahead the schedule remains bookable. """ planningDayOffset: Int! """With Period planning, first date bookings are accepted for.""" planningPeriodFrom: Date """With Period planning, last date bookings are accepted for.""" planningPeriodTo: Date """ Time window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period). """ planningType: AppointmentSchedulePlanningTypeEnum """ True when a reminder email is sent to invitees ahead of the booked appointment. """ reminderEmailEnabled: Boolean! """ Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType. """ reminderEmailOffset: Int! """Time unit of reminderEmailOffset: Minute, Hour, Day or Week.""" reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum """ Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmailId: ID """ Public-facing name of the schedule, shown to bookers on the booking page. """ scheduleName: String! """ Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). """ timeIncrement: Int! """ Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. """ type: AppointmentScheduleTypeEnum """Public URL slug of the schedule, used to share the booking page.""" url: String! """ Custom fields the booker is asked to fill in on the booking page, in display order. """ additionalFieldsData: [AppointmentScheduleAdditionalFieldParams!]! """ Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone. """ availabilityData: AppointmentScheduleAvailabilityParams! """ Default invitees added to appointments booked through this schedule (Coevera users or external email addresses). """ appointmentInviteesData: [AppointmentScheduleInviteeParams!]! } """ Appointment field the booker fills in on the booking page of an appointment schedule. """ input AppointmentScheduleAdditionalFieldParams { """ Id of the appointment field the booker fills in; the value is saved on the booked appointment. """ fieldId: ID! """Label of the field on the booking page.""" label: String! """True when the booker must fill in the field.""" isRequired: Boolean! } """ Weekly availability of an appointment schedule: the time windows in which appointments can be booked on each weekday. """ input AppointmentScheduleAvailabilityParams { """Availability on Mondays.""" monday: AppointmentScheduleDayAvailabilityParams! """Availability on Tuesdays.""" tuesday: AppointmentScheduleDayAvailabilityParams! """Availability on Wednesdays.""" wednesday: AppointmentScheduleDayAvailabilityParams! """Availability on Thursdays.""" thursday: AppointmentScheduleDayAvailabilityParams! """Availability on Fridays.""" friday: AppointmentScheduleDayAvailabilityParams! """Availability on Saturdays.""" saturday: AppointmentScheduleDayAvailabilityParams! """Availability on Sundays.""" sunday: AppointmentScheduleDayAvailabilityParams! } """Availability of an appointment schedule on one weekday.""" input AppointmentScheduleDayAvailabilityParams { """ True when bookings can be made on this weekday; when false, the slots are ignored. """ isEnabled: Boolean! """ Time windows of the day in which bookings can be made; overlapping windows are merged. """ slots: [AppointmentScheduleAvailabilitySlotParams!]! } """Time window of a day in which appointments can be booked.""" input AppointmentScheduleAvailabilitySlotParams { """ Start of the time window, in seconds after midnight (e.g. 32400 for 09:00) in the availabilityTzid timezone of the schedule. """ start: Int! """ End of the time window, in seconds after midnight. A booked appointment, including its buffer times, must fit inside one window. """ end: Int! } """ Default invitee of an appointment schedule: a Coevera user, a contact or an external email address. """ input AppointmentScheduleInviteeParams { """ Kind of invitee: a Coevera user (Client), a contact (Contact) or an external email address (Email). Only Client invitees are added to booked appointments. """ type: AppointmentScheduleInviteeType! """Email address of the invitee.""" email: String! """Id of the user or contact; empty for an Email invitee.""" entityId: ID } """Result of the updateAppointmentSchedule mutation.""" type UpdateAppointmentSchedulePayload { """The updated record.""" appointmentSchedule: AppointmentScheduleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an AppointmentSchedule record and the field values to change.""" input UpdateAppointmentScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Description applied to appointments booked through this schedule.""" appointmentDescription: String """Duration of each booked appointment.""" appointmentDuration: Float """Location applied to appointments booked through this schedule.""" appointmentLocation: String """ Where booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. """ appointmentLocationType: AppointmentScheduleLocationTypeEnum """Id of the user receiving the booking.""" appointmentOwnerId: ID """Subject applied to appointments booked through this schedule.""" appointmentSubject: String """ When true, booked appointments use the scheduleName as their subject instead of appointmentSubject. """ appointmentSubjectUsesScheduleName: Boolean """ Id of the appointment type used for appointments booked through the schedule. """ appointmentTypeId: ID """ IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined. """ availabilityTzid: String """ Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeAfter: Int """ Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeBefore: Int """ What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). """ confirmationPageType: AppointmentScheduleConfirmationPageTypeEnum """ Custom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect. """ confirmationPageUrl: String """ Master switch for the schedule. Disabled schedules do not accept new bookings. """ isEnabled: Boolean """ Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). """ minimumNoticeTime: Int """ Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name. """ name: String """Id of the schedule owner.""" ownerId: ID """ With Offset planning, how many days ahead the schedule remains bookable. """ planningDayOffset: Int """With Period planning, first date bookings are accepted for.""" planningPeriodFrom: Date """With Period planning, last date bookings are accepted for.""" planningPeriodTo: Date """ Time window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period). """ planningType: AppointmentSchedulePlanningTypeEnum """ True when a reminder email is sent to invitees ahead of the booked appointment. """ reminderEmailEnabled: Boolean """ Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType. """ reminderEmailOffset: Int """Time unit of reminderEmailOffset: Minute, Hour, Day or Week.""" reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum """ Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmailId: ID """ Public-facing name of the schedule, shown to bookers on the booking page. """ scheduleName: String """ Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). """ timeIncrement: Int """ Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. """ type: AppointmentScheduleTypeEnum """Public URL slug of the schedule, used to share the booking page.""" url: String """ Custom fields the booker is asked to fill in on the booking page, in display order. """ additionalFieldsData: [AppointmentScheduleAdditionalFieldParams!] """ Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone. """ availabilityData: AppointmentScheduleAvailabilityParams """ Default invitees added to appointments booked through this schedule (Coevera users or external email addresses). """ appointmentInviteesData: [AppointmentScheduleInviteeParams!] } """Result of the bulkUpdateAppointmentSchedule mutation.""" type BulkUpdateAppointmentSchedulePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an AppointmentSchedule record to create, or to update when its id is set. """ input CreateOrUpdateAppointmentScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Description applied to appointments booked through this schedule.""" appointmentDescription: String """Duration of each booked appointment.""" appointmentDuration: Float """Location applied to appointments booked through this schedule.""" appointmentLocation: String """ Where booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. """ appointmentLocationType: AppointmentScheduleLocationTypeEnum """Id of the user receiving the booking.""" appointmentOwnerId: ID """Subject applied to appointments booked through this schedule.""" appointmentSubject: String """ When true, booked appointments use the scheduleName as their subject instead of appointmentSubject. """ appointmentSubjectUsesScheduleName: Boolean """ Id of the appointment type used for appointments booked through the schedule. """ appointmentTypeId: ID """ IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined. """ availabilityTzid: String """ Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeAfter: Int """ Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). """ bufferTimeBefore: Int """ What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). """ confirmationPageType: AppointmentScheduleConfirmationPageTypeEnum """ Custom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect. """ confirmationPageUrl: String """ Master switch for the schedule. Disabled schedules do not accept new bookings. """ isEnabled: Boolean """ Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). """ minimumNoticeTime: Int """ Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name. """ name: String """Id of the schedule owner.""" ownerId: ID """ With Offset planning, how many days ahead the schedule remains bookable. """ planningDayOffset: Int """With Period planning, first date bookings are accepted for.""" planningPeriodFrom: Date """With Period planning, last date bookings are accepted for.""" planningPeriodTo: Date """ Time window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period). """ planningType: AppointmentSchedulePlanningTypeEnum """ True when a reminder email is sent to invitees ahead of the booked appointment. """ reminderEmailEnabled: Boolean """ Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType. """ reminderEmailOffset: Int """Time unit of reminderEmailOffset: Minute, Hour, Day or Week.""" reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum """ Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. """ replyCompanyEmailId: ID """ Public-facing name of the schedule, shown to bookers on the booking page. """ scheduleName: String """ Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). """ timeIncrement: Int """ Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. """ type: AppointmentScheduleTypeEnum """Public URL slug of the schedule, used to share the booking page.""" url: String """ Custom fields the booker is asked to fill in on the booking page, in display order. """ additionalFieldsData: [AppointmentScheduleAdditionalFieldParams!] """ Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone. """ availabilityData: AppointmentScheduleAvailabilityParams """ Default invitees added to appointments booked through this schedule (Coevera users or external email addresses). """ appointmentInviteesData: [AppointmentScheduleInviteeParams!] } """Id of the AppointmentSchedule record to delete.""" input DeleteAppointmentScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteAppointmentSchedule mutation.""" type DeleteAppointmentSchedulePayload { """The deleted record.""" appointmentSchedule: AppointmentScheduleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createApproval mutation.""" type CreateApprovalPayload { """The created record.""" approval: ApprovalEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Approval record.""" input CreateApprovalInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the triggering user.""" actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. """ applicationId: ID! """Id of the approval process this approval was raised from.""" approvalProcessId: ID! """ Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. """ approvalStatus: ApprovalStatusEnum """Comment the requester attached when raising the approval.""" comment: String """Id of the linked contact.""" contactId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked quote.""" quoteId: ID """ Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. """ status: ProcessStatusEnum """Revision when entity was lastly changed.""" revision: Int """ Users who must respond to the approval, with their individual responses. """ approvers: [CreateApprovalApproverNoApprovalBackrefInput!] } """ Field values of a new ApprovalApprover record, created together with the record it belongs to. """ input CreateApprovalApproverNoApprovalBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the assigned user.""" clientId: ID! """Comment the user attached when responding to the approval.""" comment: String """ Response of this approver to the approval request: Pending until the user approves or rejects it. """ status: ApprovalStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateApproval mutation.""" type UpdateApprovalPayload { """The updated record.""" approval: ApprovalEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an Approval record and the field values to change.""" input UpdateApprovalInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the triggering user.""" actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. """ applicationId: ID """Id of the approval process this approval was raised from.""" approvalProcessId: ID """ Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. """ approvalStatus: ApprovalStatusEnum """Comment the requester attached when raising the approval.""" comment: String """Id of the linked contact.""" contactId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked quote.""" quoteId: ID """ Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. """ status: ProcessStatusEnum """Revision when entity was lastly changed.""" revision: Int """ Users who must respond to the approval, with their individual responses. """ approvers: [CreateApprovalApproverNoApprovalBackrefInput!] } """Result of the bulkUpdateApproval mutation.""" type BulkUpdateApprovalPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an Approval record to create, or to update when its id is set. """ input CreateOrUpdateApprovalInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the triggering user.""" actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. """ applicationId: ID """Id of the approval process this approval was raised from.""" approvalProcessId: ID """ Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. """ approvalStatus: ApprovalStatusEnum """Comment the requester attached when raising the approval.""" comment: String """Id of the linked contact.""" contactId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked quote.""" quoteId: ID """ Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. """ status: ProcessStatusEnum """Revision when entity was lastly changed.""" revision: Int """ Users who must respond to the approval, with their individual responses. """ approvers: [CreateApprovalApproverNoApprovalBackrefInput!] } """Id of the Approval record to delete.""" input DeleteApprovalInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID } """Result of the deleteApproval mutation.""" type DeleteApprovalPayload { """The deleted record.""" approval: ApprovalEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createApprovalApprover mutation.""" type CreateApprovalApproverPayload { """The created record.""" approvalApprover: ApprovalApproverEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ApprovalApprover record.""" input CreateApprovalApproverInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the approval this approver is assigned to.""" approvalId: ID! """Id of the assigned user.""" clientId: ID! """Comment the user attached when responding to the approval.""" comment: String """ Response of this approver to the approval request: Pending until the user approves or rejects it. """ status: ApprovalStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateApprovalApprover mutation.""" type UpdateApprovalApproverPayload { """The updated record.""" approvalApprover: ApprovalApproverEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an ApprovalApprover record and the field values to change.""" input UpdateApprovalApproverInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the approval this approver is assigned to.""" approvalId: ID """Id of the assigned user.""" clientId: ID """Comment the user attached when responding to the approval.""" comment: String """ Response of this approver to the approval request: Pending until the user approves or rejects it. """ status: ApprovalStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateApprovalApprover mutation.""" type BulkUpdateApprovalApproverPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an ApprovalApprover record to create, or to update when its id is set. """ input CreateOrUpdateApprovalApproverInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the approval this approver is assigned to.""" approvalId: ID """Id of the assigned user.""" clientId: ID """Comment the user attached when responding to the approval.""" comment: String """ Response of this approver to the approval request: Pending until the user approves or rejects it. """ status: ApprovalStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the ApprovalApprover record to delete.""" input DeleteApprovalApproverInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteApprovalApprover mutation.""" type DeleteApprovalApproverPayload { """The deleted record.""" approvalApprover: ApprovalApproverEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createApprovalProcess mutation.""" type CreateApprovalProcessPayload { """The created record.""" approvalProcess: ApprovalProcessEntity } """Field values of a new ApprovalProcess record.""" input CreateApprovalProcessInput { """Name of the approval process.""" name: String! """Free-text description shown alongside the approval process.""" description: String """ Id of the user who owns the approval process. Defaults to the calling user. """ ownerId: UUID """ Approval process schema as a JSON object conforming to the ApprovalProcessSchema type: trigger, filter, approver settings and approve/reject nodes. Validated on write. The new approval process is created disabled. Full structure: https://developers.coevera.com/reference/graphql/types/a/#ApprovalProcessSchema """ settings: JSONString } """Result of the updateApprovalProcess mutation.""" type UpdateApprovalProcessPayload { """The updated record.""" approvalProcess: ApprovalProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an ApprovalProcess record and the field values to change.""" input UpdateApprovalProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown alongside the approval process.""" description: String """ When true, the approval process actively raises approvals on matching record events; when false, the process is paused. """ isEnabled: Boolean """Timestamp of the most recent change to settings.""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Approval process schema as a JSON object conforming to the ApprovalProcessSchema type — trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/a/#ApprovalProcessSchema This payload conforms to the `ApprovalProcessSchema` JSON Schema: GET /api/v100/rest/schemas/ApprovalProcessSchema.json on your region's API host """ settings: JSONString """Files attached to the approval process (e.g. process documentation).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateApprovalProcess mutation.""" type BulkUpdateApprovalProcessPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an ApprovalProcess record to create, or to update when its id is set. """ input CreateOrUpdateApprovalProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown alongside the approval process.""" description: String """ When true, the approval process actively raises approvals on matching record events; when false, the process is paused. """ isEnabled: Boolean """Timestamp of the most recent change to settings.""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Approval process schema as a JSON object conforming to the ApprovalProcessSchema type — trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/a/#ApprovalProcessSchema This payload conforms to the `ApprovalProcessSchema` JSON Schema: GET /api/v100/rest/schemas/ApprovalProcessSchema.json on your region's API host """ settings: JSONString """Files attached to the approval process (e.g. process documentation).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Id of the ApprovalProcess record to delete.""" input DeleteApprovalProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteApprovalProcess mutation.""" type DeleteApprovalProcessPayload { """The deleted record.""" approvalProcess: ApprovalProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createApprovalProcessActivityLogLine mutation.""" type CreateApprovalProcessActivityLogLinePayload { """The created record.""" approvalProcessActivityLogLine: ApprovalProcessActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ApprovalProcessActivityLogLine record.""" input CreateApprovalProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the approval this log line belongs to.""" approvalId: ID! """ Typed JSON payload describing the approval step (e.g. approver decisions, comments). """ data: JSONString! """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its approval run.""" sortOrder: Int! """ Result of the approval step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum } """Result of the updateApprovalProcessActivityLogLine mutation.""" type UpdateApprovalProcessActivityLogLinePayload { """The updated record.""" approvalProcessActivityLogLine: ApprovalProcessActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an ApprovalProcessActivityLogLine record and the field values to change. """ input UpdateApprovalProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the approval this log line belongs to.""" approvalId: ID """ Typed JSON payload describing the approval step (e.g. approver decisions, comments). """ data: JSONString """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its approval run.""" sortOrder: Int """ Result of the approval step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum } """Result of the bulkUpdateApprovalProcessActivityLogLine mutation.""" type BulkUpdateApprovalProcessActivityLogLinePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an ApprovalProcessActivityLogLine record to create, or to update when its id is set. """ input CreateOrUpdateApprovalProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the approval this log line belongs to.""" approvalId: ID """ Typed JSON payload describing the approval step (e.g. approver decisions, comments). """ data: JSONString """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its approval run.""" sortOrder: Int """ Result of the approval step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum } """Id of the ApprovalProcessActivityLogLine record to delete.""" input DeleteApprovalProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteApprovalProcessActivityLogLine mutation.""" type DeleteApprovalProcessActivityLogLinePayload { """The deleted record.""" approvalProcessActivityLogLine: ApprovalProcessActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCall mutation.""" type CreateCallPayload { """The created record.""" call: CallEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Call record.""" input CreateCallInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Specific opportunity line-item discussed on the call, when applicable.""" opptyProductRelation: CreateOpptyProductRelationInput """Id of the linked account.""" accountId: ID """Id of the calling user.""" callerId: ID! """Id of the user the call was made with.""" clientId: ID """Id of the linked contact.""" contactId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked opportunity product line-item.""" opptyProductRelationId: ID """External phone number called or received, in E.164 format.""" phoneNumber: String """Id of the linked product.""" productId: ID """External transcription identifier from the calling provider.""" transcriptionId: String """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US"). """ transcriptionLanguage: String """AI-generated summary of the call transcription.""" transcriptionSummary: String """ Id of the call-log record from the calling provider that this call is associated with. """ twilioCallLogId: ID! """ Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording. """ audioStatus: AudioStatus } """Field values of a new OpptyProductRelation record.""" input CreateOpptyProductRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. """ pairedOpptyProductRelation: CreateOpptyProductRelationInput """ Total amount of the line item (price * quantity, with discounts applied). """ amount: Float """Free-form note describing this line item.""" comment: String """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: ID """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: ID """ Id of the online form submission this line item came from, or empty when it was not created through a form. """ onlineFormId: ID """Id of the opportunity.""" opptyId: ID """Id of the line-item type.""" opptyProductRelationTypeId: ID """Id of the paired line item.""" pairedOpptyProductRelationId: ID """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: Float """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: ID! """Number of product units on this line item.""" quantity: Float """ Id of the quote this line item belongs to. Mutually exclusive with opptyId. """ quoteId: ID """ Identifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote). """ sectionId: ID """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. """ revenueSchedule: CreateOpptyProductRelationRevenueScheduleNoIdBackrefInput } """ Field values of a new OpptyProductRelationRevenueSchedule record, created together with the record it belongs to. """ input CreateOpptyProductRelationRevenueScheduleNoIdBackrefInput { """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: Date """Number of periods the line-item amount is split into.""" periodCount: Int """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnum """Date when revenue recognition for this product line begins.""" startDate: Date """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCall mutation.""" type UpdateCallPayload { """The updated record.""" call: CallEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Call record and the field values to change.""" input UpdateCallInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Specific opportunity line-item discussed on the call, when applicable.""" opptyProductRelation: CreateOpptyProductRelationInput """Id of the linked account.""" accountId: ID """Id of the calling user.""" callerId: ID """Id of the user the call was made with.""" clientId: ID """Id of the linked contact.""" contactId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked opportunity product line-item.""" opptyProductRelationId: ID """External phone number called or received, in E.164 format.""" phoneNumber: String """Id of the linked product.""" productId: ID """External transcription identifier from the calling provider.""" transcriptionId: String """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US"). """ transcriptionLanguage: String """AI-generated summary of the call transcription.""" transcriptionSummary: String """ Id of the call-log record from the calling provider that this call is associated with. """ twilioCallLogId: ID """ Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording. """ audioStatus: AudioStatus } """Result of the bulkUpdateCall mutation.""" type BulkUpdateCallPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Call record to create, or to update when its id is set. """ input CreateOrUpdateCallInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Specific opportunity line-item discussed on the call, when applicable.""" opptyProductRelation: CreateOpptyProductRelationInput """Id of the linked account.""" accountId: ID """Id of the calling user.""" callerId: ID """Id of the user the call was made with.""" clientId: ID """Id of the linked contact.""" contactId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked opportunity product line-item.""" opptyProductRelationId: ID """External phone number called or received, in E.164 format.""" phoneNumber: String """Id of the linked product.""" productId: ID """External transcription identifier from the calling provider.""" transcriptionId: String """ Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US"). """ transcriptionLanguage: String """AI-generated summary of the call transcription.""" transcriptionSummary: String """ Id of the call-log record from the calling provider that this call is associated with. """ twilioCallLogId: ID """ Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording. """ audioStatus: AudioStatus } """Id of the Call record to delete.""" input DeleteCallInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID } """Result of the deleteCall mutation.""" type DeleteCallPayload { """The deleted record.""" call: CallEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createChatConversation mutation.""" type CreateChatConversationPayload { """The created record.""" chatConversation: ChatConversationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ChatConversation record.""" input CreateChatConversationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the owning user.""" ownerId: ID! """ Kind of AI chat: a general conversation with the AI assistant, or one about a specific record identified by context. """ type: ChatConversationTypeEnum """Messages exchanged in the conversation, in chronological order.""" messages: [CreateTextMessageNoChatConversationBackrefInput!] } """ Field values of a new TextMessage record, created together with the record it belongs to. """ input CreateTextMessageNoChatConversationBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: String! """Timestamp the message was sent.""" datetimeSent: DateTime """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnum! """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: String """ Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. """ score: Int """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnum """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: ID """Revision when entity was lastly changed.""" revision: Int """Files attached to the message (e.g. MMS attachments).""" attachments: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the updateChatConversation mutation.""" type UpdateChatConversationPayload { """The updated record.""" chatConversation: ChatConversationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ChatConversation record and the field values to change.""" input UpdateChatConversationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the owning user.""" ownerId: ID """ Kind of AI chat: a general conversation with the AI assistant, or one about a specific record identified by context. """ type: ChatConversationTypeEnum """Messages exchanged in the conversation, in chronological order.""" messages: [CreateOrUpdateTextMessageNoChatConversationBackrefInput!] } """ Field values of a TextMessage record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateTextMessageNoChatConversationBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: String """Timestamp the message was sent.""" datetimeSent: DateTime """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnum """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: String """ Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. """ score: Int """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnum """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: ID """Revision when entity was lastly changed.""" revision: Int """Files attached to the message (e.g. MMS attachments).""" attachments: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateChatConversation mutation.""" type BulkUpdateChatConversationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ChatConversation record to create, or to update when its id is set. """ input CreateOrUpdateChatConversationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the owning user.""" ownerId: ID """ Kind of AI chat: a general conversation with the AI assistant, or one about a specific record identified by context. """ type: ChatConversationTypeEnum """Messages exchanged in the conversation, in chronological order.""" messages: [CreateOrUpdateTextMessageNoChatConversationBackrefInput!] } """Id of the ChatConversation record to delete.""" input DeleteChatConversationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteChatConversation mutation.""" type DeleteChatConversationPayload { """The deleted record.""" chatConversation: ChatConversationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createClient mutation.""" type CreateClientPayload { """The created record.""" client: ClientEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Client record.""" input CreateClientInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the default sales unit.""" defaultUnitId: ID! """Email. Readonly information from UserProfile.""" email: String! """First name. Readonly information from UserProfile.""" firstName: String """Timestamp of the user's most recent login or API request.""" lastActive: DateTime """Last name. Readonly information from UserProfile.""" lastName: String """Id of the assigned user role.""" masterRightId: ID! """Middle name. Readonly information from UserProfile.""" middleName: String """Phone number. Readonly information from UserProfile.""" phone: String """Job title or position of the user.""" position: String """Region. Readonly information from UserProfile.""" region: String """ Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead. """ timezone: String """ Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person. """ type: ClientTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales units the user belongs to (as member or manager).""" unitMembership: [CreateSalesUnitClientRelationNoClientBackrefInput!]! """Appointments marked as favorite by the user.""" appointmentFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Tasks marked as favorite by the user.""" taskFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Accounts marked as favorite by the user.""" accountFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Contacts marked as favorite by the user.""" contactFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Screen profiles marked as favorite by the user.""" profileFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Reports marked as favorite by the user.""" reportFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Leads marked as favorite by the user.""" leadFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Opportunities marked as favorite by the user.""" opportunityFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] } """ Field values of a new SalesUnitClientRelation record, created together with the record it belongs to. """ input CreateSalesUnitClientRelationNoClientBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales unit.""" unitId: ID! """ Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit. """ unitRole: UnitRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ClientFavorite record, created together with the record it belongs to. """ input CreateClientFavoriteNoOwnerBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the favorite account.""" accountId: ID """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: ID """Id of the favorite contact.""" contactId: ID """Id of the favorite custom entity record.""" customEntityId: ID """Id of the favorite email.""" emailId: ID """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the favorite screen profile.""" profileId: ID """Id of the favorite project.""" projectId: ID """Id of the favorite quote.""" quoteId: ID """Id of the favorite report.""" reportId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateClient mutation.""" type UpdateClientPayload { """The updated record.""" client: ClientEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Client record and the field values to change.""" input UpdateClientInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the default sales unit.""" defaultUnitId: ID """Id of the assigned user role.""" masterRightId: ID """Job title or position of the user.""" position: String """ Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person. """ type: ClientTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales units the user belongs to (as member or manager).""" unitMembership: [CreateSalesUnitClientRelationNoClientBackrefInput!] """Appointments marked as favorite by the user.""" appointmentFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Tasks marked as favorite by the user.""" taskFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Accounts marked as favorite by the user.""" accountFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Contacts marked as favorite by the user.""" contactFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Screen profiles marked as favorite by the user.""" profileFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Reports marked as favorite by the user.""" reportFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Leads marked as favorite by the user.""" leadFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Opportunities marked as favorite by the user.""" opportunityFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] } """Result of the bulkUpdateClient mutation.""" type BulkUpdateClientPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Client record to create, or to update when its id is set. """ input CreateOrUpdateClientInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the default sales unit.""" defaultUnitId: ID """Email. Readonly information from UserProfile.""" email: String """First name. Readonly information from UserProfile.""" firstName: String """Timestamp of the user's most recent login or API request.""" lastActive: DateTime """Last name. Readonly information from UserProfile.""" lastName: String """Id of the assigned user role.""" masterRightId: ID """Middle name. Readonly information from UserProfile.""" middleName: String """Phone number. Readonly information from UserProfile.""" phone: String """Job title or position of the user.""" position: String """Region. Readonly information from UserProfile.""" region: String """ Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead. """ timezone: String """ Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person. """ type: ClientTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales units the user belongs to (as member or manager).""" unitMembership: [CreateSalesUnitClientRelationNoClientBackrefInput!] """Appointments marked as favorite by the user.""" appointmentFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Tasks marked as favorite by the user.""" taskFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Accounts marked as favorite by the user.""" accountFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Contacts marked as favorite by the user.""" contactFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Screen profiles marked as favorite by the user.""" profileFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Reports marked as favorite by the user.""" reportFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Leads marked as favorite by the user.""" leadFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] """Opportunities marked as favorite by the user.""" opportunityFavorite: [CreateClientFavoriteNoOwnerBackrefInput!] } """Id of the Client record to delete.""" input DeleteClientInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteClient mutation.""" type DeleteClientPayload { """The deleted record.""" client: ClientEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createClientExcludedOppty mutation.""" type CreateClientExcludedOpptyPayload { """The created record.""" clientExcludedOppty: ClientExcludedOpptyEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ClientExcludedOppty record.""" input CreateClientExcludedOpptyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity. """ isExcluded: Boolean! """Id of the opportunity.""" opptyId: ID! """Id of the user.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateClientExcludedOppty mutation.""" type UpdateClientExcludedOpptyPayload { """The updated record.""" clientExcludedOppty: ClientExcludedOpptyEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ClientExcludedOppty record and the field values to change.""" input UpdateClientExcludedOpptyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity. """ isExcluded: Boolean """Id of the opportunity.""" opptyId: ID """Id of the user.""" ownerId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateClientExcludedOppty mutation.""" type BulkUpdateClientExcludedOpptyPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ClientExcludedOppty record to create, or to update when its id is set. """ input CreateOrUpdateClientExcludedOpptyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity. """ isExcluded: Boolean """Id of the opportunity.""" opptyId: ID """Id of the user.""" ownerId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ClientExcludedOppty record to delete.""" input DeleteClientExcludedOpptyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteClientExcludedOppty mutation.""" type DeleteClientExcludedOpptyPayload { """The deleted record.""" clientExcludedOppty: ClientExcludedOpptyEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createClientStoryRead mutation.""" type CreateClientStoryReadPayload { """The created record.""" clientStoryRead: ClientStoryReadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ClientStoryRead record.""" input CreateClientStoryReadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the read appointment or task, or empty when this read points to a message. """ activityId: ID """ Id of the read email or memo, or empty when this read points to an activity. """ messageId: ID """When true, the user explicitly chose not to follow up on this item.""" noFollow: Boolean """Id of the reading user.""" ownerId: ID! """Timestamp the user marked the item as read.""" readAt: DateTime! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateClientStoryRead mutation.""" type UpdateClientStoryReadPayload { """The updated record.""" clientStoryRead: ClientStoryReadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ClientStoryRead record and the field values to change.""" input UpdateClientStoryReadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the read appointment or task, or empty when this read points to a message. """ activityId: ID """ Id of the read email or memo, or empty when this read points to an activity. """ messageId: ID """When true, the user explicitly chose not to follow up on this item.""" noFollow: Boolean """Id of the reading user.""" ownerId: ID """Timestamp the user marked the item as read.""" readAt: DateTime """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateClientStoryRead mutation.""" type BulkUpdateClientStoryReadPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ClientStoryRead record to create, or to update when its id is set. """ input CreateOrUpdateClientStoryReadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the read appointment or task, or empty when this read points to a message. """ activityId: ID """ Id of the read email or memo, or empty when this read points to an activity. """ messageId: ID """When true, the user explicitly chose not to follow up on this item.""" noFollow: Boolean """Id of the reading user.""" ownerId: ID """Timestamp the user marked the item as read.""" readAt: DateTime """Revision when entity was lastly changed.""" revision: Int } """Id of the ClientStoryRead record to delete.""" input DeleteClientStoryReadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the read appointment or task, or empty when this read points to a message. """ activityId: ID """ Id of the read email or memo, or empty when this read points to an activity. """ messageId: ID } """Result of the deleteClientStoryRead mutation.""" type DeleteClientStoryReadPayload { """The deleted record.""" clientStoryRead: ClientStoryReadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCloudObject mutation.""" type CreateCloudObjectPayload { """The created record.""" cloudObject: CloudObjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateCloudObject mutation.""" type UpdateCloudObjectPayload { """The updated record.""" cloudObject: CloudObjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a CloudObject record and the field values to change.""" input UpdateCloudObjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """ Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. """ params: JSONString """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCloudObject mutation.""" type BulkUpdateCloudObjectPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CloudObject record to create, or to update when its id is set. """ input CreateOrUpdateCloudObjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """Mime-type of the cloud object Is detected from content.""" mimeType: String """ Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. """ params: JSONString """ Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. """ type: CloudObjectTypeEnum """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: String """Revision when entity was lastly changed.""" revision: Int """Data content of the object.""" content: Base64 } """Id of the CloudObject record to delete.""" input DeleteCloudObjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCloudObject mutation.""" type DeleteCloudObjectPayload { """The deleted record.""" cloudObject: CloudObjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createImageCloudObject mutation.""" type CreateImageCloudObjectPayload { """The created file.""" cloudObject: CloudObjectEntity } """Parameters of the createImageCloudObject mutation.""" input CreateImageInput { """File name of the image, including its extension.""" filename: String! """Image content, base64-encoded.""" content: String! """ Editor the image is embedded in (e-mail template or rich-text editor). Leave empty for an image that is not embedded. """ uploadSource: UploadSourceEnum } """Result of the cloudObjectMakePublic mutation.""" type CloudObjectMakePublicPayload { """Public URL of the file.""" result: String! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the cloudObjectMakePublic mutation.""" input CloudObjectMakePublicInput { """Id of the file to make public.""" entityId: UUID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCloudObjectFolder mutation.""" type CreateCloudObjectFolderPayload { """The created record.""" cloudObjectFolder: CloudObjectFolderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CloudObjectFolder record.""" input CreateCloudObjectFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. """ entityApiName: String """ Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only. """ entityType: BaseEntityTypeEnum """Name of the entity and its default text representation.""" name: String! """ Id of the online form template, or empty when not associated with a form. """ onlineFormTypeId: ID """Id of the parent folder, or empty for top-level folders.""" parentCloudObjectFolderId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCloudObjectFolder mutation.""" type UpdateCloudObjectFolderPayload { """The updated record.""" cloudObjectFolder: CloudObjectFolderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a CloudObjectFolder record and the field values to change.""" input UpdateCloudObjectFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. """ entityApiName: String """Name of the entity and its default text representation.""" name: String """ Id of the online form template, or empty when not associated with a form. """ onlineFormTypeId: ID """Id of the parent folder, or empty for top-level folders.""" parentCloudObjectFolderId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCloudObjectFolder mutation.""" type BulkUpdateCloudObjectFolderPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CloudObjectFolder record to create, or to update when its id is set. """ input CreateOrUpdateCloudObjectFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. """ entityApiName: String """ Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only. """ entityType: BaseEntityTypeEnum """Name of the entity and its default text representation.""" name: String """ Id of the online form template, or empty when not associated with a form. """ onlineFormTypeId: ID """Id of the parent folder, or empty for top-level folders.""" parentCloudObjectFolderId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the CloudObjectFolder record to delete.""" input DeleteCloudObjectFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCloudObjectFolder mutation.""" type DeleteCloudObjectFolderPayload { """ The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept. """ errors: Boolean! """ The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept. """ cloudObjectFolder: CloudObjectFolderEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCloudObjectRelation mutation.""" type CreateCloudObjectRelationPayload { """The created record.""" cloudObjectRelation: CloudObjectRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CloudObjectRelation record.""" input CreateCloudObjectRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Cloud object (file) being linked.""" cloudObject: CreateCloudObjectInput """Report schedule the file is attached to (e.g. an exported report).""" reportSchedule: CreateReportScheduleInput """Text message (SMS/MMS) the file is attached to.""" textMessage: CreateTextMessageInput """Id of the linked account.""" accountId: ID """Id of the linked appointment or task, or empty when not linked.""" activityId: ID """Id of the linked approval process.""" approvalProcessId: ID """Id of the linked call.""" callId: ID """ Id of the folder within the parent record, or empty when stored at the record root. """ cloudObjectFolderId: ID """Id of the linked file.""" cloudObjectId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email sequence.""" emailSequenceId: ID """Id of the linked email template.""" emailTemplateId: ID """Id of the linked field mapping.""" fieldMappingId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked media record.""" mediaId: ID """Id of the linked email or memo, or empty when not linked.""" messageId: ID """Id of the online form field the file was uploaded into.""" onlineFormFieldId: ID """Id of the linked online form submission.""" onlineFormId: ID """Id of the linked sales process.""" processId: ID """Id of the linked sales process template.""" processTemplateId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked report schedule.""" reportScheduleId: ID """Id of the linked text message.""" textMessageId: ID """Revision when entity was lastly changed.""" revision: Int } """Field values of a new ReportSchedule record.""" input CreateReportScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the owning user.""" ownerId: ID! """Id of the scheduled report.""" reportId: ID! """ Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document. This payload conforms to the `ReportScheduleSchema` JSON Schema: GET /api/v100/rest/schemas/ReportScheduleSchema.json on your region's API host """ settings: ReportScheduleSchemaJSONString! """Revision when entity was lastly changed.""" revision: Int """Files attached to scheduled emails sent for this report.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """ JSON object, sent as a string, conforming to the ReportScheduleSchema type. """ scalar ReportScheduleSchemaJSONString """Field values of a new TextMessage record.""" input CreateTextMessageInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: ID """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: String! """Timestamp the message was sent.""" datetimeSent: DateTime """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnum! """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: String """ Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. """ score: Int """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnum """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: ID """Revision when entity was lastly changed.""" revision: Int """Files attached to the message (e.g. MMS attachments).""" attachments: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the updateCloudObjectRelation mutation.""" type UpdateCloudObjectRelationPayload { """The updated record.""" cloudObjectRelation: CloudObjectRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a CloudObjectRelation record and the field values to change.""" input UpdateCloudObjectRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Cloud object (file) being linked.""" cloudObject: CreateCloudObjectInput """Report schedule the file is attached to (e.g. an exported report).""" reportSchedule: CreateReportScheduleInput """Text message (SMS/MMS) the file is attached to.""" textMessage: CreateTextMessageInput """Id of the linked account.""" accountId: ID """Id of the linked appointment or task, or empty when not linked.""" activityId: ID """Id of the linked approval process.""" approvalProcessId: ID """Id of the linked call.""" callId: ID """ Id of the folder within the parent record, or empty when stored at the record root. """ cloudObjectFolderId: ID """Id of the linked file.""" cloudObjectId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email sequence.""" emailSequenceId: ID """Id of the linked email template.""" emailTemplateId: ID """Id of the linked field mapping.""" fieldMappingId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked media record.""" mediaId: ID """Id of the linked email or memo, or empty when not linked.""" messageId: ID """Id of the online form field the file was uploaded into.""" onlineFormFieldId: ID """Id of the linked online form submission.""" onlineFormId: ID """Id of the linked sales process.""" processId: ID """Id of the linked sales process template.""" processTemplateId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked report schedule.""" reportScheduleId: ID """Id of the linked text message.""" textMessageId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCloudObjectRelation mutation.""" type BulkUpdateCloudObjectRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CloudObjectRelation record to create, or to update when its id is set. """ input CreateOrUpdateCloudObjectRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Cloud object (file) being linked.""" cloudObject: CreateCloudObjectInput """Report schedule the file is attached to (e.g. an exported report).""" reportSchedule: CreateReportScheduleInput """Text message (SMS/MMS) the file is attached to.""" textMessage: CreateTextMessageInput """Id of the linked account.""" accountId: ID """Id of the linked appointment or task, or empty when not linked.""" activityId: ID """Id of the linked approval process.""" approvalProcessId: ID """Id of the linked call.""" callId: ID """ Id of the folder within the parent record, or empty when stored at the record root. """ cloudObjectFolderId: ID """Id of the linked file.""" cloudObjectId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email sequence.""" emailSequenceId: ID """Id of the linked email template.""" emailTemplateId: ID """Id of the linked field mapping.""" fieldMappingId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked media record.""" mediaId: ID """Id of the linked email or memo, or empty when not linked.""" messageId: ID """Id of the online form field the file was uploaded into.""" onlineFormFieldId: ID """Id of the linked online form submission.""" onlineFormId: ID """Id of the linked sales process.""" processId: ID """Id of the linked sales process template.""" processTemplateId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked report schedule.""" reportScheduleId: ID """Id of the linked text message.""" textMessageId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the CloudObjectRelation record to delete.""" input DeleteCloudObjectRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the linked appointment or task, or empty when not linked.""" activityId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked email or memo, or empty when not linked.""" messageId: ID } """Result of the deleteCloudObjectRelation mutation.""" type DeleteCloudObjectRelationPayload { """The deleted record.""" cloudObjectRelation: CloudObjectRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateCloudObjectStepRelation mutation.""" type UpdateCloudObjectStepRelationPayload { """The updated record.""" cloudObjectStepRelation: CloudObjectStepRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a CloudObjectStepRelation record and the field values to change.""" input UpdateCloudObjectStepRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """File attached to the step.""" cloudObject: CreateCloudObjectInput """Id of the attached file.""" cloudObjectId: ID """Position of the file within the step's document list.""" sortOrder: Int """Id of the pipeline step.""" stepId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCloudObjectStepRelation mutation.""" type BulkUpdateCloudObjectStepRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CloudObjectStepRelation record to create, or to update when its id is set. """ input CreateOrUpdateCloudObjectStepRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """File attached to the step.""" cloudObject: CreateCloudObjectInput """Id of the attached file.""" cloudObjectId: ID """Position of the file within the step's document list.""" sortOrder: Int """Id of the pipeline step.""" stepId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the CloudObjectStepRelation record to delete.""" input DeleteCloudObjectStepRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCloudObjectStepRelation mutation.""" type DeleteCloudObjectStepRelationPayload { """The deleted record.""" cloudObjectStepRelation: CloudObjectStepRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCloudObjectTemplate mutation.""" type CreateCloudObjectTemplatePayload { """The created record.""" cloudObjectTemplate: CloudObjectTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CloudObjectTemplate record.""" input CreateCloudObjectTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String! """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """ Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. """ status: CloudObjectTemplateStatusEnum """ Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. """ templateEntityName: EntityNameEnum! """ Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. Set on create only. """ type: CloudObjectTypeEnum! """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: String """Revision when entity was lastly changed.""" revision: Int """Data content of the object.""" content: Base64 """ API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. """ templateEntityApiName: String } """Result of the updateCloudObjectTemplate mutation.""" type UpdateCloudObjectTemplatePayload { """The updated record.""" cloudObjectTemplate: CloudObjectTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a CloudObjectTemplate record and the field values to change.""" input UpdateCloudObjectTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """ Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. """ status: CloudObjectTemplateStatusEnum """ Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. """ templateEntityName: EntityNameEnum """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """Revision when entity was lastly changed.""" revision: Int """Data content of the object.""" content: Base64 """ API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. """ templateEntityApiName: String } """Result of the bulkUpdateCloudObjectTemplate mutation.""" type BulkUpdateCloudObjectTemplatePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CloudObjectTemplate record to create, or to update when its id is set. """ input CreateOrUpdateCloudObjectTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the producing application.""" applicationId: ID """ Id of the company folder, or empty when the object is not stored in the company tree. """ companyCloudObjectFolderId: ID """Id of the uploading user.""" creatorId: ID """File name (with extension) used when downloading the object.""" filename: String """When true, the object can be served via a public URL (see publicUrl).""" isPublic: Boolean """ Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. """ status: CloudObjectTemplateStatusEnum """ Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. """ templateEntityName: EntityNameEnum """ Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. Set on create only. """ type: CloudObjectTypeEnum """ Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. """ uploadSource: UploadSourceEnum """ URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. """ url: String """Revision when entity was lastly changed.""" revision: Int """Data content of the object.""" content: Base64 """ API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. """ templateEntityApiName: String } """Id of the CloudObjectTemplate record to delete.""" input DeleteCloudObjectTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCloudObjectTemplate mutation.""" type DeleteCloudObjectTemplatePayload { """The deleted record.""" cloudObjectTemplate: CloudObjectTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the moveCloudObjects mutation.""" type MoveCloudObjectsPayload { """True when all given files were moved.""" result: Boolean! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the moveCloudObjects mutation.""" input MoveCloudObjectsInput { """Files and folders to move.""" bulkFilter: BulkOperationInput! """ Target folder. Required for company documents; for record documents, leave empty to move the files to the record's root. """ folderId: UUID """ Id of the record whose documents are moved. Set together with entityType. """ entityId: UUID """ Type of the record whose documents are moved: Account, Contact, Lead, Opportunity, Task, Appointment, Project, Quote or CustomEntity. Set together with entityId. """ entityType: BaseEntityTypeEnum """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the deleteCloudObjects mutation.""" type DeleteCloudObjectsPayload { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the deleteCloudObjects mutation.""" input DeleteCloudObjectsInput { """Files and folders to delete.""" bulkFilter: BulkOperationInput! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the getBulkDownloadUrl mutation.""" type GetBulkDownloadUrlPayload { """ Id of the download request, or empty when the selection contains no downloadable files. """ result: String """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the getBulkDownloadUrl mutation.""" input GetBulkDownloadUrlInput { """Files and folders to download.""" bulkFilter: BulkOperationInput! """ Id of the record whose document folders are downloaded. Set together with entityType; not allowed for company folders. """ entityId: UUID """ Type of the record whose document folders are downloaded. Set together with entityId. """ entityType: EntityNameEnum """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the getBulkDownloadStatus mutation.""" type GetBulkDownloadStatusPayload { """ Progress in percent, the download URL when finished, and an error flag when packing failed or stalled. """ result: BulkDownloadStatus! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Progress of packing files into a ZIP archive for download, and its URL once it is ready. """ type BulkDownloadStatus { """Progress of packing the archive, in percent (0 to 100).""" progress: Int """Download URL of the ZIP archive, set once packing has finished.""" url: String """True when packing failed or stopped making progress.""" error: Boolean } """Parameters of the getBulkDownloadStatus mutation.""" input GetBulkDownloadStatusInput { """Id returned by getBulkDownloadUrl.""" requestId: UUID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipContact mutation.""" type ChangeOwnershipContactPayload { """The contact with its new owner.""" result: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipContact mutation.""" input ChangeOwnershipContactInput { """User who becomes the new owner of the contact.""" ownerId: ID! """Sales unit the contact is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the contact as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """ When true, the new owner and sales unit are also applied to the contact's open tasks and appointments, its notes and its open leads and opportunities. Linked records that cannot be transferred are skipped without failing the mutation. """ transferLinkedRecords: Boolean! """Identifier of the ContactEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingContact mutation.""" type ManageSharingContactPayload { """The record with its updated sharing.""" result: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingContact mutation.""" input ManageSharingContactInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateContactSharingClientRelationNoContactBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateContactSharingSalesUnitRelationNoContactBackrefInput!] """Identifier of the ContactEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new ContactSharingClientRelation record, created together with the record it belongs to. """ input CreateContactSharingClientRelationNoContactBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ContactSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateContactSharingSalesUnitRelationNoContactBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the restoreContact mutation.""" type RestoreContactPayload { """The restored record.""" result: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreContact mutation.""" input RestoreContactInput { """Identifier of the ContactEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyContact mutation.""" type CopyContactPayload { """The new contact.""" result: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyContact mutation.""" input CopyContactInput { """ When true, the copy keeps the original name without the copy suffix. Defaults to false. """ skipCopySuffix: Boolean """Identifier of the ContactEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the mergeContact mutation.""" type MergeContactPayload { """The merged master contact.""" result: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the mergeContact mutation.""" input MergeContactInput { """Id of the contact to keep and the field values it should end up with.""" master: UpdateContactInput! """ Id of the duplicate contact that is merged into the master and then deleted. """ slaveId: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Contact record and the field values to change.""" input UpdateContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture associated with the contact.""" picture: CreateCloudObjectInput """Street address of the contact.""" address: String """City of the contact address.""" city: String """Free-form notes describing the contact.""" comments: String """Id of the contact type assigned to this contact.""" contactTypeId: ID """Country of the contact address.""" country: String """Id of the currency exchange rate list applied to this contact.""" currencyExchangeRatesListId: ID """ Primary email address of the contact. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """Given name of the contact.""" firstName: String """ Gender of the contact: Unknown when not specified, Male, Female or NonBinary. """ gender: GenderEnum """ True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Family name of the contact.""" lastName: String """Middle name of the contact, if applicable.""" middleName: String """Id of the contact owner.""" ownerId: ID """ Primary phone number of the contact. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """Job title or position of the contact.""" position: String """ Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. """ quickAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the contact address.""" stateProvince: String """ Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. """ title: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the contact address.""" zipCode: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Social network profiles linked to this contact (e.g. LinkedIn, Facebook). """ socialMedia: UpdateContactSocialRelationNoIdBackrefInput """ Accounts this contact is linked to. Each link records the role and position the contact has at the related account. """ accountRelations: [CreateContactAccountRelationNoContactBackrefInput!] """ Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateContactSharingSalesUnitRelationNoContactBackrefInput!] """ Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing. """ sharingClients: [CreateContactSharingClientRelationNoContactBackrefInput!] """Documents linked to this contact.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """Roles of Contact in his primary Account.""" primaryAccountAccountRoles: [UUID!] """ Job position of Contact in his primary Account or quick account position if Contact has no primary Account. """ accountPosition: String """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this contact.""" tags: [CreateTagRelationNoContactBackrefInput!] """Saved view profiles this contact currently matches.""" staticProfiles: [CreateProfileRelationNoContactBackrefInput!] """Org chart relationship of Contact in his primary Account.""" primaryAccountRelationship: String } """ Id of a ContactSocialRelation record and the field values to change, updated together with the record it belongs to. """ input UpdateContactSocialRelationNoIdBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the contact.""" angellistUrl: String """Crunchbase profile URL of the contact.""" crunchbaseUrl: String """Disqus profile URL of the contact.""" disqusUrl: String """Facebook profile id of the contact.""" facebookId: String """Facebook profile URL of the contact.""" facebookUrl: String """Flickr profile URL of the contact.""" flickrUrl: String """Foursquare profile URL of the contact.""" foursquareUrl: String """Google profile id of the contact.""" googleId: String """Google+ profile URL of the contact.""" googlePlusUrl: String """Gravatar profile URL of the contact.""" gravatarUrl: String """Klout profile URL of the contact.""" kloutUrl: String """LinkedIn profile id of the contact.""" linkedinId: String """LinkedIn profile URL of the contact.""" linkedinUrl: String """Pinterest profile URL of the contact.""" pinterestUrl: String """Quora profile URL of the contact.""" quoraUrl: String """Reddit profile URL of the contact.""" redditUrl: String """Skype contact URL or username of the contact.""" skypeUrl: String """SlideShare profile URL of the contact.""" slideshareUrl: String """Twitter (X) user id of the contact.""" twitterId: String """Twitter (X) profile URL of the contact.""" twitterUrl: String """Vimeo profile URL of the contact.""" vimeoUrl: String """WordPress site URL of the contact.""" wordpressUrl: String """XING profile URL of the contact.""" xingUrl: String """Yahoo profile URL of the contact.""" yahooUrl: String """Yelp profile URL of the contact.""" yelpUrl: String """YouTube channel URL of the contact.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ContactAccountRelation record, created together with the record it belongs to. """ input CreateContactAccountRelationNoContactBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the contact is linked to.""" accountId: ID! """Free-form note describing this contact-account link.""" comment: String """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: Boolean """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: Boolean """Job title or position the contact holds at the account.""" position: String """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Roles the contact holds within the linked account.""" accountRoles: [CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!] } """ Field values of a new ContactAccountAccountRoleRelation record, created together with the record it belongs to. """ input CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the role assigned to the contact at the account.""" accountRoleId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoContactBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ProfileRelation record, created together with the record it belongs to. """ input CreateProfileRelationNoContactBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID } """Result of the archiveContact mutation.""" type ArchiveContactPayload { """The archived contact.""" result: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the archiveContact mutation.""" input ArchiveContactInput { """ Id of the contact and optional field values to save together with the archive. """ entity: UpdateContactInput! """Archives open leads whose primary contact is this contact.""" archiveAllRelatedLeads: Boolean! """Archives open opportunities whose primary contact is this contact.""" archiveAllRelatedOpportunities: Boolean! """Archives open quotes whose primary contact is this contact.""" archiveAllRelatedQuotes: Boolean! """Marks all tasks linked to the contact as completed.""" completeAllRelatedTasks: Boolean! """ Marks tasks of leads whose primary contact is this contact as completed. """ completeAllRelatedLeadsTasks: Boolean """ Marks tasks of opportunities whose primary contact is this contact as completed. """ completeAllRelatedOpportunitiesTasks: Boolean """ Marks tasks of quotes whose primary contact is this contact as completed. """ completeAllRelatedQuotesTasks: Boolean """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the reactivateContact mutation.""" type ReactivateContactPayload { """The reactivated contact.""" result: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the reactivateContact mutation.""" input ReactivateContactInput { """Id of the archived contact.""" id: UUID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContact mutation.""" type CreateContactPayload { """The created record.""" contact: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Contact record.""" input CreateContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture associated with the contact.""" picture: CreateCloudObjectInput """Street address of the contact.""" address: String """City of the contact address.""" city: String """Free-form notes describing the contact.""" comments: String """Id of the contact type assigned to this contact.""" contactTypeId: ID """Country of the contact address.""" country: String """Id of the currency exchange rate list applied to this contact.""" currencyExchangeRatesListId: ID """ Primary email address of the contact. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """Given name of the contact.""" firstName: String """ Gender of the contact: Unknown when not specified, Male, Female or NonBinary. """ gender: GenderEnum """ True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Family name of the contact.""" lastName: String """Middle name of the contact, if applicable.""" middleName: String """Id of the contact owner.""" ownerId: ID! """ Primary phone number of the contact. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """Job title or position of the contact.""" position: String """ Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. """ quickAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the contact address.""" stateProvince: String """ Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. """ title: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the contact address.""" zipCode: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Social network profiles linked to this contact (e.g. LinkedIn, Facebook). """ socialMedia: CreateContactSocialRelationNoIdBackrefInput """ Accounts this contact is linked to. Each link records the role and position the contact has at the related account. """ accountRelations: [CreateContactAccountRelationNoContactBackrefInput!] """ Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateContactSharingSalesUnitRelationNoContactBackrefInput!] """ Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing. """ sharingClients: [CreateContactSharingClientRelationNoContactBackrefInput!] """Documents linked to this contact.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Roles of Contact in his primary Account.""" primaryAccountAccountRoles: [UUID!] """ Job position of Contact in his primary Account or quick account position if Contact has no primary Account. """ accountPosition: String """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this contact.""" tags: [CreateTagRelationNoContactBackrefInput!] """Saved view profiles this contact currently matches.""" staticProfiles: [CreateProfileRelationNoContactBackrefInput!] """Org chart relationship of Contact in his primary Account.""" primaryAccountRelationship: String } """ Field values of a new ContactSocialRelation record, created together with the record it belongs to. """ input CreateContactSocialRelationNoIdBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the contact.""" angellistUrl: String """Crunchbase profile URL of the contact.""" crunchbaseUrl: String """Disqus profile URL of the contact.""" disqusUrl: String """Facebook profile id of the contact.""" facebookId: String """Facebook profile URL of the contact.""" facebookUrl: String """Flickr profile URL of the contact.""" flickrUrl: String """Foursquare profile URL of the contact.""" foursquareUrl: String """Google profile id of the contact.""" googleId: String """Google+ profile URL of the contact.""" googlePlusUrl: String """Gravatar profile URL of the contact.""" gravatarUrl: String """Klout profile URL of the contact.""" kloutUrl: String """LinkedIn profile id of the contact.""" linkedinId: String """LinkedIn profile URL of the contact.""" linkedinUrl: String """Pinterest profile URL of the contact.""" pinterestUrl: String """Quora profile URL of the contact.""" quoraUrl: String """Reddit profile URL of the contact.""" redditUrl: String """Skype contact URL or username of the contact.""" skypeUrl: String """SlideShare profile URL of the contact.""" slideshareUrl: String """Twitter (X) user id of the contact.""" twitterId: String """Twitter (X) profile URL of the contact.""" twitterUrl: String """Vimeo profile URL of the contact.""" vimeoUrl: String """WordPress site URL of the contact.""" wordpressUrl: String """XING profile URL of the contact.""" xingUrl: String """Yahoo profile URL of the contact.""" yahooUrl: String """Yelp profile URL of the contact.""" yelpUrl: String """YouTube channel URL of the contact.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContact mutation.""" type UpdateContactPayload { """The updated record.""" contact: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkUpdateContact mutation.""" type BulkUpdateContactPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Contact record to create, or to update when its id is set. """ input CreateOrUpdateContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture associated with the contact.""" picture: CreateCloudObjectInput """Street address of the contact.""" address: String """City of the contact address.""" city: String """Free-form notes describing the contact.""" comments: String """Id of the contact type assigned to this contact.""" contactTypeId: ID """Country of the contact address.""" country: String """Id of the currency exchange rate list applied to this contact.""" currencyExchangeRatesListId: ID """ Primary email address of the contact. Used as default recipient for emails sent from Coevera. """ email1: String """Additional email address.""" email2: String """Additional email address.""" email3: String """Additional email address.""" email4: String """Additional email address.""" email5: String """Given name of the contact.""" firstName: String """ Gender of the contact: Unknown when not specified, Male, Female or NonBinary. """ gender: GenderEnum """ True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Family name of the contact.""" lastName: String """Middle name of the contact, if applicable.""" middleName: String """Id of the contact owner.""" ownerId: ID """ Primary phone number of the contact. Used as default target for click-to-call. """ phone1: String """Additional phone number.""" phone2: String """Additional phone number.""" phone3: String """Additional phone number.""" phone4: String """Additional phone number.""" phone5: String """Id of the profile picture document.""" pictureId: ID """Job title or position of the contact.""" position: String """ Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. """ quickAccountName: String """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """State or province of the contact address.""" stateProvince: String """ Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. """ title: String """Id of the sales unit.""" unitId: ID """ZIP or postal code of the contact address.""" zipCode: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Social network profiles linked to this contact (e.g. LinkedIn, Facebook). """ socialMedia: UpdateContactSocialRelationNoIdBackrefInput """ Accounts this contact is linked to. Each link records the role and position the contact has at the related account. """ accountRelations: [CreateContactAccountRelationNoContactBackrefInput!] """ Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateContactSharingSalesUnitRelationNoContactBackrefInput!] """ Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing. """ sharingClients: [CreateContactSharingClientRelationNoContactBackrefInput!] """Documents linked to this contact.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """Roles of Contact in his primary Account.""" primaryAccountAccountRoles: [UUID!] """ Job position of Contact in his primary Account or quick account position if Contact has no primary Account. """ accountPosition: String """If account has any unsubscribed email.""" isUnsubscribed: Boolean """Tag labels applied to this contact.""" tags: [CreateTagRelationNoContactBackrefInput!] """Saved view profiles this contact currently matches.""" staticProfiles: [CreateProfileRelationNoContactBackrefInput!] """Org chart relationship of Contact in his primary Account.""" primaryAccountRelationship: String } """Id of the Contact record to delete.""" input DeleteContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContact mutation.""" type DeleteContactPayload { """The deleted record.""" contact: ContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkArchiveContact mutation.""" type BulkArchiveContactPayload { """Ids of the archived contacts and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkArchiveContact mutation.""" input BulkArchiveContactInput { """ Contacts to archive: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """Field values saved on every archived contact.""" entity: CreateOrUpdateContactInput! """Archives open leads whose primary contact is one of the contacts.""" archiveAllRelatedLeads: Boolean = false """ Archives open opportunities whose primary contact is one of the contacts. """ archiveAllRelatedOpportunities: Boolean = false """Archives open quotes whose primary contact is one of the contacts.""" archiveAllRelatedQuotes: Boolean = false """Marks all tasks linked to each contact as completed.""" completeAllRelatedTasks: Boolean = false """Marks tasks of the contacts' leads as completed.""" completeAllRelatedLeadsTasks: Boolean = false """Marks tasks of the contacts' opportunities as completed.""" completeAllRelatedOpportunitiesTasks: Boolean = false """Marks tasks of the contacts' quotes as completed.""" completeAllRelatedQuotesTasks: Boolean = false """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkReactivateContact mutation.""" type BulkReactivateContactPayload { """Ids of the reactivated records and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkReactivateContact mutation.""" input BulkReactivateContactInput { """ Records to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the convertContact mutation.""" type ConvertContactPayload { """The created record.""" contact: ContactEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactAccountAccountRoleRelation mutation.""" type CreateContactAccountAccountRoleRelationPayload { """The created record.""" contactAccountAccountRoleRelation: ContactAccountAccountRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactAccountAccountRoleRelation record.""" input CreateContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact-account link this role assignment belongs to.""" contactAccountRelation: CreateContactAccountRelationInput! """Id of the role assigned to the contact at the account.""" accountRoleId: ID! """Id of the contact-account link.""" contactAccountRelationId: ID! """Revision when entity was lastly changed.""" revision: Int } """Field values of a new ContactAccountRelation record.""" input CreateContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the contact is linked to.""" accountId: ID! """Free-form note describing this contact-account link.""" comment: String """Id of the contact linked to the account.""" contactId: ID! """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: Boolean """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: Boolean """Job title or position the contact holds at the account.""" position: String """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Roles the contact holds within the linked account.""" accountRoles: [CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!] } """Result of the updateContactAccountAccountRoleRelation mutation.""" type UpdateContactAccountAccountRoleRelationPayload { """The updated record.""" contactAccountAccountRoleRelation: ContactAccountAccountRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a ContactAccountAccountRoleRelation record and the field values to change. """ input UpdateContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact-account link this role assignment belongs to.""" contactAccountRelation: CreateContactAccountRelationInput """Id of the role assigned to the contact at the account.""" accountRoleId: ID """Id of the contact-account link.""" contactAccountRelationId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactAccountAccountRoleRelation mutation.""" type BulkUpdateContactAccountAccountRoleRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactAccountAccountRoleRelation record to create, or to update when its id is set. """ input CreateOrUpdateContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact-account link this role assignment belongs to.""" contactAccountRelation: CreateContactAccountRelationInput """Id of the role assigned to the contact at the account.""" accountRoleId: ID """Id of the contact-account link.""" contactAccountRelationId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactAccountAccountRoleRelation record to delete.""" input DeleteContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactAccountAccountRoleRelation mutation.""" type DeleteContactAccountAccountRoleRelationPayload { """The deleted record.""" contactAccountAccountRoleRelation: ContactAccountAccountRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactAccountRelation mutation.""" type CreateContactAccountRelationPayload { """The created record.""" contactAccountRelation: ContactAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateContactAccountRelation mutation.""" type UpdateContactAccountRelationPayload { """The updated record.""" contactAccountRelation: ContactAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ContactAccountRelation record and the field values to change.""" input UpdateContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the contact is linked to.""" accountId: ID """Free-form note describing this contact-account link.""" comment: String """Id of the contact linked to the account.""" contactId: ID """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: Boolean """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: Boolean """Job title or position the contact holds at the account.""" position: String """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Roles the contact holds within the linked account.""" accountRoles: [CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!] } """Result of the bulkUpdateContactAccountRelation mutation.""" type BulkUpdateContactAccountRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactAccountRelation record to create, or to update when its id is set. """ input CreateOrUpdateContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the contact is linked to.""" accountId: ID """Free-form note describing this contact-account link.""" comment: String """Id of the contact linked to the account.""" contactId: ID """ True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. """ isAssistant: Boolean """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """ True when the contact is a sibling node on the account org chart (no parent/child reporting line). """ isSibling: Boolean """Job title or position the contact holds at the account.""" position: String """Org-chart relationship of the contact within the account hierarchy.""" relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Roles the contact holds within the linked account.""" accountRoles: [CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!] } """Id of the ContactAccountRelation record to delete.""" input DeleteContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactAccountRelation mutation.""" type DeleteContactAccountRelationPayload { """The deleted record.""" contactAccountRelation: ContactAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactKpi mutation.""" type CreateContactKPIPayload { """The created record.""" contactKpi: ContactKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactKPI record.""" input CreateContactKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """Id of the contact this KPI event relates to.""" contactId: ID! """ KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: ContactKpiEnum! """Id of the contact owner at the time of the event.""" ownerId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContactKpi mutation.""" type UpdateContactKPIPayload { """The updated record.""" contactKpi: ContactKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ContactKPI record and the field values to change.""" input UpdateContactKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """Id of the contact this KPI event relates to.""" contactId: ID """ KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: ContactKpiEnum """Id of the contact owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactKpi mutation.""" type BulkUpdateContactKPIPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactKPI record to create, or to update when its id is set. """ input CreateOrUpdateContactKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """Id of the contact this KPI event relates to.""" contactId: ID """ KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified. """ kpi: ContactKpiEnum """Id of the contact owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactKPI record to delete.""" input DeleteContactKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactKpi mutation.""" type DeleteContactKPIPayload { """The deleted record.""" contactKpi: ContactKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactRelation mutation.""" type CreateContactRelationPayload { """The created record.""" contactRelation: ContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactRelation record.""" input CreateContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the first related contact.""" contact1Id: ID! """Id of the second related contact.""" contact2Id: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContactRelation mutation.""" type UpdateContactRelationPayload { """The updated record.""" contactRelation: ContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ContactRelation record and the field values to change.""" input UpdateContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the first related contact.""" contact1Id: ID """Id of the second related contact.""" contact2Id: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactRelation mutation.""" type BulkUpdateContactRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactRelation record to create, or to update when its id is set. """ input CreateOrUpdateContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the first related contact.""" contact1Id: ID """Id of the second related contact.""" contact2Id: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactRelation record to delete.""" input DeleteContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactRelation mutation.""" type DeleteContactRelationPayload { """The deleted record.""" contactRelation: ContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactRelationLabel mutation.""" type CreateContactRelationLabelPayload { """The created record.""" contactRelationLabel: ContactRelationLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactRelationLabel record.""" input CreateContactRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact relationship being labelled.""" contactRelation: CreateContactRelationInput! """Id of the contact relationship.""" contactRelationId: ID! """Id of the relationship type.""" contactRelationTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContactRelationLabel mutation.""" type UpdateContactRelationLabelPayload { """The updated record.""" contactRelationLabel: ContactRelationLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ContactRelationLabel record and the field values to change.""" input UpdateContactRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact relationship being labelled.""" contactRelation: CreateContactRelationInput """Id of the contact relationship.""" contactRelationId: ID """Id of the relationship type.""" contactRelationTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactRelationLabel mutation.""" type BulkUpdateContactRelationLabelPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactRelationLabel record to create, or to update when its id is set. """ input CreateOrUpdateContactRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Contact relationship being labelled.""" contactRelation: CreateContactRelationInput """Id of the contact relationship.""" contactRelationId: ID """Id of the relationship type.""" contactRelationTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactRelationLabel record to delete.""" input DeleteContactRelationLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactRelationLabel mutation.""" type DeleteContactRelationLabelPayload { """The deleted record.""" contactRelationLabel: ContactRelationLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactRelationType mutation.""" type CreateContactRelationTypePayload { """The created record.""" contactRelationType: ContactRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactRelationType record.""" input CreateContactRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """ Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). """ label: String """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContactRelationType mutation.""" type UpdateContactRelationTypePayload { """The updated record.""" contactRelationType: ContactRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ContactRelationType record and the field values to change.""" input UpdateContactRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """ Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). """ label: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactRelationType mutation.""" type BulkUpdateContactRelationTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactRelationType record to create, or to update when its id is set. """ input CreateOrUpdateContactRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """ Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague). """ label: String """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactRelationType record to delete.""" input DeleteContactRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactRelationType mutation.""" type DeleteContactRelationTypePayload { """The deleted record.""" contactRelationType: ContactRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactSharingClientRelation mutation.""" type CreateContactSharingClientRelationPayload { """The created record.""" contactSharingClientRelation: ContactSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactSharingClientRelation record.""" input CreateContactSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the shared contact.""" contactId: ID! """ Access the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContactSharingClientRelation mutation.""" type UpdateContactSharingClientRelationPayload { """The updated record.""" contactSharingClientRelation: ContactSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a ContactSharingClientRelation record and the field values to change. """ input UpdateContactSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared contact.""" contactId: ID """ Access the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactSharingClientRelation mutation.""" type BulkUpdateContactSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateContactSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared contact.""" contactId: ID """ Access the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactSharingClientRelation record to delete.""" input DeleteContactSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactSharingClientRelation mutation.""" type DeleteContactSharingClientRelationPayload { """The deleted record.""" contactSharingClientRelation: ContactSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactSharingSalesUnitRelation mutation.""" type CreateContactSharingSalesUnitRelationPayload { """The created record.""" contactSharingSalesUnitRelation: ContactSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactSharingSalesUnitRelation record.""" input CreateContactSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared contact.""" contactId: ID! """ Access the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContactSharingSalesUnitRelation mutation.""" type UpdateContactSharingSalesUnitRelationPayload { """The updated record.""" contactSharingSalesUnitRelation: ContactSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a ContactSharingSalesUnitRelation record and the field values to change. """ input UpdateContactSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared contact.""" contactId: ID """ Access the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactSharingSalesUnitRelation mutation.""" type BulkUpdateContactSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateContactSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared contact.""" contactId: ID """ Access the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactSharingSalesUnitRelation record to delete.""" input DeleteContactSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteContactSharingSalesUnitRelation mutation.""" type DeleteContactSharingSalesUnitRelationPayload { """The deleted record.""" contactSharingSalesUnitRelation: ContactSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createContactSocialRelation mutation.""" type CreateContactSocialRelationPayload { """The created record.""" contactSocialRelation: ContactSocialRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ContactSocialRelation record.""" input CreateContactSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Contact id.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the contact.""" angellistUrl: String """Crunchbase profile URL of the contact.""" crunchbaseUrl: String """Disqus profile URL of the contact.""" disqusUrl: String """Facebook profile id of the contact.""" facebookId: String """Facebook profile URL of the contact.""" facebookUrl: String """Flickr profile URL of the contact.""" flickrUrl: String """Foursquare profile URL of the contact.""" foursquareUrl: String """Google profile id of the contact.""" googleId: String """Google+ profile URL of the contact.""" googlePlusUrl: String """Gravatar profile URL of the contact.""" gravatarUrl: String """Klout profile URL of the contact.""" kloutUrl: String """LinkedIn profile id of the contact.""" linkedinId: String """LinkedIn profile URL of the contact.""" linkedinUrl: String """Pinterest profile URL of the contact.""" pinterestUrl: String """Quora profile URL of the contact.""" quoraUrl: String """Reddit profile URL of the contact.""" redditUrl: String """Skype contact URL or username of the contact.""" skypeUrl: String """SlideShare profile URL of the contact.""" slideshareUrl: String """Twitter (X) user id of the contact.""" twitterId: String """Twitter (X) profile URL of the contact.""" twitterUrl: String """Vimeo profile URL of the contact.""" vimeoUrl: String """WordPress site URL of the contact.""" wordpressUrl: String """XING profile URL of the contact.""" xingUrl: String """Yahoo profile URL of the contact.""" yahooUrl: String """Yelp profile URL of the contact.""" yelpUrl: String """YouTube channel URL of the contact.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """Result of the updateContactSocialRelation mutation.""" type UpdateContactSocialRelationPayload { """The updated record.""" contactSocialRelation: ContactSocialRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ContactSocialRelation record and the field values to change.""" input UpdateContactSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Contact id.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the contact.""" angellistUrl: String """Crunchbase profile URL of the contact.""" crunchbaseUrl: String """Disqus profile URL of the contact.""" disqusUrl: String """Facebook profile id of the contact.""" facebookId: String """Facebook profile URL of the contact.""" facebookUrl: String """Flickr profile URL of the contact.""" flickrUrl: String """Foursquare profile URL of the contact.""" foursquareUrl: String """Google profile id of the contact.""" googleId: String """Google+ profile URL of the contact.""" googlePlusUrl: String """Gravatar profile URL of the contact.""" gravatarUrl: String """Klout profile URL of the contact.""" kloutUrl: String """LinkedIn profile id of the contact.""" linkedinId: String """LinkedIn profile URL of the contact.""" linkedinUrl: String """Pinterest profile URL of the contact.""" pinterestUrl: String """Quora profile URL of the contact.""" quoraUrl: String """Reddit profile URL of the contact.""" redditUrl: String """Skype contact URL or username of the contact.""" skypeUrl: String """SlideShare profile URL of the contact.""" slideshareUrl: String """Twitter (X) user id of the contact.""" twitterId: String """Twitter (X) profile URL of the contact.""" twitterUrl: String """Vimeo profile URL of the contact.""" vimeoUrl: String """WordPress site URL of the contact.""" wordpressUrl: String """XING profile URL of the contact.""" xingUrl: String """Yahoo profile URL of the contact.""" yahooUrl: String """Yelp profile URL of the contact.""" yelpUrl: String """YouTube channel URL of the contact.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateContactSocialRelation mutation.""" type BulkUpdateContactSocialRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ContactSocialRelation record to create, or to update when its id is set. """ input CreateOrUpdateContactSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Contact id.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """AngelList profile URL of the contact.""" angellistUrl: String """Crunchbase profile URL of the contact.""" crunchbaseUrl: String """Disqus profile URL of the contact.""" disqusUrl: String """Facebook profile id of the contact.""" facebookId: String """Facebook profile URL of the contact.""" facebookUrl: String """Flickr profile URL of the contact.""" flickrUrl: String """Foursquare profile URL of the contact.""" foursquareUrl: String """Google profile id of the contact.""" googleId: String """Google+ profile URL of the contact.""" googlePlusUrl: String """Gravatar profile URL of the contact.""" gravatarUrl: String """Klout profile URL of the contact.""" kloutUrl: String """LinkedIn profile id of the contact.""" linkedinId: String """LinkedIn profile URL of the contact.""" linkedinUrl: String """Pinterest profile URL of the contact.""" pinterestUrl: String """Quora profile URL of the contact.""" quoraUrl: String """Reddit profile URL of the contact.""" redditUrl: String """Skype contact URL or username of the contact.""" skypeUrl: String """SlideShare profile URL of the contact.""" slideshareUrl: String """Twitter (X) user id of the contact.""" twitterId: String """Twitter (X) profile URL of the contact.""" twitterUrl: String """Vimeo profile URL of the contact.""" vimeoUrl: String """WordPress site URL of the contact.""" wordpressUrl: String """XING profile URL of the contact.""" xingUrl: String """Yahoo profile URL of the contact.""" yahooUrl: String """Yelp profile URL of the contact.""" yelpUrl: String """YouTube channel URL of the contact.""" youtubeUrl: String """Revision when entity was lastly changed.""" revision: Int } """Id of the ContactSocialRelation record to delete.""" input DeleteContactSocialRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity. Must match with Contact id.""" id: ID! } """Result of the deleteContactSocialRelation mutation.""" type DeleteContactSocialRelationPayload { """The deleted record.""" contactSocialRelation: ContactSocialRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCountryCrm mutation.""" type CreateCountryCrmPayload { """The created record.""" countryCrm: CountryCrmEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CountryCrm record.""" input CreateCountryCrmInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """ Whether the country name is a localization key to be translated into the user language rather than displayed verbatim. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCountryCrm mutation.""" type UpdateCountryCrmPayload { """The updated record.""" countryCrm: CountryCrmEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a CountryCrm record and the field values to change.""" input UpdateCountryCrmInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ Whether the country name is a localization key to be translated into the user language rather than displayed verbatim. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCountryCrm mutation.""" type BulkUpdateCountryCrmPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CountryCrm record to create, or to update when its id is set. """ input CreateOrUpdateCountryCrmInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ Whether the country name is a localization key to be translated into the user language rather than displayed verbatim. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Id of the CountryCrm record to delete.""" input DeleteCountryCrmInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCountryCrm mutation.""" type DeleteCountryCrmPayload { """The deleted record.""" countryCrm: CountryCrmEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCurrency mutation.""" type CreateCurrencyPayload { """The created record.""" currency: CurrencyEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Currency record.""" input CreateCurrencyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" code: String! """ Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI. """ symbol: String """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured for this currency, one per exchange rate list (effective period). """ currencyExchangeRates: [CreateCurrencyExchangeRateNoCurrencyBackrefInput!]! } """ Field values of a new CurrencyExchangeRate record, created together with the record it belongs to. """ input CreateCurrencyExchangeRateNoCurrencyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the exchange rate list (effective period) this rate belongs to.""" currencyExchangeRateListId: ID! """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: Float """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCurrency mutation.""" type UpdateCurrencyPayload { """The updated record.""" currency: CurrencyEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Currency record and the field values to change.""" input UpdateCurrencyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured for this currency, one per exchange rate list (effective period). """ currencyExchangeRates: [CreateCurrencyExchangeRateNoCurrencyBackrefInput!] } """Result of the bulkUpdateCurrency mutation.""" type BulkUpdateCurrencyPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Currency record to create, or to update when its id is set. """ input CreateOrUpdateCurrencyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" code: String """ Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI. """ symbol: String """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured for this currency, one per exchange rate list (effective period). """ currencyExchangeRates: [CreateCurrencyExchangeRateNoCurrencyBackrefInput!] } """Id of the Currency record to delete.""" input DeleteCurrencyInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCurrency mutation.""" type DeleteCurrencyPayload { """The deleted record.""" currency: CurrencyEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCurrencyExchangeRate mutation.""" type CreateCurrencyExchangeRatePayload { """The created record.""" currencyExchangeRate: CurrencyExchangeRateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CurrencyExchangeRate record.""" input CreateCurrencyExchangeRateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the exchange rate list (effective period) this rate belongs to.""" currencyExchangeRateListId: ID! """ Id of the currency the exchange rate applies to. Cannot be the base currency. """ currencyId: ID! """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: Float """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCurrencyExchangeRate mutation.""" type UpdateCurrencyExchangeRatePayload { """The updated record.""" currencyExchangeRate: CurrencyExchangeRateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a CurrencyExchangeRate record and the field values to change.""" input UpdateCurrencyExchangeRateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the exchange rate list (effective period) this rate belongs to.""" currencyExchangeRateListId: ID """ Id of the currency the exchange rate applies to. Cannot be the base currency. """ currencyId: ID """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: Float """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCurrencyExchangeRate mutation.""" type BulkUpdateCurrencyExchangeRatePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CurrencyExchangeRate record to create, or to update when its id is set. """ input CreateOrUpdateCurrencyExchangeRateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the exchange rate list (effective period) this rate belongs to.""" currencyExchangeRateListId: ID """ Id of the currency the exchange rate applies to. Cannot be the base currency. """ currencyId: ID """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: Float """Revision when entity was lastly changed.""" revision: Int } """Id of the CurrencyExchangeRate record to delete.""" input DeleteCurrencyExchangeRateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCurrencyExchangeRate mutation.""" type DeleteCurrencyExchangeRatePayload { """The deleted record.""" currencyExchangeRate: CurrencyExchangeRateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCurrencyExchangeRatesList mutation.""" type CreateCurrencyExchangeRatesListPayload { """The created record.""" currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CurrencyExchangeRatesList record.""" input CreateCurrencyExchangeRatesListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set. """ validFrom: DateTime! """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured in this list — one row per non-base currency in the space. """ currencyExchangeRates: [CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput!]! } """ Field values of a new CurrencyExchangeRate record, created together with the record it belongs to. """ input CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the currency the exchange rate applies to. Cannot be the base currency. """ currencyId: ID! """ Multiplier for converting an amount in the base currency into this currency. Must be greater than zero. """ exchangeRate: Float """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCurrencyExchangeRatesList mutation.""" type UpdateCurrencyExchangeRatesListPayload { """The updated record.""" currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a CurrencyExchangeRatesList record and the field values to change. """ input UpdateCurrencyExchangeRatesListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set. """ validFrom: DateTime """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured in this list — one row per non-base currency in the space. """ currencyExchangeRates: [CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput!] } """Result of the bulkUpdateCurrencyExchangeRatesList mutation.""" type BulkUpdateCurrencyExchangeRatesListPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CurrencyExchangeRatesList record to create, or to update when its id is set. """ input CreateOrUpdateCurrencyExchangeRatesListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set. """ validFrom: DateTime """Revision when entity was lastly changed.""" revision: Int """ Exchange rates configured in this list — one row per non-base currency in the space. """ currencyExchangeRates: [CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput!] } """Id of the CurrencyExchangeRatesList record to delete.""" input DeleteCurrencyExchangeRatesListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCurrencyExchangeRatesList mutation.""" type DeleteCurrencyExchangeRatesListPayload { """The deleted record.""" currencyExchangeRatesList: CurrencyExchangeRatesListEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipCustomEntity mutation.""" type ChangeOwnershipCustomEntityPayload { """The record with its new owner.""" result: CustomEntityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipCustomEntity mutation.""" input ChangeOwnershipCustomEntityInput { """User who becomes the new owner of the record.""" ownerId: ID! """Sales unit the record is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the record as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """ When true, the new owner and sales unit are also applied to the record's open tasks and appointments and its notes. Linked records that cannot be transferred are skipped without failing the mutation. """ transferLinkedRecords: Boolean! """Identifier of the CustomEntityEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyCustomEntity mutation.""" type CopyCustomEntityPayload { """The new record.""" result: CustomEntityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyCustomEntity mutation.""" input CopyCustomEntityInput { """ When true, the copy keeps the original name without the copy suffix. Defaults to false. """ skipCopySuffix: Boolean """Identifier of the CustomEntityEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingCustomEntity mutation.""" type ManageSharingCustomEntityPayload { """The record with its updated sharing.""" result: CustomEntityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingCustomEntity mutation.""" input ManageSharingCustomEntityInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateCustomEntitySharingClientRelationNoCustomEntityBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateCustomEntitySharingSalesUnitRelationNoCustomEntityBackrefInput!] """Identifier of the CustomEntityEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new CustomEntitySharingClientRelation record, created together with the record it belongs to. """ input CreateCustomEntitySharingClientRelationNoCustomEntityBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new CustomEntitySharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateCustomEntitySharingSalesUnitRelationNoCustomEntityBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the createCustomEntityDataExRelation mutation.""" type CreateCustomEntityDataExRelationPayload { """The created record.""" customEntityDataExRelation: CustomEntityDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CustomEntityDataExRelation record.""" input CreateCustomEntityDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the custom entity record on which the option is selected.""" customEntityId: ID! """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCustomEntityDataExRelation mutation.""" type UpdateCustomEntityDataExRelationPayload { """The updated record.""" customEntityDataExRelation: CustomEntityDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a CustomEntityDataExRelation record and the field values to change. """ input UpdateCustomEntityDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the custom entity record on which the option is selected.""" customEntityId: ID """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCustomEntityDataExRelation mutation.""" type BulkUpdateCustomEntityDataExRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CustomEntityDataExRelation record to create, or to update when its id is set. """ input CreateOrUpdateCustomEntityDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the custom entity record on which the option is selected.""" customEntityId: ID """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the CustomEntityDataExRelation record to delete.""" input DeleteCustomEntityDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCustomEntityDataExRelation mutation.""" type DeleteCustomEntityDataExRelationPayload { """The deleted record.""" customEntityDataExRelation: CustomEntityDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCustomEntitySharingClientRelation mutation.""" type CreateCustomEntitySharingClientRelationPayload { """The created record.""" customEntitySharingClientRelation: CustomEntitySharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CustomEntitySharingClientRelation record.""" input CreateCustomEntitySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the shared custom entity record.""" customEntityId: ID! """ Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCustomEntitySharingClientRelation mutation.""" type UpdateCustomEntitySharingClientRelationPayload { """The updated record.""" customEntitySharingClientRelation: CustomEntitySharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a CustomEntitySharingClientRelation record and the field values to change. """ input UpdateCustomEntitySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared custom entity record.""" customEntityId: ID """ Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCustomEntitySharingClientRelation mutation.""" type BulkUpdateCustomEntitySharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CustomEntitySharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateCustomEntitySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared custom entity record.""" customEntityId: ID """ Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the CustomEntitySharingClientRelation record to delete.""" input DeleteCustomEntitySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCustomEntitySharingClientRelation mutation.""" type DeleteCustomEntitySharingClientRelationPayload { """The deleted record.""" customEntitySharingClientRelation: CustomEntitySharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createCustomEntitySharingSalesUnitRelation mutation.""" type CreateCustomEntitySharingSalesUnitRelationPayload { """The created record.""" customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new CustomEntitySharingSalesUnitRelation record.""" input CreateCustomEntitySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared custom entity record.""" customEntityId: ID! """ Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateCustomEntitySharingSalesUnitRelation mutation.""" type UpdateCustomEntitySharingSalesUnitRelationPayload { """The updated record.""" customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a CustomEntitySharingSalesUnitRelation record and the field values to change. """ input UpdateCustomEntitySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared custom entity record.""" customEntityId: ID """ Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateCustomEntitySharingSalesUnitRelation mutation.""" type BulkUpdateCustomEntitySharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a CustomEntitySharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateCustomEntitySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared custom entity record.""" customEntityId: ID """ Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the CustomEntitySharingSalesUnitRelation record to delete.""" input DeleteCustomEntitySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteCustomEntitySharingSalesUnitRelation mutation.""" type DeleteCustomEntitySharingSalesUnitRelationPayload { """The deleted record.""" customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the restoreData mutation.""" type RestoreDataPayload { """The restored option.""" result: DataEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreData mutation.""" input RestoreDataInput { """ Zero-based position of the restored option within its data set; the other options are renumbered around it. """ sortOrder: Int! """Identifier of the DataEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the deleteData mutation.""" type DeleteDataPayload { """The deleted record.""" data: DataEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of the Data record to delete.""" input DeleteDataInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the createData mutation.""" type CreateDataPayload { """The created record.""" data: DataEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Data record.""" input CreateDataInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available. """ allowedBy: JSONString """ Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option). """ calcValue: Float """ Identifier of the data set this option belongs to. Shared by all options of a dropdown / radio / multiselect field. """ dataSetId: ID! """Name of the entity and its default text representation.""" optionName: String! """Position of the option within its data set; lower values appear first.""" sortOrder: Int! """ True when the entity configuration is published; false while it exists only as an unpublished draft. """ isPublished: Boolean """Revision when entity was lastly changed.""" revision: Int """ Map of locale codes to translated option names (e.g. {"en-US": "Hot", "de-DE": "Heiß"}). Empty when no translations are defined. """ optionNameTranslations: JSONString } """Result of the updateData mutation.""" type UpdateDataPayload { """The updated record.""" data: DataEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Data record and the field values to change.""" input UpdateDataInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available. """ allowedBy: JSONString """ Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option). """ calcValue: Float """Name of the entity and its default text representation.""" optionName: String """Position of the option within its data set; lower values appear first.""" sortOrder: Int """Revision when entity was lastly changed.""" revision: Int """ Map of locale codes to translated option names (e.g. {"en-US": "Hot", "de-DE": "Heiß"}). Empty when no translations are defined. """ optionNameTranslations: JSONString } """Result of the manageSharingEmail mutation.""" type ManageSharingEmailPayload { """The email with its updated sharing.""" result: EmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingEmail mutation.""" input ManageSharingEmailInput { """Sharing mode of the email: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the email is shared with, each with the Watcher or Editor role. Replaces the current list when sent; an omitted list is left unchanged. """ sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!] """ Sales units the email is shared with, each with the Watcher or Editor role. Replaces the current list when sent; an omitted list is left unchanged. """ sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!] """Identifier of the EmailEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new MessageSharingClientRelation record, created together with the record it belongs to. """ input CreateMessageSharingClientRelationNoMessageBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new MessageSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateMessageSharingSalesUnitRelationNoMessageBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the manageContentSharingEmail mutation.""" type ManageContentSharingEmailPayload { """The email with its updated content sharing.""" result: EmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageContentSharingEmail mutation.""" input ManageContentSharingEmailInput { """ Public shows the body to everyone who can see the email; Private only to its owner, its sender and the users the email is shared with; Custom additionally to the users and sales units listed here. """ shareMode: ContentShareModeEnum! """ Users who can read the body when the mode is Custom. Replaces the current list when sent; an omitted list is left unchanged. """ sharingClients: [CreateEmailContentSharingClientRelationNoEmailBackrefInput!] """ Sales units whose members can read the body when the mode is Custom. Replaces the current list when sent; an omitted list is left unchanged. """ sharingUnits: [CreateEmailContentSharingSalesUnitRelationNoEmailBackrefInput!] """Identifier of the EmailEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new EmailContentSharingClientRelation record, created together with the record it belongs to. """ input CreateEmailContentSharingClientRelationNoEmailBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new EmailContentSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateEmailContentSharingSalesUnitRelationNoEmailBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the createEmail mutation.""" type CreateEmailPayload { """The created record.""" email: EmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Email record.""" input CreateEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. """ additionalHeaders: JSONString """Comma-separated list of blind-carbon-copy recipients.""" bcc: String """ HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. """ body: String """ Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. """ bodySummary: String """Comma-separated list of carbon-copy recipients.""" cc: String """ Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmailId: ID """ How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). """ contentShareMode: ContentShareModeEnum """MIME content type of the body (e.g. text/html, text/plain).""" contentType: String """ Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. """ dateSent: DateTime """Direction of the email (Incoming, Outgoing).""" direction: EmailDirectionEnum! """ Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmailId: ID """ Serialised state of the Create Email dialogue for a draft, as a JSON object, so the composer can be re-opened verbatim. Empty for non-draft emails. """ draftSettings: JSONString """ Numeric error code recorded when the email failed to send. Zero when no error occurred. """ errorCode: Int """ True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. """ isDraft: Boolean """ True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. """ isTracked: Boolean """ External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. """ originalId: String """Id of the email owner.""" ownerId: ID """Id of the parent (master) email.""" parentEmailId: ID """ Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. """ scheduleSettings: JSONString """ Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. """ sendAt: DateTime """Sender address as it appeared on the email (free-text "From" header).""" sender: String """Id of the matched sender account.""" senderAccountId: ID """Id of the matched sender user.""" senderClientId: ID """Id of the matched sender contact.""" senderContactId: ID """Id of the personal email-integration account that sent this email.""" senderEmailAccountId: ID """ Tone of the email (Negative, Neutral or Positive) as assessed by AI from its content; empty until assessed. Returned only to users with read permission on the email content. """ sentiment: EmailSentimentEnum """ Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Name of the entity and its default text representation.""" subject: String """Id of the email template.""" templateId: ID """Identifier grouping emails belonging to the same conversation thread.""" threadId: ID """Comma-separated list of primary recipients.""" to: String """ Whether the email is an individual email (Standard) or part of a mass email (Mass). """ type: EmailTypeEnum """IMAP UID of the email on the source mailbox.""" uid: String! """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this email envelope. """ sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!] """Users that have been granted shared access to this email envelope.""" sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!] """ Sales units that have been granted access to the email body when contentShareMode is restricted. """ contentSharingUnits: [CreateEmailContentSharingSalesUnitRelationNoEmailBackrefInput!] """ Users that have been granted access to the email body when contentShareMode is restricted. """ contentSharingClients: [CreateEmailContentSharingClientRelationNoEmailBackrefInput!] """Accounts this email is linked to.""" accountRelations: [CreateMessageRelationNoMessageBackrefInput!] """Contacts this email is linked to.""" contactRelations: [CreateMessageRelationNoMessageBackrefInput!] """Projects this email is linked to.""" projectRelations: [CreateMessageRelationNoMessageBackrefInput!] """Custom entity records this email is linked to.""" customEntityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Leads this email is linked to.""" leadRelations: [CreateMessageRelationNoMessageBackrefInput!] """Opportunities this email is linked to.""" opportunityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Quotes this email is linked to.""" quoteRelations: [CreateMessageRelationNoMessageBackrefInput!] """ Tag labels applied to this email. Visible only to users that can read the email body. """ tags: [CreateTagRelationNoEmailBackrefInput!] """Attachments and other documents linked to this email.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """ Field values of a new MessageRelation record, created together with the record it belongs to. """ input CreateMessageRelationNoMessageBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoEmailBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEmail mutation.""" type UpdateEmailPayload { """The updated record.""" email: EmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an Email record and the field values to change.""" input UpdateEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. """ additionalHeaders: JSONString """Comma-separated list of blind-carbon-copy recipients.""" bcc: String """ HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. """ body: String """ Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. """ bodySummary: String """Comma-separated list of carbon-copy recipients.""" cc: String """ Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmailId: ID """ How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). """ contentShareMode: ContentShareModeEnum """MIME content type of the body (e.g. text/html, text/plain).""" contentType: String """ Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. """ dateSent: DateTime """Direction of the email (Incoming, Outgoing).""" direction: EmailDirectionEnum """ Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmailId: ID """ Serialised state of the Create Email dialogue for a draft, as a JSON object, so the composer can be re-opened verbatim. Empty for non-draft emails. """ draftSettings: JSONString """ Numeric error code recorded when the email failed to send. Zero when no error occurred. """ errorCode: Int """ True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. """ isDraft: Boolean """ True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. """ isTracked: Boolean """ External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. """ originalId: String """Id of the email owner.""" ownerId: ID """Id of the parent (master) email.""" parentEmailId: ID """ Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. """ scheduleSettings: JSONString """ Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. """ sendAt: DateTime """Sender address as it appeared on the email (free-text "From" header).""" sender: String """Id of the matched sender account.""" senderAccountId: ID """Id of the matched sender user.""" senderClientId: ID """Id of the matched sender contact.""" senderContactId: ID """Id of the personal email-integration account that sent this email.""" senderEmailAccountId: ID """ Tone of the email (Negative, Neutral or Positive) as assessed by AI from its content; empty until assessed. Returned only to users with read permission on the email content. """ sentiment: EmailSentimentEnum """ Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Name of the entity and its default text representation.""" subject: String """Id of the email template.""" templateId: ID """Identifier grouping emails belonging to the same conversation thread.""" threadId: ID """Comma-separated list of primary recipients.""" to: String """ Whether the email is an individual email (Standard) or part of a mass email (Mass). """ type: EmailTypeEnum """IMAP UID of the email on the source mailbox.""" uid: String """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this email envelope. """ sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!] """Users that have been granted shared access to this email envelope.""" sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!] """ Sales units that have been granted access to the email body when contentShareMode is restricted. """ contentSharingUnits: [CreateEmailContentSharingSalesUnitRelationNoEmailBackrefInput!] """ Users that have been granted access to the email body when contentShareMode is restricted. """ contentSharingClients: [CreateEmailContentSharingClientRelationNoEmailBackrefInput!] """Accounts this email is linked to.""" accountRelations: [CreateMessageRelationNoMessageBackrefInput!] """Contacts this email is linked to.""" contactRelations: [CreateMessageRelationNoMessageBackrefInput!] """Projects this email is linked to.""" projectRelations: [CreateMessageRelationNoMessageBackrefInput!] """Custom entity records this email is linked to.""" customEntityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Leads this email is linked to.""" leadRelations: [CreateMessageRelationNoMessageBackrefInput!] """Opportunities this email is linked to.""" opportunityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Quotes this email is linked to.""" quoteRelations: [CreateMessageRelationNoMessageBackrefInput!] """ Tag labels applied to this email. Visible only to users that can read the email body. """ tags: [CreateTagRelationNoEmailBackrefInput!] """Attachments and other documents linked to this email.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateEmail mutation.""" type BulkUpdateEmailPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an Email record to create, or to update when its id is set. """ input CreateOrUpdateEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. """ additionalHeaders: JSONString """Comma-separated list of blind-carbon-copy recipients.""" bcc: String """ HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. """ body: String """ Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. """ bodySummary: String """Comma-separated list of carbon-copy recipients.""" cc: String """ Id of the company email used as the From / Reply-To. Empty when sent from the user mailbox. """ companyEmailId: ID """ How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). """ contentShareMode: ContentShareModeEnum """MIME content type of the body (e.g. text/html, text/plain).""" contentType: String """ Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. """ dateSent: DateTime """Direction of the email (Incoming, Outgoing).""" direction: EmailDirectionEnum """ Id of the original email a draft was started from (reply/forward source), or empty for a standalone draft. """ draftParentEmailId: ID """ Serialised state of the Create Email dialogue for a draft, as a JSON object, so the composer can be re-opened verbatim. Empty for non-draft emails. """ draftSettings: JSONString """ Numeric error code recorded when the email failed to send. Zero when no error occurred. """ errorCode: Int """ True when this email is an unsent draft. Drafts have no dateSent/sendAt and are excluded from the sent/scheduled streams. """ isDraft: Boolean """ True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. """ isTracked: Boolean """ External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. """ originalId: String """Id of the email owner.""" ownerId: ID """Id of the parent (master) email.""" parentEmailId: ID """ Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. """ scheduleSettings: JSONString """ Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. """ sendAt: DateTime """Sender address as it appeared on the email (free-text "From" header).""" sender: String """Id of the matched sender account.""" senderAccountId: ID """Id of the matched sender user.""" senderClientId: ID """Id of the matched sender contact.""" senderContactId: ID """Id of the personal email-integration account that sent this email.""" senderEmailAccountId: ID """ Tone of the email (Negative, Neutral or Positive) as assessed by AI from its content; empty until assessed. Returned only to users with read permission on the email content. """ sentiment: EmailSentimentEnum """ Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Name of the entity and its default text representation.""" subject: String """Id of the email template.""" templateId: ID """Identifier grouping emails belonging to the same conversation thread.""" threadId: ID """Comma-separated list of primary recipients.""" to: String """ Whether the email is an individual email (Standard) or part of a mass email (Mass). """ type: EmailTypeEnum """IMAP UID of the email on the source mailbox.""" uid: String """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this email envelope. """ sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!] """Users that have been granted shared access to this email envelope.""" sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!] """ Sales units that have been granted access to the email body when contentShareMode is restricted. """ contentSharingUnits: [CreateEmailContentSharingSalesUnitRelationNoEmailBackrefInput!] """ Users that have been granted access to the email body when contentShareMode is restricted. """ contentSharingClients: [CreateEmailContentSharingClientRelationNoEmailBackrefInput!] """Accounts this email is linked to.""" accountRelations: [CreateMessageRelationNoMessageBackrefInput!] """Contacts this email is linked to.""" contactRelations: [CreateMessageRelationNoMessageBackrefInput!] """Projects this email is linked to.""" projectRelations: [CreateMessageRelationNoMessageBackrefInput!] """Custom entity records this email is linked to.""" customEntityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Leads this email is linked to.""" leadRelations: [CreateMessageRelationNoMessageBackrefInput!] """Opportunities this email is linked to.""" opportunityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Quotes this email is linked to.""" quoteRelations: [CreateMessageRelationNoMessageBackrefInput!] """ Tag labels applied to this email. Visible only to users that can read the email body. """ tags: [CreateTagRelationNoEmailBackrefInput!] """Attachments and other documents linked to this email.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Id of the Email record to delete.""" input DeleteEmailInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmail mutation.""" type DeleteEmailPayload { """The deleted record.""" email: EmailEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateLinkedItemsEmail mutation.""" type UpdateLinkedItemsEmailPayload { """The records now linked to the e-mail.""" result: [EmailLinkedItem!]! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the updateLinkedItemsEmail mutation.""" input UpdateLinkedItemsEmailInput { """Id of the e-mail.""" emailId: UUID! """ Records to link: accounts, contacts, leads or opportunities, projects, quotes and custom entities. """ linkedItems: [SendEmailLinkedEntityParams!]! """ Limits the conversation to the e-mails in this mailbox. Leave empty to update the whole conversation. """ mailboxId: UUID """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Record a sent email or text message is linked to; set one of the ids.""" input SendEmailLinkedEntityParams { """Lead or opportunity the email is linked to.""" leadOpptyId: UUID """Project the email is linked to.""" projectId: UUID """Account the email is linked to.""" accountId: UUID """Contact the email is linked to.""" contactId: UUID """Quote the email is linked to.""" quoteId: UUID """Custom entity record the email is linked to.""" customEntityId: CustomEntityIDParams } """Result of the createEmailContentSharingClientRelation mutation.""" type CreateEmailContentSharingClientRelationPayload { """The created record.""" emailContentSharingClientRelation: EmailContentSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailContentSharingClientRelation record.""" input CreateEmailContentSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the email whose body is shared with the user.""" emailId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEmailContentSharingClientRelation mutation.""" type UpdateEmailContentSharingClientRelationPayload { """The updated record.""" emailContentSharingClientRelation: EmailContentSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an EmailContentSharingClientRelation record and the field values to change. """ input UpdateEmailContentSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the email whose body is shared with the user.""" emailId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateEmailContentSharingClientRelation mutation.""" type BulkUpdateEmailContentSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailContentSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateEmailContentSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the email whose body is shared with the user.""" emailId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the EmailContentSharingClientRelation record to delete.""" input DeleteEmailContentSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailContentSharingClientRelation mutation.""" type DeleteEmailContentSharingClientRelationPayload { """The deleted record.""" emailContentSharingClientRelation: EmailContentSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailContentSharingSalesUnitRelation mutation.""" type CreateEmailContentSharingSalesUnitRelationPayload { """The created record.""" emailContentSharingSalesUnitRelation: EmailContentSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailContentSharingSalesUnitRelation record.""" input CreateEmailContentSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email whose body is shared with the sales unit.""" emailId: ID! """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEmailContentSharingSalesUnitRelation mutation.""" type UpdateEmailContentSharingSalesUnitRelationPayload { """The updated record.""" emailContentSharingSalesUnitRelation: EmailContentSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an EmailContentSharingSalesUnitRelation record and the field values to change. """ input UpdateEmailContentSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email whose body is shared with the sales unit.""" emailId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateEmailContentSharingSalesUnitRelation mutation.""" type BulkUpdateEmailContentSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailContentSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateEmailContentSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email whose body is shared with the sales unit.""" emailId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the EmailContentSharingSalesUnitRelation record to delete.""" input DeleteEmailContentSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailContentSharingSalesUnitRelation mutation.""" type DeleteEmailContentSharingSalesUnitRelationPayload { """The deleted record.""" emailContentSharingSalesUnitRelation: EmailContentSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailEvent mutation.""" type CreateEmailEventPayload { """The created record.""" emailEvent: EmailEventEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailEvent record.""" input CreateEmailEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. """ additionalData: JSONString """Id of the email message.""" emailId: ID! """ Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce. """ type: EmailEventTypeEnum """ URL the recipient interacted with. Set for click events; empty for other event types. """ url: String } """Result of the updateEmailEvent mutation.""" type UpdateEmailEventPayload { """The updated record.""" emailEvent: EmailEventEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EmailEvent record and the field values to change.""" input UpdateEmailEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. """ additionalData: JSONString """Id of the email message.""" emailId: ID """ Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce. """ type: EmailEventTypeEnum """ URL the recipient interacted with. Set for click events; empty for other event types. """ url: String } """Result of the bulkUpdateEmailEvent mutation.""" type BulkUpdateEmailEventPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailEvent record to create, or to update when its id is set. """ input CreateOrUpdateEmailEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. """ additionalData: JSONString """Id of the email message.""" emailId: ID """ Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce. """ type: EmailEventTypeEnum """ URL the recipient interacted with. Set for click events; empty for other event types. """ url: String } """Id of the EmailEvent record to delete.""" input DeleteEmailEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailEvent mutation.""" type DeleteEmailEventPayload { """The deleted record.""" emailEvent: EmailEventEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailLabel mutation.""" type CreateEmailLabelPayload { """The created record.""" emailLabel: EmailLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailLabel record.""" input CreateEmailLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent label this one is nested under, or empty for a top-level label.""" parentEmailLabel: CreateEmailLabelInput """Color the label is displayed with, as a packed RGB integer.""" color: Int! """Name of the entity and its default text representation.""" name: String! """Id of the client who created this label.""" ownerId: ID! """ Id of the parent label this one is nested under, or empty for a top-level label. """ parentEmailLabelId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEmailLabel mutation.""" type UpdateEmailLabelPayload { """The updated record.""" emailLabel: EmailLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EmailLabel record and the field values to change.""" input UpdateEmailLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent label this one is nested under, or empty for a top-level label.""" parentEmailLabel: CreateEmailLabelInput """Color the label is displayed with, as a packed RGB integer.""" color: Int """Name of the entity and its default text representation.""" name: String """Id of the client who created this label.""" ownerId: ID """ Id of the parent label this one is nested under, or empty for a top-level label. """ parentEmailLabelId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateEmailLabel mutation.""" type BulkUpdateEmailLabelPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailLabel record to create, or to update when its id is set. """ input CreateOrUpdateEmailLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Parent label this one is nested under, or empty for a top-level label.""" parentEmailLabel: CreateEmailLabelInput """Color the label is displayed with, as a packed RGB integer.""" color: Int """Name of the entity and its default text representation.""" name: String """Id of the client who created this label.""" ownerId: ID """ Id of the parent label this one is nested under, or empty for a top-level label. """ parentEmailLabelId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the EmailLabel record to delete.""" input DeleteEmailLabelInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailLabel mutation.""" type DeleteEmailLabelPayload { """The deleted record.""" emailLabel: EmailLabelEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailLabelRelation mutation.""" type CreateEmailLabelRelationPayload { """The created record.""" emailLabelRelation: EmailLabelRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailLabelRelation record.""" input CreateEmailLabelRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Label applied to the thread by this relation.""" emailLabel: CreateEmailLabelInput! """Id of the applied label.""" emailLabelId: ID! """ Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes. """ mailboxId: ID! """Id of the relation owner.""" ownerId: ID """ Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label. """ threadId: ID! } """Result of the updateEmailLabelRelation mutation.""" type UpdateEmailLabelRelationPayload { """The updated record.""" emailLabelRelation: EmailLabelRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EmailLabelRelation record and the field values to change.""" input UpdateEmailLabelRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Label applied to the thread by this relation.""" emailLabel: CreateEmailLabelInput """Id of the applied label.""" emailLabelId: ID """ Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes. """ mailboxId: ID """Id of the relation owner.""" ownerId: ID """ Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label. """ threadId: ID } """Result of the bulkUpdateEmailLabelRelation mutation.""" type BulkUpdateEmailLabelRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailLabelRelation record to create, or to update when its id is set. """ input CreateOrUpdateEmailLabelRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Label applied to the thread by this relation.""" emailLabel: CreateEmailLabelInput """Id of the applied label.""" emailLabelId: ID """ Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes. """ mailboxId: ID """Id of the relation owner.""" ownerId: ID """ Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label. """ threadId: ID } """Id of the EmailLabelRelation record to delete.""" input DeleteEmailLabelRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailLabelRelation mutation.""" type DeleteEmailLabelRelationPayload { """The deleted record.""" emailLabelRelation: EmailLabelRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailSequence mutation.""" type CreateEmailSequencePayload { """The created record.""" emailSequence: EmailSequenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailSequence record.""" input CreateEmailSequenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form description of the sequence.""" description: String """Display name of the email sequence.""" name: String! """Id of the email sequence owner.""" ownerId: ID! """ JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe). This payload conforms to the `EmailSequenceSchema` JSON Schema: GET /api/v100/rest/schemas/EmailSequenceSchema.json on your region's API host """ settings: EmailSequenceSchemaJSONString """ Process category of the sequence (e.g. EmailSequence vs other process types). """ type: ProcessTypeEnum! """Attachments and other documents linked to this sequence.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """ JSON object, sent as a string, conforming to the EmailSequenceSchema type. """ scalar EmailSequenceSchemaJSONString """Result of the updateEmailSequence mutation.""" type UpdateEmailSequencePayload { """The updated record.""" emailSequence: EmailSequenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EmailSequence record and the field values to change.""" input UpdateEmailSequenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form description of the sequence.""" description: String """Display name of the email sequence.""" name: String """Id of the email sequence owner.""" ownerId: ID """ JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe). This payload conforms to the `EmailSequenceSchema` JSON Schema: GET /api/v100/rest/schemas/EmailSequenceSchema.json on your region's API host """ settings: EmailSequenceSchemaJSONString """ Process category of the sequence (e.g. EmailSequence vs other process types). """ type: ProcessTypeEnum """Attachments and other documents linked to this sequence.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateEmailSequence mutation.""" type BulkUpdateEmailSequencePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailSequence record to create, or to update when its id is set. """ input CreateOrUpdateEmailSequenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form description of the sequence.""" description: String """Display name of the email sequence.""" name: String """Id of the email sequence owner.""" ownerId: ID """ JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe). This payload conforms to the `EmailSequenceSchema` JSON Schema: GET /api/v100/rest/schemas/EmailSequenceSchema.json on your region's API host """ settings: EmailSequenceSchemaJSONString """ Process category of the sequence (e.g. EmailSequence vs other process types). """ type: ProcessTypeEnum """Attachments and other documents linked to this sequence.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Id of the EmailSequence record to delete.""" input DeleteEmailSequenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailSequence mutation.""" type DeleteEmailSequencePayload { """The deleted record.""" emailSequence: EmailSequenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailSequenceActivityLog mutation.""" type CreateEmailSequenceActivityLogPayload { """The created record.""" emailSequenceActivityLog: EmailSequenceActivityLogEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailSequenceActivityLog record.""" input CreateEmailSequenceActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the user who initiated the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. """ applicationId: ID! """Id of the email sequence this activity log belongs to.""" emailSequenceId: ID! """Timestamp when the run finished. Empty for runs still in progress.""" endTime: DateTime """ True when the run was a dry-run / test execution and did not produce real-side effects. """ isTestRun: Boolean """Timestamp when the run started.""" startTime: DateTime! """Outcome of the run (e.g. Ok, Error, Cancelled).""" status: ProcessStatusEnum! } """Result of the updateEmailSequenceActivityLog mutation.""" type UpdateEmailSequenceActivityLogPayload { """The updated record.""" emailSequenceActivityLog: EmailSequenceActivityLogEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an EmailSequenceActivityLog record and the field values to change. """ input UpdateEmailSequenceActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the user who initiated the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. """ applicationId: ID """Id of the email sequence this activity log belongs to.""" emailSequenceId: ID """Timestamp when the run finished. Empty for runs still in progress.""" endTime: DateTime """ True when the run was a dry-run / test execution and did not produce real-side effects. """ isTestRun: Boolean """Timestamp when the run started.""" startTime: DateTime """Outcome of the run (e.g. Ok, Error, Cancelled).""" status: ProcessStatusEnum } """Result of the bulkUpdateEmailSequenceActivityLog mutation.""" type BulkUpdateEmailSequenceActivityLogPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailSequenceActivityLog record to create, or to update when its id is set. """ input CreateOrUpdateEmailSequenceActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the user who initiated the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the run was triggered in. """ applicationId: ID """Id of the email sequence this activity log belongs to.""" emailSequenceId: ID """Timestamp when the run finished. Empty for runs still in progress.""" endTime: DateTime """ True when the run was a dry-run / test execution and did not produce real-side effects. """ isTestRun: Boolean """Timestamp when the run started.""" startTime: DateTime """Outcome of the run (e.g. Ok, Error, Cancelled).""" status: ProcessStatusEnum } """Id of the EmailSequenceActivityLog record to delete.""" input DeleteEmailSequenceActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailSequenceActivityLog mutation.""" type DeleteEmailSequenceActivityLogPayload { """The deleted record.""" emailSequenceActivityLog: EmailSequenceActivityLogEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailSequenceActivityLogLine mutation.""" type CreateEmailSequenceActivityLogLinePayload { """The created record.""" emailSequenceActivityLogLine: EmailSequenceActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailSequenceActivityLogLine record.""" input CreateEmailSequenceActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the activity log this line belongs to.""" emailSequenceActivityLogId: ID! """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its log run.""" sortOrder: Int! """Outcome of the step the line represents (e.g. Ok, Error, Skipped).""" status: ProcessStatusEnum } """Result of the updateEmailSequenceActivityLogLine mutation.""" type UpdateEmailSequenceActivityLogLinePayload { """The updated record.""" emailSequenceActivityLogLine: EmailSequenceActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an EmailSequenceActivityLogLine record and the field values to change. """ input UpdateEmailSequenceActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the activity log this line belongs to.""" emailSequenceActivityLogId: ID """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its log run.""" sortOrder: Int """Outcome of the step the line represents (e.g. Ok, Error, Skipped).""" status: ProcessStatusEnum } """Result of the bulkUpdateEmailSequenceActivityLogLine mutation.""" type BulkUpdateEmailSequenceActivityLogLinePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailSequenceActivityLogLine record to create, or to update when its id is set. """ input CreateOrUpdateEmailSequenceActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the activity log this line belongs to.""" emailSequenceActivityLogId: ID """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Position of the line within its log run.""" sortOrder: Int """Outcome of the step the line represents (e.g. Ok, Error, Skipped).""" status: ProcessStatusEnum } """Id of the EmailSequenceActivityLogLine record to delete.""" input DeleteEmailSequenceActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailSequenceActivityLogLine mutation.""" type DeleteEmailSequenceActivityLogLinePayload { """The deleted record.""" emailSequenceActivityLogLine: EmailSequenceActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailSequenceEnrolled mutation.""" type CreateEmailSequenceEnrolledPayload { """The created record.""" emailSequenceEnrolled: EmailSequenceEnrolledEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailSequenceEnrolled record.""" input CreateEmailSequenceEnrolledInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the enrolled account.""" accountId: ID """ Id of the user who triggered the enrolment, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in. """ applicationId: ID! """Id of the enrolled contact.""" contactId: ID """Id of the activity log run that produced this enrolment.""" emailSequenceActivityLogId: ID! """Id of the email sequence this enrolment belongs to.""" emailSequenceId: ID! """ Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active. """ endReason: EmailSequenceEndReasonEnum """ Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active. """ endTime: DateTime """ True when this enrolment is excluded from sequence statistics (e.g. after a stats reset). """ excludedFromStats: Boolean """Id of the enrolled lead.""" leadId: ID """Id of the enrolled opportunity.""" opptyId: ID """Id of the enrolled project.""" projectId: ID """Timestamp when the enrolment started.""" startTime: DateTime! } """Result of the updateEmailSequenceEnrolled mutation.""" type UpdateEmailSequenceEnrolledPayload { """The updated record.""" emailSequenceEnrolled: EmailSequenceEnrolledEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EmailSequenceEnrolled record and the field values to change.""" input UpdateEmailSequenceEnrolledInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the enrolled account.""" accountId: ID """ Id of the user who triggered the enrolment, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in. """ applicationId: ID """Id of the enrolled contact.""" contactId: ID """Id of the activity log run that produced this enrolment.""" emailSequenceActivityLogId: ID """Id of the email sequence this enrolment belongs to.""" emailSequenceId: ID """ Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active. """ endReason: EmailSequenceEndReasonEnum """ Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active. """ endTime: DateTime """ True when this enrolment is excluded from sequence statistics (e.g. after a stats reset). """ excludedFromStats: Boolean """Id of the enrolled lead.""" leadId: ID """Id of the enrolled opportunity.""" opptyId: ID """Id of the enrolled project.""" projectId: ID """Timestamp when the enrolment started.""" startTime: DateTime } """Result of the bulkUpdateEmailSequenceEnrolled mutation.""" type BulkUpdateEmailSequenceEnrolledPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailSequenceEnrolled record to create, or to update when its id is set. """ input CreateOrUpdateEmailSequenceEnrolledInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the enrolled account.""" accountId: ID """ Id of the user who triggered the enrolment, or empty for runs triggered by automation. """ actorId: ID """ Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in. """ applicationId: ID """Id of the enrolled contact.""" contactId: ID """Id of the activity log run that produced this enrolment.""" emailSequenceActivityLogId: ID """Id of the email sequence this enrolment belongs to.""" emailSequenceId: ID """ Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active. """ endReason: EmailSequenceEndReasonEnum """ Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active. """ endTime: DateTime """ True when this enrolment is excluded from sequence statistics (e.g. after a stats reset). """ excludedFromStats: Boolean """Id of the enrolled lead.""" leadId: ID """Id of the enrolled opportunity.""" opptyId: ID """Id of the enrolled project.""" projectId: ID """Timestamp when the enrolment started.""" startTime: DateTime } """Id of the EmailSequenceEnrolled record to delete.""" input DeleteEmailSequenceEnrolledInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailSequenceEnrolled mutation.""" type DeleteEmailSequenceEnrolledPayload { """The deleted record.""" emailSequenceEnrolled: EmailSequenceEnrolledEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the personalizeBodyEmailTemplate mutation.""" type PersonalizeBodyEmailTemplatePayload { """The personalized HTML body.""" result: String """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the personalizeBodyEmailTemplate mutation.""" input PersonalizeBodyEmailTemplateInput { """ Id of the record whose values fill the merge fields. Leave empty to get the body without record data. """ entityId: UUID """Type of the record given in entityId.""" entityType: EntityNameEnum """ API name of the custom entity when the record is a custom entity; entityType must still be set. """ entityApiName: String """Identifier of the EmailTemplateEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailTemplate mutation.""" type CreateEmailTemplatePayload { """The created record.""" emailTemplate: EmailTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateEmailTemplate mutation.""" type UpdateEmailTemplatePayload { """The updated record.""" emailTemplate: EmailTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EmailTemplate record and the field values to change.""" input UpdateEmailTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. """ body: String """ Id of the folder the template belongs to. Empty for templates at the root level. """ emailTemplateFolderId: ID """Name of the entity and its default text representation.""" name: String """Id of the template owner.""" ownerId: ID """ Colors recently used in the editor of the template body, as integer color values. """ recentColors: [Int!] """ Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). """ shareMode: ShareModeEnum """ When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. """ sharingUrlIsEnabled: Boolean """ Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured. """ sharingUrlSettings: JSONString """ Subject line of emails composed from this template. Supports merge-field placeholders. """ subject: String """ Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). """ type: EmailTemplateTypeEnum """Revision when entity was lastly changed.""" revision: Int """ Sales units granted shared access to this template (custom share mode). """ sharingUnits: [CreateEmailTemplateSharingSalesUnitRelationNoEmailTemplateBackrefInput!] """Users granted shared access to this template (custom share mode).""" sharingClients: [CreateEmailTemplateSharingClientRelationNoEmailTemplateBackrefInput!] """Files attached to the template (used as default attachments).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateEmailTemplate mutation.""" type BulkUpdateEmailTemplatePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailTemplate record to create, or to update when its id is set. """ input CreateOrUpdateEmailTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. """ body: String """ Id of the folder the template belongs to. Empty for templates at the root level. """ emailTemplateFolderId: ID """Name of the entity and its default text representation.""" name: String """Id of the template owner.""" ownerId: ID """ Colors recently used in the editor of the template body, as integer color values. """ recentColors: [Int!] """ Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). """ shareMode: ShareModeEnum """ When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. """ sharingUrlIsEnabled: Boolean """ Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured. """ sharingUrlSettings: JSONString """ Subject line of emails composed from this template. Supports merge-field placeholders. """ subject: String """ Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate). """ type: EmailTemplateTypeEnum """Revision when entity was lastly changed.""" revision: Int """ Sales units granted shared access to this template (custom share mode). """ sharingUnits: [CreateEmailTemplateSharingSalesUnitRelationNoEmailTemplateBackrefInput!] """Users granted shared access to this template (custom share mode).""" sharingClients: [CreateEmailTemplateSharingClientRelationNoEmailTemplateBackrefInput!] """Files attached to the template (used as default attachments).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Id of the EmailTemplate record to delete.""" input DeleteEmailTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailTemplate mutation.""" type DeleteEmailTemplatePayload { """The deleted record.""" emailTemplate: EmailTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailTemplateFolder mutation.""" type CreateEmailTemplateFolderPayload { """The created record.""" emailTemplateFolder: EmailTemplateFolderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailTemplateFolder record.""" input CreateEmailTemplateFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """ Id of the parent folder in the template hierarchy. Empty for top-level folders. """ parentEmailTemplateFolderId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEmailTemplateFolder mutation.""" type UpdateEmailTemplateFolderPayload { """The updated record.""" emailTemplateFolder: EmailTemplateFolderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EmailTemplateFolder record and the field values to change.""" input UpdateEmailTemplateFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ Id of the parent folder in the template hierarchy. Empty for top-level folders. """ parentEmailTemplateFolderId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateEmailTemplateFolder mutation.""" type BulkUpdateEmailTemplateFolderPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailTemplateFolder record to create, or to update when its id is set. """ input CreateOrUpdateEmailTemplateFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ Id of the parent folder in the template hierarchy. Empty for top-level folders. """ parentEmailTemplateFolderId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the EmailTemplateFolder record to delete.""" input DeleteEmailTemplateFolderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailTemplateFolder mutation.""" type DeleteEmailTemplateFolderPayload { """ The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept. """ errors: Boolean! """ The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept. """ emailTemplateFolder: EmailTemplateFolderEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailTemplateSharingClientRelation mutation.""" type CreateEmailTemplateSharingClientRelationPayload { """The created record.""" emailTemplateSharingClientRelation: EmailTemplateSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailTemplateSharingClientRelation record.""" input CreateEmailTemplateSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the email template shared with the user.""" emailTemplateId: ID! """ Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEmailTemplateSharingClientRelation mutation.""" type UpdateEmailTemplateSharingClientRelationPayload { """The updated record.""" emailTemplateSharingClientRelation: EmailTemplateSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an EmailTemplateSharingClientRelation record and the field values to change. """ input UpdateEmailTemplateSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the email template shared with the user.""" emailTemplateId: ID """ Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateEmailTemplateSharingClientRelation mutation.""" type BulkUpdateEmailTemplateSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailTemplateSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateEmailTemplateSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the email template shared with the user.""" emailTemplateId: ID """ Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the EmailTemplateSharingClientRelation record to delete.""" input DeleteEmailTemplateSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailTemplateSharingClientRelation mutation.""" type DeleteEmailTemplateSharingClientRelationPayload { """The deleted record.""" emailTemplateSharingClientRelation: EmailTemplateSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailTemplateSharingSalesUnitRelation mutation.""" type CreateEmailTemplateSharingSalesUnitRelationPayload { """The created record.""" emailTemplateSharingSalesUnitRelation: EmailTemplateSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailTemplateSharingSalesUnitRelation record.""" input CreateEmailTemplateSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email template shared with the sales unit.""" emailTemplateId: ID! """ Access the sharing gives the sales unit on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEmailTemplateSharingSalesUnitRelation mutation.""" type UpdateEmailTemplateSharingSalesUnitRelationPayload { """The updated record.""" emailTemplateSharingSalesUnitRelation: EmailTemplateSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an EmailTemplateSharingSalesUnitRelation record and the field values to change. """ input UpdateEmailTemplateSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email template shared with the sales unit.""" emailTemplateId: ID """ Access the sharing gives the sales unit on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """ Result of the bulkUpdateEmailTemplateSharingSalesUnitRelation mutation. """ type BulkUpdateEmailTemplateSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailTemplateSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateEmailTemplateSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email template shared with the sales unit.""" emailTemplateId: ID """ Access the sharing gives the sales unit on the template: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the EmailTemplateSharingSalesUnitRelation record to delete.""" input DeleteEmailTemplateSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailTemplateSharingSalesUnitRelation mutation.""" type DeleteEmailTemplateSharingSalesUnitRelationPayload { """The deleted record.""" emailTemplateSharingSalesUnitRelation: EmailTemplateSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createEmailThreadMailboxClientReadState mutation.""" type CreateEmailThreadMailboxClientReadStatePayload { """The created record.""" emailThreadMailboxClientReadState: EmailThreadMailboxClientReadStateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EmailThreadMailboxClientReadState record.""" input CreateEmailThreadMailboxClientReadStateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user whose read state of the email thread is tracked.""" clientId: ID! """Time when the user last read the email thread in the mailbox.""" lastReadAt: DateTime """ Id of the mailbox (connected email account) the email thread belongs to. """ mailboxId: ID! """ Id of the email thread, or the id of the email itself when it does not belong to a thread. """ threadOrId: ID! } """Result of the updateEmailThreadMailboxClientReadState mutation.""" type UpdateEmailThreadMailboxClientReadStatePayload { """The updated record.""" emailThreadMailboxClientReadState: EmailThreadMailboxClientReadStateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an EmailThreadMailboxClientReadState record and the field values to change. """ input UpdateEmailThreadMailboxClientReadStateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user whose read state of the email thread is tracked.""" clientId: ID """Time when the user last read the email thread in the mailbox.""" lastReadAt: DateTime """ Id of the mailbox (connected email account) the email thread belongs to. """ mailboxId: ID """ Id of the email thread, or the id of the email itself when it does not belong to a thread. """ threadOrId: ID } """Result of the bulkUpdateEmailThreadMailboxClientReadState mutation.""" type BulkUpdateEmailThreadMailboxClientReadStatePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EmailThreadMailboxClientReadState record to create, or to update when its id is set. """ input CreateOrUpdateEmailThreadMailboxClientReadStateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user whose read state of the email thread is tracked.""" clientId: ID """Time when the user last read the email thread in the mailbox.""" lastReadAt: DateTime """ Id of the mailbox (connected email account) the email thread belongs to. """ mailboxId: ID """ Id of the email thread, or the id of the email itself when it does not belong to a thread. """ threadOrId: ID } """Id of the EmailThreadMailboxClientReadState record to delete.""" input DeleteEmailThreadMailboxClientReadStateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEmailThreadMailboxClientReadState mutation.""" type DeleteEmailThreadMailboxClientReadStatePayload { """The deleted record.""" emailThreadMailboxClientReadState: EmailThreadMailboxClientReadStateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateEntityFitness mutation.""" type UpdateEntityFitnessPayload { """The updated record.""" entityFitness: EntityFitnessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EntityFitness record and the field values to change.""" input UpdateEntityFitnessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Revision when entity was lastly changed.""" revision: Int """ Fitness indicators (system or custom rules) defined for this configuration. """ indicatorRelations: [CreateOrUpdateEntityFitnessIndicatorNoEntityFitnessBackrefInput!] } """ Field values of an EntityFitnessIndicator record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateEntityFitnessIndicatorNoEntityFitnessBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Description of what the indicator measures, shown in the UI.""" description: String """ When true, description is treated as a translation key and localized in the UI. """ descriptionUseLang: Boolean """ Suggested remediation text shown to the user when a record triggers this indicator. """ howToFix: String """ When true, howToFix is treated as a translation key and localized in the UI. """ howToFixUseLang: Boolean """When false, the indicator is configured but not evaluated for records.""" isEnabled: Boolean """Display name of the indicator.""" name: String """ When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ nameUseLang: Boolean """ Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules. This payload conforms to the `FitnessIndicatorSettings` JSON Schema: GET /api/v100/rest/schemas/FitnessIndicatorSettings.json on your region's API host """ settings: FitnessIndicatorSettingsJSONString """ Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. """ type: FitnessIndicatorTypeEnum """Revision when entity was lastly changed.""" revision: Int } """ JSON object, sent as a string, conforming to the FitnessIndicatorSettings type. """ scalar FitnessIndicatorSettingsJSONString """Result of the createEntityFitnessIndicator mutation.""" type CreateEntityFitnessIndicatorPayload { """The created record.""" entityFitnessIndicator: EntityFitnessIndicatorEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EntityFitnessIndicator record.""" input CreateEntityFitnessIndicatorInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Description of what the indicator measures, shown in the UI.""" description: String! """ When true, description is treated as a translation key and localized in the UI. """ descriptionUseLang: Boolean! """Id of the fitness configuration.""" entityFitnessId: ID! """ Suggested remediation text shown to the user when a record triggers this indicator. """ howToFix: String! """ When true, howToFix is treated as a translation key and localized in the UI. """ howToFixUseLang: Boolean! """When false, the indicator is configured but not evaluated for records.""" isEnabled: Boolean! """Display name of the indicator.""" name: String! """ When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ nameUseLang: Boolean! """ Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules. This payload conforms to the `FitnessIndicatorSettings` JSON Schema: GET /api/v100/rest/schemas/FitnessIndicatorSettings.json on your region's API host """ settings: FitnessIndicatorSettingsJSONString! """ Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. """ type: FitnessIndicatorTypeEnum! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateEntityFitnessIndicator mutation.""" type UpdateEntityFitnessIndicatorPayload { """The updated record.""" entityFitnessIndicator: EntityFitnessIndicatorEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EntityFitnessIndicator record and the field values to change.""" input UpdateEntityFitnessIndicatorInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Description of what the indicator measures, shown in the UI.""" description: String """ When true, description is treated as a translation key and localized in the UI. """ descriptionUseLang: Boolean """Id of the fitness configuration.""" entityFitnessId: ID """ Suggested remediation text shown to the user when a record triggers this indicator. """ howToFix: String """ When true, howToFix is treated as a translation key and localized in the UI. """ howToFixUseLang: Boolean """When false, the indicator is configured but not evaluated for records.""" isEnabled: Boolean """Display name of the indicator.""" name: String """ When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ nameUseLang: Boolean """ Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules. This payload conforms to the `FitnessIndicatorSettings` JSON Schema: GET /api/v100/rest/schemas/FitnessIndicatorSettings.json on your region's API host """ settings: FitnessIndicatorSettingsJSONString """ Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. """ type: FitnessIndicatorTypeEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateEntityFitnessIndicator mutation.""" type BulkUpdateEntityFitnessIndicatorPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EntityFitnessIndicator record to create, or to update when its id is set. """ input CreateOrUpdateEntityFitnessIndicatorInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Description of what the indicator measures, shown in the UI.""" description: String """ When true, description is treated as a translation key and localized in the UI. """ descriptionUseLang: Boolean """Id of the fitness configuration.""" entityFitnessId: ID """ Suggested remediation text shown to the user when a record triggers this indicator. """ howToFix: String """ When true, howToFix is treated as a translation key and localized in the UI. """ howToFixUseLang: Boolean """When false, the indicator is configured but not evaluated for records.""" isEnabled: Boolean """Display name of the indicator.""" name: String """ When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ nameUseLang: Boolean """ Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules. This payload conforms to the `FitnessIndicatorSettings` JSON Schema: GET /api/v100/rest/schemas/FitnessIndicatorSettings.json on your region's API host """ settings: FitnessIndicatorSettingsJSONString """ Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. """ type: FitnessIndicatorTypeEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the EntityFitnessIndicator record to delete.""" input DeleteEntityFitnessIndicatorInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEntityFitnessIndicator mutation.""" type DeleteEntityFitnessIndicatorPayload { """The deleted record.""" entityFitnessIndicator: EntityFitnessIndicatorEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateEntityHealth mutation.""" type UpdateEntityHealthPayload { """The updated record.""" entityHealth: EntityHealthEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EntityHealth record and the field values to change.""" input UpdateEntityHealthInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When false, health is configured but not evaluated for records of this type. """ isEnabled: Boolean """ Timestamp of the last full health recalculation across all matching records. """ lastRecalculation: DateTime """Id of the account type.""" typeId: ID """Revision when entity was lastly changed.""" revision: Int """ Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry. This payload conforms to the `EntityHealthSettings` JSON Schema: GET /api/v100/rest/schemas/EntityHealthSettings.json on your region's API host """ settings: EntityHealthSettingsJSONString } """ JSON object, sent as a string, conforming to the EntityHealthSettings type. """ scalar EntityHealthSettingsJSONString """Result of the createEntityScoring mutation.""" type CreateEntityScoringPayload { """The created record.""" entityScoring: EntityScoringEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new EntityScoring record.""" input CreateEntityScoringInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Entity whose records the scoring configuration scores; currently only Lead is supported. Set on create and cannot be changed. """ entityType: BaseEntityTypeEnum! """ When false, the scoring configuration is defined but not evaluated for records. """ isEnabled: Boolean! """Name of the entity and its default text representation.""" name: String! """ Entity scoring definition in json format. This payload conforms to the `EntityScoringSettings` JSON Schema: GET /api/v100/rest/schemas/EntityScoringSettings.json on your region's API host """ settings: EntityScoringSettingsJSONString! """ Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches. """ sortOrder: Int! """ When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """ JSON object, sent as a string, conforming to the EntityScoringSettings type. """ scalar EntityScoringSettingsJSONString """Result of the updateEntityScoring mutation.""" type UpdateEntityScoringPayload { """The updated record.""" entityScoring: EntityScoringEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an EntityScoring record and the field values to change.""" input UpdateEntityScoringInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When false, the scoring configuration is defined but not evaluated for records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: String """ Entity scoring definition in json format. This payload conforms to the `EntityScoringSettings` JSON Schema: GET /api/v100/rest/schemas/EntityScoringSettings.json on your region's API host """ settings: EntityScoringSettingsJSONString """ Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches. """ sortOrder: Int """ When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateEntityScoring mutation.""" type BulkUpdateEntityScoringPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an EntityScoring record to create, or to update when its id is set. """ input CreateOrUpdateEntityScoringInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Entity whose records the scoring configuration scores; currently only Lead is supported. Set on create and cannot be changed. """ entityType: BaseEntityTypeEnum """ When false, the scoring configuration is defined but not evaluated for records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: String """ Entity scoring definition in json format. This payload conforms to the `EntityScoringSettings` JSON Schema: GET /api/v100/rest/schemas/EntityScoringSettings.json on your region's API host """ settings: EntityScoringSettingsJSONString """ Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches. """ sortOrder: Int """ When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Id of the EntityScoring record to delete.""" input DeleteEntityScoringInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteEntityScoring mutation.""" type DeleteEntityScoringPayload { """The deleted record.""" entityScoring: EntityScoringEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the deleteField mutation.""" type DeleteFieldPayload { """The deleted record.""" field: FieldEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the deleteField mutation.""" input DeleteDraftFieldInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID } """Result of the createField mutation.""" type CreateFieldPayload { """The created record.""" field: FieldEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the createField mutation.""" input CreateDraftFieldInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ 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. """ entityName: String! """User friendly name for field.""" name: String! """ 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 """ typeId: String! """Optional custom data set id can be set.""" dataSetId: ID """ For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. """ parentOptionsFieldId: ID """Calculated formula used for fields which supports calculation.""" calcFormula: String """ 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. """ defaultValue: String """If this field is allowed in global search.""" useInGlobalSearch: Boolean """ If true, then there will be an API validation if value of entity is unique. """ isUnique: Boolean """ For dropdown, radio, and multiselect-checkbox fields, the set of available options. Empty for other field types. """ dataSet: [FieldDataSetItem!] """ Set at field creation to also create this field on another (related) entity, identified by its entity api name — used to share/map the field across entities. Write-only on create. """ mapDependency: String """Lookup field definition.""" lookup: LookupPropertyParams """ Deprecated - previously returned sequence pattern used for sequence type of field. """ sequencePattern: String """Sequence field definition.""" sequence: SequencePropertyParams """Rollup field definition.""" rollup: RollupPropertyParams """ Type-specific settings of the field, such as the decimal places of a number or the display of a record card; the shape depends on type_id. Empty for types without settings. """ options: FieldOptionsPropertyJSONString """ AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency. """ aiOptions: FieldAiOptionsParams """ Formula of a calculated formula field - the expression, its result type and display - as a JSON object conforming to the `AdvancedFormulaProperty` type; empty for other field types. """ advancedFormula: AdvancedFormulaPropertyParams """ Per-user-role access overrides for this field. Empty when the field uses default access (full access for all roles). """ fieldPermissions: [FieldPermissionNoFieldBackrefInput!] """ Map of locale codes to translated field names (e.g. {"en-US": "First name", "de-DE": "Vorname"}). Empty when no translations are defined. """ nameTranslations: JSONString } """ Option of a dropdown, radio or multiselect field, as set when creating or changing a draft field. """ input FieldDataSetItem { """Id of an existing option to change; leave empty to add a new option.""" id: UUID """ Label of the option shown to users; translations go in optionNameTranslations. """ optionName: String! """ Map of locale codes to translated option names (e.g. {"en-US": "Hot"}). """ optionNameTranslations: JSONString """Numeric value of the option, used in calculation formulas.""" calcValue: Float! """ For dependent fields, the values of the parent field this option is available for. """ allowedBy: [ID] } """ Definition of a lookup field: the entity it links to, which records can be selected and the tab that shows the linked records. """ input LookupPropertyParams { """ Entity the lookup field links to; CustomEntity for a custom entity (see entityApiName). """ entityType: LookupEntityTypeEnum """Name of the tab that shows the records linked through this field.""" tabName: String! """Condition limiting which records can be selected in the field.""" filter: FieldFilterParams """ When true, the field offers only records related to the record being edited (e.g. the contacts of its account). Allowed only from Account (to Account, Contact, Opportunity, Task, Appointment), Contact, Project (to Opportunity, Task, Appointment), Lead / Opportunity (to Task, Appointment), Quote (to Opportunity, Account, Contact, Task, Appointment) and a custom entity (to Account, Contact, Task, Appointment, Project, Quote); any entity may target a custom entity. Elsewhere it must be false. """ showRelated: Boolean! """ API name of the linked custom entity when entityType is CustomEntity; null otherwise. """ entityApiName: String """ Id of the matching lookup field on the linked entity, which shows the same links from the other side. Set by the server; ignored on input. """ oppositeLookupFieldId: UUID """ When true, one of the linked records can be marked as primary. Cannot be switched back to false once enabled. """ hasPrimaryRelation: Boolean = false } """ Automatic numbering of a sequence field: a default numbering sequence and conditional ones chosen by record filters. """ input SequencePropertyParams { """Sequence used for records that match none of the `items`.""" defaultItem: SequenceItemPropertyParams! """ Conditional sequences, checked in order; a record is numbered by the first one whose filter it matches. """ items: [SequenceItemPropertyParams!]! } """ One numbering sequence of a sequence field: its number pattern, the records it numbers and the last number it issued. """ input SequenceItemPropertyParams { """Id of the sequence; empty for a new sequence.""" id: ID """ Pattern template used to generate auto-numbered values (e.g. "{prefix}{year}-{####}"). """ pattern: String! """ Conditions a record must meet to be numbered by this sequence; empty matches every record. """ filter: FieldFilterParams """Last number issued by the sequence and its period. Read-only.""" lastParticle: SequenceParticlePropertyParams } """ Last number issued by a numbering sequence of a sequence field, with the year and month of its numbering period. """ input SequenceParticlePropertyParams { """Year of the numbering period; 0 when the pattern has no year.""" year: Int! """Month of the numbering period; 0 when the pattern has no month.""" month: Int! """Last number issued in the period.""" sequenceNumber: Int! } """ Definition of a rollup field: which related records it aggregates and with which function. """ input RollupPropertyParams { """ Relation the rollup follows to reach the related records: the name of an entity relation, or the id of the lookup field on the source entity for a custom relation. """ entityRelationId: ID """Entity kind whose related records are aggregated by this rollup.""" targetEntity: EntityNameEnum! """ API name of the target custom entity, set when targetEntity is a custom entity. """ entityApiName: String """ How related values are combined — Count, Average, Sum, First, Last, Min or Max. """ aggregationFunction: RollupFieldAggregationFunctionEnum! """ Id of the field whose values are aggregated; null for Count, and for First and Last when the whole related record is returned. """ fieldId: ID """Field-condition filter selecting which related records are aggregated.""" filter: FieldFilterParams """ Id of the field the related records are sorted by to pick the First or Last one. """ sortFieldId: ID } """ JSON object, sent as a string, conforming to the FieldOptionsProperty type. """ scalar FieldOptionsPropertyJSONString """ AI Smart Field settings of a field: whether AI generates its value, from which data and when. """ input FieldAiOptionsParams { """ When true, the field is an AI Smart Field whose value is generated by AI. """ isEnabled: Boolean! """ What the AI uses to generate the value: the prompt and the data sources. """ general: FieldAiGeneralOptionsParams! """When the AI value is generated or updated.""" valueUpdate: FieldAiValueUpdateOptionsParams! } """ What the AI uses to generate the value of an AI Smart Field: the prompt and the enabled data sources. """ input FieldAiGeneralOptionsParams { """ Instruction the AI follows to generate the field value; it can contain placeholders for values of the record. """ prompt: String! """ When true, the AI can use the data sources enabled below (web search, record data, related records and documents); when false, it uses none of them. """ dataSourcesEnabled: Boolean! """When true (and dataSourcesEnabled), the AI can search the web.""" webSearchEnabled: Boolean! """ When true (and dataSourcesEnabled), the AI receives the field values of the record. """ recordDataEnabled: Boolean! """ When true (and dataSourcesEnabled), the AI receives the related records listed in relatedRecords. """ relatedRecordsEnabled: Boolean! """Kinds of related records the AI receives, one item per kind.""" relatedRecords: [FieldAiOptionsRelatedRecordParams!]! """ When true (and dataSourcesEnabled), the AI receives the documents attached to the record. """ recordDocumentsEnabled: Boolean! """ Condition selecting which attached documents the AI receives; all when not set. """ recordDocumentsFilter: FieldFilterParams } """ Kind of related records the AI receives when it generates the value of an AI Smart Field. """ input FieldAiOptionsRelatedRecordParams { """ Entity of the related records; CustomEntity for a custom entity (see targetEntityApiName). """ targetEntity: EntityNameEnum! """ API name of the custom entity when targetEntity is CustomEntity; null otherwise. """ targetEntityApiName: String """ Id of the relation that links the record to these related records: a system entity relation or a lookup field. """ entityRelationId: ID """ Condition selecting which related records the AI receives; all when not set. """ filter: FieldFilterParams } """When the value of an AI Smart Field is generated or updated.""" input FieldAiValueUpdateOptionsParams { """When true, users can request a new AI value for a record manually.""" manualEnabled: Boolean! """When true, the AI value is generated when a record is created.""" autoUpdateOnRecordCreate: Boolean! """ When true, the AI value is generated again whenever a record is updated. """ autoUpdateOnRecordUpdate: Boolean! """ When true, the AI values are generated again on the schedule in autoUpdateSchedule. """ autoUpdateScheduled: Boolean! """ Schedule of the periodic update; used when autoUpdateScheduled is true. """ autoUpdateSchedule: FieldAiValueUpdateScheduleParams """ Condition limiting which records the scheduled update processes; all records of the entity when not set. Each generated value consumes AI credits. """ autoUpdateScheduledFilter: FieldFilterParams } """Schedule of the periodic update of AI Smart Field values.""" input FieldAiValueUpdateScheduleParams { """ Date and time the schedule runs once. Set for a one-time schedule; left empty for recurring schedules that use the time-of-day and day fields instead. """ date: DateTime """ Time of day a recurring schedule runs, in minutes after midnight (0 to 1439). """ timeOfDay: Int """Weekdays a weekly schedule runs on, from 1 (Monday) to 7 (Sunday).""" dayOfWeek: [Int!] """Days of the month a monthly schedule runs on, from 1 to 31.""" dayOfMonth: [Int!] } """ Definition of an advanced formula field: the formula, the type of its result and how the result is displayed. """ input AdvancedFormulaPropertyParams { """ Expression evaluated to produce the field value, referencing other fields by id. """ formula: String! """ Result type of the formula — integer, float, currency, string, date, datetime or bool. """ type: AdvancedFormulaTypeEnum! """ How a numeric result is formatted — Number, Percentage, Days, Months, Years or Custom (uses displayOptionCustomValue as a suffix). """ displayOption: AdvancedFormulaDisplayOptionEnum """Custom suffix appended to the result when displayOption is Custom.""" displayOptionCustomValue: String """Number of decimal places a numeric result is rounded to for display.""" decimalPlaces: Int } """ Access level a user role gets to a draft field, overriding the default access. """ input FieldPermissionNoFieldBackrefInput { """Id of the user role the access override applies to.""" masterRightId: UUID! """Access the user role gets to the field.""" permissionLevel: AccessLevelFieldEnum! } """Result of the updateField mutation.""" type UpdateFieldPayload { """The updated record.""" field: FieldEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the updateField mutation.""" input UpdateDraftFieldInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """True when the field is marked as deleted (soft-delete).""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """User friendly name for field.""" name: String """ When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown. """ useLang: Int """ For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. """ parentOptionsFieldId: ID """Calculated formula used for fields which supports calculation.""" calcFormula: String """ 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. """ defaultValue: String """If this field is allowed in global search.""" useInGlobalSearch: Boolean """ For dropdown, radio, and multiselect-checkbox fields, the set of available options. Empty for other field types. """ dataSet: [FieldDataSetItem!] """Lookup field definition.""" lookup: LookupPropertyParams """Sequence field definition.""" sequence: SequencePropertyParams """Rollup field definition.""" rollup: RollupPropertyParams """ Type-specific settings of the field, such as the decimal places of a number or the display of a record card; the shape depends on type_id. Empty for types without settings. """ options: FieldOptionsPropertyJSONString """ AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency. """ aiOptions: FieldAiOptionsParams """ Formula of a calculated formula field - the expression, its result type and display - as a JSON object conforming to the `AdvancedFormulaProperty` type; empty for other field types. """ advancedFormula: AdvancedFormulaPropertyParams """ Per-user-role access overrides for this field. Empty when the field uses default access (full access for all roles). """ fieldPermissions: [FieldPermissionNoFieldBackrefInput!] """ Map of locale codes to translated field names (e.g. {"en-US": "First name", "de-DE": "Vorname"}). Empty when no translations are defined. """ nameTranslations: JSONString } """Result of the createFieldMapping mutation.""" type CreateFieldMappingPayload { """The created record.""" fieldMapping: FieldMappingEntity } """Field values of a new FieldMapping record.""" input CreateFieldMappingInput { """ Entity of the source records (e.g. Lead); CustomEntity for a custom entity identified by sourceEntityApiName. """ sourceEntityName: EntityNameEnum! """ API name of the source custom entity; set it when sourceEntityName is CustomEntity. """ sourceEntityApiName: String """ Entity of the records the mapping pre-fills (e.g. Opportunity); CustomEntity for a custom entity identified by targetEntityApiName. """ targetEntityName: EntityNameEnum! """ API name of the target custom entity; set it when targetEntityName is CustomEntity. """ targetEntityApiName: String """ Situation in which the mapping applies; only Default and Conversion mappings can be created. Default when not set. """ operation: FieldMappingOperationTypeEnum } """Result of the updateFieldMapping mutation.""" type UpdateFieldMappingPayload { """The updated record.""" fieldMapping: FieldMappingEntity } """Id of a FieldMapping record and the field values to change.""" input UpdateFieldMappingInput { """Id of the field mapping to update.""" id: UUID! """ Default field-to-field mapping, applied when no per-type mapping matches. A field can appear only once in its operations. """ mapping: FieldMappingTemplateParams """ Per-type-pair field mappings: each binds source and target type ids to the mapping applied when both types match. A field can appear only once in the operations of each mapping. """ typeMappings: [EntityTypeFieldMappingParams!] } """ Field-to-field mapping of a field mapping: default values and per-field operations for the target record. """ input FieldMappingTemplateParams { """ JSON object holding the default field values for the target record, keyed by field id. """ input: JSONString! """ Per-field operations that derive each target field value from the source record or a value mapping. """ operations: [FieldMappingOperationParams]! } """How one field of the target record is filled by a field mapping.""" input FieldMappingOperationParams { """Id of the target field this operation populates.""" fieldId: ID! """ How the target field value is produced — Custom (from a mapping) or SourceRecordValue (copied from the source record). """ operation: FieldMappingOperationEnum """ Id of the source-record field whose value is used when the operation reads from the source record. """ triggeredRecordFieldId: UUID """Source-to-target value translations applied to the field value.""" mapping: EntityOperationMappingParams } """ Translation of values when a field value is copied to another field, such as from one dropdown option to another. """ input EntityOperationMappingParams { """Source-to-target value translations applied when copying the field.""" options: [EntityOperationMappingOptionParams] } """One translation of a source value to a target value.""" input EntityOperationMappingOptionParams { """Value on the source field that this option maps from.""" sourceValue: String! """Value the source value is translated to on the target field.""" targetValue: String } """ Field mapping that applies to specific record types of the source and target records. """ input EntityTypeFieldMappingParams { """Source entity-type ids this mapping applies to.""" sourceTypeIds: [ID!] """Target entity-type ids this mapping applies to.""" targetTypeIds: [ID!] """ Field-to-field mapping used when both the source and target types match. """ mapping: FieldMappingTemplateParams } """Result of the bulkUpdateFieldMapping mutation.""" type BulkUpdateFieldMappingPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a FieldMapping record to create, or to update when its id is set. """ input CreateOrUpdateFieldMappingInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ True when the mapping is shipped by the platform and cannot be deleted by the user. """ isSystem: Boolean """ Default field-to-field mapping template applied when no per-type-pair mapping matches. """ mapping: FieldMappingTemplateJSONString """ Situation in which the mapping pre-fills a new target record from a source record, such as qualifying a lead into an opportunity or creating a follow-up activity. """ operation: FieldMappingOperationTypeEnum """ Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match. """ typeMappings: [EntityTypeFieldMappingJSONString!] """Revision when entity was lastly changed.""" revision: Int """Files attached to the mapping (e.g. import source files).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """ JSON object, sent as a string, conforming to the FieldMappingTemplate type. """ scalar FieldMappingTemplateJSONString """ JSON object, sent as a string, conforming to the EntityTypeFieldMapping type. """ scalar EntityTypeFieldMappingJSONString """Id of the FieldMapping record to delete.""" input DeleteFieldMappingInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteFieldMapping mutation.""" type DeleteFieldMappingPayload { """The deleted record.""" fieldMapping: FieldMappingEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createForecast mutation.""" type CreateForecastPayload { """The created record.""" forecast: ForecastEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Forecast record.""" input CreateForecastInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown alongside the forecast.""" description: String """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/b/#BetterForecastSchema This payload conforms to the `BetterForecastSchema` JSON Schema: GET /api/v100/rest/schemas/BetterForecastSchema.json on your region's API host """ settings: JSONString! """ Who besides the owner can access the forecast. Updating it to AllEdit shares the forecast with the users and sales units it covers (see sharedClients and sharedUnits) and stores the mode as Standard. """ shareMode: ShareModeEnum """ Legacy additional sharing options; kept with the record but no longer applied. """ shareModeParams: Int """Revision when entity was lastly changed.""" revision: Int """Users granted shared access to this forecast (custom share mode).""" sharedClients: [UUID!]! """ Sales units granted shared access to this forecast (custom share mode). """ sharedUnits: [UUID!]! } """Result of the updateForecast mutation.""" type UpdateForecastPayload { """The updated record.""" forecast: ForecastEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Forecast record and the field values to change.""" input UpdateForecastInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown alongside the forecast.""" description: String """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/b/#BetterForecastSchema This payload conforms to the `BetterForecastSchema` JSON Schema: GET /api/v100/rest/schemas/BetterForecastSchema.json on your region's API host """ settings: JSONString """ Who besides the owner can access the forecast. Updating it to AllEdit shares the forecast with the users and sales units it covers (see sharedClients and sharedUnits) and stores the mode as Standard. """ shareMode: ShareModeEnum """ Legacy additional sharing options; kept with the record but no longer applied. """ shareModeParams: Int """Revision when entity was lastly changed.""" revision: Int """Users granted shared access to this forecast (custom share mode).""" sharedClients: [UUID!] """ Sales units granted shared access to this forecast (custom share mode). """ sharedUnits: [UUID!] } """Result of the bulkUpdateForecast mutation.""" type BulkUpdateForecastPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Forecast record to create, or to update when its id is set. """ input CreateOrUpdateForecastInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown alongside the forecast.""" description: String """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/b/#BetterForecastSchema This payload conforms to the `BetterForecastSchema` JSON Schema: GET /api/v100/rest/schemas/BetterForecastSchema.json on your region's API host """ settings: JSONString """ Who besides the owner can access the forecast. Updating it to AllEdit shares the forecast with the users and sales units it covers (see sharedClients and sharedUnits) and stores the mode as Standard. """ shareMode: ShareModeEnum """ Legacy additional sharing options; kept with the record but no longer applied. """ shareModeParams: Int """Revision when entity was lastly changed.""" revision: Int """Users granted shared access to this forecast (custom share mode).""" sharedClients: [UUID!] """ Sales units granted shared access to this forecast (custom share mode). """ sharedUnits: [UUID!] } """Id of the Forecast record to delete.""" input DeleteForecastInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteForecast mutation.""" type DeleteForecastPayload { """The deleted record.""" forecast: ForecastEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createFormView mutation.""" type CreateFormViewPayload { """The created record.""" formView: FormViewEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new FormView record.""" input CreateFormViewInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the account type the form view applies to. Set when the form view targets accounts. """ accountTypeId: ID """ Id of the contact type the form view applies to. Set when the form view targets contacts. """ contactTypeId: ID """Ids of fields and webresources hidden from the form for this view.""" hiddenItemIds: [UUID!]! """ Per-item color overrides for fields and webresources in the form, keyed by item id. """ itemColors: [FormViewItemColorInput!]! """ Id of the lead type the form view applies to. Set when the form view targets leads. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String! """Id of the opportunity type.""" opptyTypeId: ID """Id of the owning user.""" ownerId: ID! """ 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). """ shareMode: ShareModeEnum """ When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this form view (custom share mode). """ sharingUnits: [CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput!] """ Users that have been granted shared access to this form view (custom share mode). """ sharingClients: [CreateFormViewSharingClientRelationNoFormViewBackrefInput!] } """Color of one field or web resource on a form view.""" input FormViewItemColorInput { """Id of the form item (field or web resource) the color applies to.""" id: UUID! """Color of the item, as a packed RGB integer.""" color: Int! } """ Field values of a new FormViewSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new FormViewSharingClientRelation record, created together with the record it belongs to. """ input CreateFormViewSharingClientRelationNoFormViewBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateFormView mutation.""" type UpdateFormViewPayload { """The updated record.""" formView: FormViewEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a FormView record and the field values to change.""" input UpdateFormViewInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the account type the form view applies to. Set when the form view targets accounts. """ accountTypeId: ID """ Id of the contact type the form view applies to. Set when the form view targets contacts. """ contactTypeId: ID """Ids of fields and webresources hidden from the form for this view.""" hiddenItemIds: [UUID!] """ Per-item color overrides for fields and webresources in the form, keyed by item id. """ itemColors: [FormViewItemColorInput!] """ Id of the lead type the form view applies to. Set when the form view targets leads. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String """Id of the opportunity type.""" opptyTypeId: ID """Id of the owning user.""" ownerId: ID """ 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). """ shareMode: ShareModeEnum """ When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this form view (custom share mode). """ sharingUnits: [CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput!] """ Users that have been granted shared access to this form view (custom share mode). """ sharingClients: [CreateFormViewSharingClientRelationNoFormViewBackrefInput!] } """Result of the bulkUpdateFormView mutation.""" type BulkUpdateFormViewPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a FormView record to create, or to update when its id is set. """ input CreateOrUpdateFormViewInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the account type the form view applies to. Set when the form view targets accounts. """ accountTypeId: ID """ Id of the contact type the form view applies to. Set when the form view targets contacts. """ contactTypeId: ID """Ids of fields and webresources hidden from the form for this view.""" hiddenItemIds: [UUID!] """ Per-item color overrides for fields and webresources in the form, keyed by item id. """ itemColors: [FormViewItemColorInput!] """ Id of the lead type the form view applies to. Set when the form view targets leads. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String """Id of the opportunity type.""" opptyTypeId: ID """Id of the owning user.""" ownerId: ID """ 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). """ shareMode: ShareModeEnum """ When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this form view (custom share mode). """ sharingUnits: [CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput!] """ Users that have been granted shared access to this form view (custom share mode). """ sharingClients: [CreateFormViewSharingClientRelationNoFormViewBackrefInput!] } """Id of the FormView record to delete.""" input DeleteFormViewInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteFormView mutation.""" type DeleteFormViewPayload { """The deleted record.""" formView: FormViewEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createFormViewSharingClientRelation mutation.""" type CreateFormViewSharingClientRelationPayload { """The created record.""" formViewSharingClientRelation: FormViewSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new FormViewSharingClientRelation record.""" input CreateFormViewSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the shared form view.""" formViewId: ID! """ Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateFormViewSharingClientRelation mutation.""" type UpdateFormViewSharingClientRelationPayload { """The updated record.""" formViewSharingClientRelation: FormViewSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a FormViewSharingClientRelation record and the field values to change. """ input UpdateFormViewSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared form view.""" formViewId: ID """ Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateFormViewSharingClientRelation mutation.""" type BulkUpdateFormViewSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a FormViewSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateFormViewSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared form view.""" formViewId: ID """ Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the FormViewSharingClientRelation record to delete.""" input DeleteFormViewSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteFormViewSharingClientRelation mutation.""" type DeleteFormViewSharingClientRelationPayload { """The deleted record.""" formViewSharingClientRelation: FormViewSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createFormViewSharingSalesUnitRelation mutation.""" type CreateFormViewSharingSalesUnitRelationPayload { """The created record.""" formViewSharingSalesUnitRelation: FormViewSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new FormViewSharingSalesUnitRelation record.""" input CreateFormViewSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared form view.""" formViewId: ID! """ Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateFormViewSharingSalesUnitRelation mutation.""" type UpdateFormViewSharingSalesUnitRelationPayload { """The updated record.""" formViewSharingSalesUnitRelation: FormViewSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a FormViewSharingSalesUnitRelation record and the field values to change. """ input UpdateFormViewSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared form view.""" formViewId: ID """ Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateFormViewSharingSalesUnitRelation mutation.""" type BulkUpdateFormViewSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a FormViewSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateFormViewSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared form view.""" formViewId: ID """ Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the FormViewSharingSalesUnitRelation record to delete.""" input DeleteFormViewSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteFormViewSharingSalesUnitRelation mutation.""" type DeleteFormViewSharingSalesUnitRelationPayload { """The deleted record.""" formViewSharingSalesUnitRelation: FormViewSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createGhostContact mutation.""" type CreateGhostContactPayload { """The created record.""" ghostContact: GhostContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new GhostContact record.""" input CreateGhostContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """Job title or position of the placeholder contact (org-chart label).""" position: String """Revision when entity was lastly changed.""" revision: Int } """Result of the updateGhostContact mutation.""" type UpdateGhostContactPayload { """The updated record.""" ghostContact: GhostContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a GhostContact record and the field values to change.""" input UpdateGhostContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """Job title or position of the placeholder contact (org-chart label).""" position: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateGhostContact mutation.""" type BulkUpdateGhostContactPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a GhostContact record to create, or to update when its id is set. """ input CreateOrUpdateGhostContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """Job title or position of the placeholder contact (org-chart label).""" position: String """Revision when entity was lastly changed.""" revision: Int } """Id of the GhostContact record to delete.""" input DeleteGhostContactInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteGhostContact mutation.""" type DeleteGhostContactPayload { """The deleted record.""" ghostContact: GhostContactEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createGhostContactAccountAccountRoleRelation mutation.""" type CreateGhostContactAccountAccountRoleRelationPayload { """The created record.""" ghostContactAccountAccountRoleRelation: GhostContactAccountAccountRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new GhostContactAccountAccountRoleRelation record.""" input CreateGhostContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Ghost-contact-on-account placement this role assignment belongs to.""" ghostContactAccountRelation: CreateGhostContactAccountRelationInput! """Id of the account role assigned to the ghost contact.""" accountRoleId: ID! """Id of the ghost-contact-account placement.""" ghostContactAccountRelationId: ID! """Revision when entity was lastly changed.""" revision: Int } """Field values of a new GhostContactAccountRelation record.""" input CreateGhostContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Placeholder ghost contact placed on the account org chart.""" ghostContact: CreateGhostContactInput! """Id of the account whose org chart includes the ghost contact.""" accountId: ID! """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the account org chart.""" ghostContactId: ID! """ True when the ghost contact is rendered as an assistant of its parent in the org chart. """ isAssistant: Boolean """ True when the ghost contact is rendered as a sibling rather than a child in the org chart. """ isSibling: Boolean """Position label shown on the org chart for the ghost contact.""" position: String """Revision when entity was lastly changed.""" revision: Int """Account roles assigned to the ghost contact on this account.""" accountRoles: [CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput!] } """ Field values of a new GhostContactAccountAccountRoleRelation record, created together with the record it belongs to. """ input CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account role assigned to the ghost contact.""" accountRoleId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateGhostContactAccountAccountRoleRelation mutation.""" type UpdateGhostContactAccountAccountRoleRelationPayload { """The updated record.""" ghostContactAccountAccountRoleRelation: GhostContactAccountAccountRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a GhostContactAccountAccountRoleRelation record and the field values to change. """ input UpdateGhostContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Ghost-contact-on-account placement this role assignment belongs to.""" ghostContactAccountRelation: CreateGhostContactAccountRelationInput """Id of the account role assigned to the ghost contact.""" accountRoleId: ID """Id of the ghost-contact-account placement.""" ghostContactAccountRelationId: ID """Revision when entity was lastly changed.""" revision: Int } """ Result of the bulkUpdateGhostContactAccountAccountRoleRelation mutation. """ type BulkUpdateGhostContactAccountAccountRoleRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a GhostContactAccountAccountRoleRelation record to create, or to update when its id is set. """ input CreateOrUpdateGhostContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Ghost-contact-on-account placement this role assignment belongs to.""" ghostContactAccountRelation: CreateGhostContactAccountRelationInput """Id of the account role assigned to the ghost contact.""" accountRoleId: ID """Id of the ghost-contact-account placement.""" ghostContactAccountRelationId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the GhostContactAccountAccountRoleRelation record to delete.""" input DeleteGhostContactAccountAccountRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteGhostContactAccountAccountRoleRelation mutation.""" type DeleteGhostContactAccountAccountRoleRelationPayload { """The deleted record.""" ghostContactAccountAccountRoleRelation: GhostContactAccountAccountRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createGhostContactAccountRelation mutation.""" type CreateGhostContactAccountRelationPayload { """The created record.""" ghostContactAccountRelation: GhostContactAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateGhostContactAccountRelation mutation.""" type UpdateGhostContactAccountRelationPayload { """The updated record.""" ghostContactAccountRelation: GhostContactAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a GhostContactAccountRelation record and the field values to change. """ input UpdateGhostContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Placeholder ghost contact placed on the account org chart.""" ghostContact: CreateGhostContactInput """Id of the account whose org chart includes the ghost contact.""" accountId: ID """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the account org chart.""" ghostContactId: ID """ True when the ghost contact is rendered as an assistant of its parent in the org chart. """ isAssistant: Boolean """ True when the ghost contact is rendered as a sibling rather than a child in the org chart. """ isSibling: Boolean """Position label shown on the org chart for the ghost contact.""" position: String """Revision when entity was lastly changed.""" revision: Int """Account roles assigned to the ghost contact on this account.""" accountRoles: [CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput!] } """Result of the bulkUpdateGhostContactAccountRelation mutation.""" type BulkUpdateGhostContactAccountRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a GhostContactAccountRelation record to create, or to update when its id is set. """ input CreateOrUpdateGhostContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Placeholder ghost contact placed on the account org chart.""" ghostContact: CreateGhostContactInput """Id of the account whose org chart includes the ghost contact.""" accountId: ID """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the account org chart.""" ghostContactId: ID """ True when the ghost contact is rendered as an assistant of its parent in the org chart. """ isAssistant: Boolean """ True when the ghost contact is rendered as a sibling rather than a child in the org chart. """ isSibling: Boolean """Position label shown on the org chart for the ghost contact.""" position: String """Revision when entity was lastly changed.""" revision: Int """Account roles assigned to the ghost contact on this account.""" accountRoles: [CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput!] } """Id of the GhostContactAccountRelation record to delete.""" input DeleteGhostContactAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteGhostContactAccountRelation mutation.""" type DeleteGhostContactAccountRelationPayload { """The deleted record.""" ghostContactAccountRelation: GhostContactAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createGhostLeadOpptyContactRelation mutation.""" type CreateGhostLeadOpptyContactRelationPayload { """The created record.""" ghostLeadOpptyContactRelation: GhostLeadOpptyContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new GhostLeadOpptyContactRelation record.""" input CreateGhostLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Placeholder ghost contact placed on the lead/opportunity org chart.""" ghostContact: CreateGhostContactInput! """Org-chart group the ghost contact belongs to, when grouped.""" leadOpptyContactGroupRelation: CreateLeadOpptyContactGroupRelationInput """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the lead/opportunity org chart.""" ghostContactId: ID! """Id of the parent org-chart group.""" leadOpptyContactGroupRelationId: ID """Id of the linked lead or opportunity.""" leadOpptyId: ID! """ Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the ghost contact on this lead/opportunity.""" salesRoles: [CreateGhostLeadOpptyContactSalesRoleRelationNoGhostLeadOpptyContactRelationBackrefInput!] } """Field values of a new LeadOpptyContactGroupRelation record.""" input CreateLeadOpptyContactGroupRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int! """ Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }. """ groupPosition: JSONString! """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: ID! """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new GhostLeadOpptyContactSalesRoleRelation record, created together with the record it belongs to. """ input CreateGhostLeadOpptyContactSalesRoleRelationNoGhostLeadOpptyContactRelationBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales role assigned to the ghost contact.""" salesRoleId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateGhostLeadOpptyContactRelation mutation.""" type UpdateGhostLeadOpptyContactRelationPayload { """The updated record.""" ghostLeadOpptyContactRelation: GhostLeadOpptyContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a GhostLeadOpptyContactRelation record and the field values to change. """ input UpdateGhostLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Placeholder ghost contact placed on the lead/opportunity org chart.""" ghostContact: CreateGhostContactInput """Org-chart group the ghost contact belongs to, when grouped.""" leadOpptyContactGroupRelation: CreateLeadOpptyContactGroupRelationInput """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the lead/opportunity org chart.""" ghostContactId: ID """Id of the parent org-chart group.""" leadOpptyContactGroupRelationId: ID """Id of the linked lead or opportunity.""" leadOpptyId: ID """ Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the ghost contact on this lead/opportunity.""" salesRoles: [CreateGhostLeadOpptyContactSalesRoleRelationNoGhostLeadOpptyContactRelationBackrefInput!] } """Result of the bulkUpdateGhostLeadOpptyContactRelation mutation.""" type BulkUpdateGhostLeadOpptyContactRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a GhostLeadOpptyContactRelation record to create, or to update when its id is set. """ input CreateOrUpdateGhostLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Placeholder ghost contact placed on the lead/opportunity org chart.""" ghostContact: CreateGhostContactInput """Org-chart group the ghost contact belongs to, when grouped.""" leadOpptyContactGroupRelation: CreateLeadOpptyContactGroupRelationInput """Free-text comment shown on the org-chart node.""" comment: String """Id of the ghost contact placed on the lead/opportunity org chart.""" ghostContactId: ID """Id of the parent org-chart group.""" leadOpptyContactGroupRelationId: ID """Id of the linked lead or opportunity.""" leadOpptyId: ID """ Org-chart layout position of the ghost contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the ghost contact on this lead/opportunity.""" salesRoles: [CreateGhostLeadOpptyContactSalesRoleRelationNoGhostLeadOpptyContactRelationBackrefInput!] } """Id of the GhostLeadOpptyContactRelation record to delete.""" input DeleteGhostLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the linked lead or opportunity.""" leadOpptyId: ID } """Result of the deleteGhostLeadOpptyContactRelation mutation.""" type DeleteGhostLeadOpptyContactRelationPayload { """The deleted record.""" ghostLeadOpptyContactRelation: GhostLeadOpptyContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createGhostLeadOpptyContactSalesRoleRelation mutation.""" type CreateGhostLeadOpptyContactSalesRoleRelationPayload { """The created record.""" ghostLeadOpptyContactSalesRoleRelation: GhostLeadOpptyContactSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new GhostLeadOpptyContactSalesRoleRelation record.""" input CreateGhostLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Ghost-contact-on-lead/opportunity placement this role assignment belongs to. """ ghostLeadOpptyContactRelation: CreateGhostLeadOpptyContactRelationInput! """Id of the ghost-contact-lead/opportunity placement.""" ghostLeadOpptyContactRelationId: ID! """Id of the sales role assigned to the ghost contact.""" salesRoleId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateGhostLeadOpptyContactSalesRoleRelation mutation.""" type UpdateGhostLeadOpptyContactSalesRoleRelationPayload { """The updated record.""" ghostLeadOpptyContactSalesRoleRelation: GhostLeadOpptyContactSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a GhostLeadOpptyContactSalesRoleRelation record and the field values to change. """ input UpdateGhostLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Ghost-contact-on-lead/opportunity placement this role assignment belongs to. """ ghostLeadOpptyContactRelation: CreateGhostLeadOpptyContactRelationInput """Id of the ghost-contact-lead/opportunity placement.""" ghostLeadOpptyContactRelationId: ID """Id of the sales role assigned to the ghost contact.""" salesRoleId: ID """Revision when entity was lastly changed.""" revision: Int } """ Result of the bulkUpdateGhostLeadOpptyContactSalesRoleRelation mutation. """ type BulkUpdateGhostLeadOpptyContactSalesRoleRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a GhostLeadOpptyContactSalesRoleRelation record to create, or to update when its id is set. """ input CreateOrUpdateGhostLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Ghost-contact-on-lead/opportunity placement this role assignment belongs to. """ ghostLeadOpptyContactRelation: CreateGhostLeadOpptyContactRelationInput """Id of the ghost-contact-lead/opportunity placement.""" ghostLeadOpptyContactRelationId: ID """Id of the sales role assigned to the ghost contact.""" salesRoleId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the GhostLeadOpptyContactSalesRoleRelation record to delete.""" input DeleteGhostLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteGhostLeadOpptyContactSalesRoleRelation mutation.""" type DeleteGhostLeadOpptyContactSalesRoleRelationPayload { """The deleted record.""" ghostLeadOpptyContactSalesRoleRelation: GhostLeadOpptyContactSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createImportMappingMask mutation.""" type CreateImportMappingMaskPayload { """The created record.""" importMappingMask: ImportMappingMaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ImportMappingMask record.""" input CreateImportMappingMaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). """ entityApiName: String """ Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. """ entityType: ImportMaskEntityTypeEnum! """ How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. """ mapping: JSONString! """Display name of the mask.""" name: String! """Id of the owning user.""" ownerId: ID! """ Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. """ relationTypes: JSONString """ Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. """ shareMode: ProfileShareMode """Revision when entity was lastly changed.""" revision: Int """ Users granted shared access to this import mapping mask (custom share mode). """ sharingClients: [UUID!] """ Sales units granted shared access to this import mapping mask (custom share mode). """ sharingUnits: [UUID!] } """Result of the updateImportMappingMask mutation.""" type UpdateImportMappingMaskPayload { """The updated record.""" importMappingMask: ImportMappingMaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an ImportMappingMask record and the field values to change.""" input UpdateImportMappingMaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). """ entityApiName: String """ Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. """ entityType: ImportMaskEntityTypeEnum """ How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. """ mapping: JSONString """Display name of the mask.""" name: String """Id of the owning user.""" ownerId: ID """ Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. """ relationTypes: JSONString """ Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. """ shareMode: ProfileShareMode """Revision when entity was lastly changed.""" revision: Int """ Users granted shared access to this import mapping mask (custom share mode). """ sharingClients: [UUID!] """ Sales units granted shared access to this import mapping mask (custom share mode). """ sharingUnits: [UUID!] } """Result of the bulkUpdateImportMappingMask mutation.""" type BulkUpdateImportMappingMaskPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an ImportMappingMask record to create, or to update when its id is set. """ input CreateOrUpdateImportMappingMaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). """ entityApiName: String """ Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. """ entityType: ImportMaskEntityTypeEnum """ How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. """ mapping: JSONString """Display name of the mask.""" name: String """Id of the owning user.""" ownerId: ID """ Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. """ relationTypes: JSONString """ Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. """ shareMode: ProfileShareMode """Revision when entity was lastly changed.""" revision: Int """ Users granted shared access to this import mapping mask (custom share mode). """ sharingClients: [UUID!] """ Sales units granted shared access to this import mapping mask (custom share mode). """ sharingUnits: [UUID!] } """Id of the ImportMappingMask record to delete.""" input DeleteImportMappingMaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteImportMappingMask mutation.""" type DeleteImportMappingMaskPayload { """The deleted record.""" importMappingMask: ImportMappingMaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the releaseOwnershipLead mutation.""" type ReleaseOwnershipLeadPayload { """The released lead.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the releaseOwnershipLead mutation.""" input ReleaseOwnershipLeadInput { """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipLead mutation.""" type ChangeOwnershipLeadPayload { """The record with its new owner.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipLead mutation.""" input ChangeOwnershipLeadInput { """User who becomes the new owner of the record.""" ownerId: ID! """Sales unit the record is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the record as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """ When true, the new owner and sales unit are also applied to the record's open tasks and appointments and its notes. Linked records that cannot be transferred are skipped without failing the mutation. """ transferLinkedRecords: Boolean! """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingLead mutation.""" type ManageSharingLeadPayload { """The record with its updated sharing.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingLead mutation.""" input ManageSharingLeadInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new LeadOpptySharingClientRelation record, created together with the record it belongs to. """ input CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new LeadOpptySharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the changeLabelFlagLead mutation.""" type ChangeLabelFlagLeadPayload { """The updated record.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeLabelFlagLead mutation.""" input ChangeLabelFlagLeadInput { """Marks the record as hot.""" hot: Boolean! """Marks the record as priority.""" priority: Boolean! """Marks the record as stalled.""" stalled: Boolean! """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the restoreLead mutation.""" type RestoreLeadPayload { """The restored record.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreLead mutation.""" input RestoreLeadInput { """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyLead mutation.""" type CopyLeadPayload { """The new lead.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyLead mutation.""" input CopyLeadInput { """ When true, the copy keeps the original name without the copy suffix. Defaults to false. """ skipCopySuffix: Boolean """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the archiveLead mutation.""" type ArchiveLeadPayload { """The archived lead.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the archiveLead mutation.""" input ArchiveLeadInput { """Ids of tasks linked to the lead to mark as completed.""" completeActivityIds: [UUID!] """Text of a memo added to the lead together with the archive.""" memoText: String """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the reactivateLead mutation.""" type ReactivateLeadPayload { """The reactivated lead.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the reactivateLead mutation.""" input ReactivateLeadInput { """Identifier of the LeadEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the qualifyLead mutation.""" type QualifyLeadPayload { """The created opportunity.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the qualifyLead mutation.""" input QualifyLeadInput { """ Id of the lead, the target opportunity step (stepId) and any opportunity field values to set. """ entity: UpdateOpportunityInput! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an Opportunity record and the field values to change.""" input UpdateOpportunityInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the quote currently synchronized with this opportunity, or empty when no quote is active. A quote can be active on only one opportunity at a time. """ activeQuoteId: ID """Expected or actual closing date of the opportunity.""" closingDate: Date """Id of the currency exchange rate list applied to this opportunity.""" currencyExchangeRatesListId: ID """Free-form description of the opportunity.""" description: String """ True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. """ isValueAutoCalculate: Boolean """ User-set colored flag used to highlight the opportunity in lists and reports. """ labelFlag: Int """ Time when an AI-suggested buying center was last applied to this opportunity. """ lastAiBuyingCenterApplied: DateTime """Id of the lead source the opportunity originated from.""" leadSourceId: ID """Name of the entity and its default text representation.""" name: String """Id of the opportunity type.""" opptyTypeId: ID """Id of the opportunity owner.""" ownerId: ID """ Id of the currency used for product line-item prices on this opportunity. """ productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: JSONString """ Free-text company email captured at opportunity creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at opportunity creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at opportunity creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at opportunity creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at opportunity creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. """ ranking: Int """Free-form note explaining why the opportunity was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the opportunity was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the pipeline step.""" stepId: ID """Id of the sales unit.""" unitId: ID """ True when the opportunity has gone through the qualification step at least once. """ wasQualified: Boolean """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. """ value: CurrencyForeignFieldInput """ Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. """ opptyRecurrence: UpdateOpptyRecurrenceNoOpptyBackrefInput """ Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. """ revenueSchedule: UpdateOpptyRevenueScheduleNoIdBackrefInput """ Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when isValueAutoCalculate is true. """ productRelations: [CreateOrUpdateOpptyProductRelationNoBackrefInput!] """ Contacts linked to this opportunity, including their roles and org-chart positions. """ contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!] """ Accounts linked to this opportunity, including the primary-account flag. """ accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!] """Documents linked to this opportunity.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Quotes prepared for this opportunity.""" quoteRelations: [CreateQuoteNoOpptyBackrefInput!] """ Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. """ wonDate: DateTime """ Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. """ lostDate: DateTime """ Sales units that have been granted shared access to this opportunity. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """ Users that have been granted shared access to this opportunity. Editable only when shareMode allows user sharing. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """Tag labels applied to this opportunity.""" tags: [CreateTagRelationNoOpptyBackrefInput!] """Saved view profiles this opportunity currently matches.""" staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!] } """ Amount in a foreign currency and its value in the base currency of the space, as set on create or update. """ input CurrencyForeignFieldInput { """ Value in the base currency of the space. If empty, it is calculated from valueForeign at the current exchange rate. """ baseValue: Float """Id of the currency of valueForeign.""" currencyId: ID! """ Value in the currency set by currencyId. If empty, it is calculated from baseValue at the current exchange rate. """ valueForeign: Float } """ Id of an OpptyRecurrence record and the field values to change, updated together with the record it belongs to. """ input UpdateOpptyRecurrenceNoOpptyBackrefInput { """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: Int """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: ID """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """ Id of an OpptyRevenueSchedule record and the field values to change, updated together with the record it belongs to. """ input UpdateOpptyRevenueScheduleNoIdBackrefInput { """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: Date """Number of periods the opportunity value is split into.""" periodCount: Int """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnum """Date when revenue recognition for the opportunity begins.""" startDate: Date """Revision when entity was lastly changed.""" revision: Int } """ Field values of an OpptyProductRelation record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateOpptyProductRelationNoBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. """ pairedOpptyProductRelation: CreateOpptyProductRelationInput """ Total amount of the line item (price * quantity, with discounts applied). """ amount: Float """Free-form note describing this line item.""" comment: String """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: ID """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: ID """Id of the line-item type.""" opptyProductRelationTypeId: ID """Id of the paired line item.""" pairedOpptyProductRelationId: ID """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: Float """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: ID """Number of product units on this line item.""" quantity: Float """ Identifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote). """ sectionId: ID """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. """ revenueSchedule: UpdateOpptyProductRelationRevenueScheduleNoIdBackrefInput } """ Id of an OpptyProductRelationRevenueSchedule record and the field values to change, updated together with the record it belongs to. """ input UpdateOpptyProductRelationRevenueScheduleNoIdBackrefInput { """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: Date """Number of periods the line-item amount is split into.""" periodCount: Int """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnum """Date when revenue recognition for this product line begins.""" startDate: Date """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new LeadOpptyContactRelation record, created together with the record it belongs to. """ input CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. """ leadOpptyContactGroupRelation: CreateLeadOpptyContactGroupRelationInput """Free-form note describing this contact link.""" comment: String """Id of the contact linked to the lead or opportunity.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: ID """ Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the contact for this lead or opportunity.""" salesRoles: [CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!] } """ Field values of a new LeadOpptyContactSalesRoleRelation record, created together with the record it belongs to. """ input CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the sales role assigned to the contact on this lead or opportunity. """ salesRoleId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new LeadOpptyAccountRelation record, created together with the record it belongs to. """ input CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to the lead or opportunity.""" accountId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new Quote record, created together with the record it belongs to. """ input CreateQuoteNoOpptyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: ID """Free-form description of the quote.""" description: String """Date after which the quote is no longer considered valid.""" expirationDate: Date """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Name of the entity and its default text representation.""" name: String! """Id of the quote owner.""" ownerId: ID! """Id of the currency used for product line-item prices on this quote.""" productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: JSONString """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: String """Id of the quote type that classifies this quote.""" quoteTypeId: ID """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the quote-process step.""" stepId: ID! """Id of the sales unit.""" unitId: ID """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. """ totalAmount: CurrencyForeignFieldInput """ Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to totalAmount. """ productRelations: [CreateOpptyProductRelationNoBackrefInput!] """Contacts linked to this quote.""" contactRelations: [CreateQuoteContactRelationNoQuoteBackrefInput!] """Accounts linked to this quote, including the primary-account flag.""" accountRelations: [CreateQuoteAccountRelationNoQuoteBackrefInput!] """Documents linked to this quote.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ Sales units that have been granted shared access to this quote. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateQuoteSharingSalesUnitRelationNoQuoteBackrefInput!] """ Users that have been granted shared access to this quote. Editable only when shareMode allows user sharing. """ sharingClients: [CreateQuoteSharingClientRelationNoQuoteBackrefInput!] """If quote is set as active in opportunity.""" isActiveInOpportunity: Boolean """Saved view profiles this quote currently matches.""" staticProfiles: [CreateProfileRelationNoQuoteBackrefInput!] """Tag labels applied to this quote.""" tags: [CreateTagRelationNoQuoteBackrefInput!] } """ Field values of a new OpptyProductRelation record, created together with the record it belongs to. """ input CreateOpptyProductRelationNoBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. """ pairedOpptyProductRelation: CreateOpptyProductRelationInput """ Total amount of the line item (price * quantity, with discounts applied). """ amount: Float """Free-form note describing this line item.""" comment: String """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: ID """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: ID """Id of the line-item type.""" opptyProductRelationTypeId: ID """Id of the paired line item.""" pairedOpptyProductRelationId: ID """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: Float """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: ID! """Number of product units on this line item.""" quantity: Float """ Identifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote). """ sectionId: ID """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. """ revenueSchedule: CreateOpptyProductRelationRevenueScheduleNoIdBackrefInput } """ Field values of a new QuoteContactRelation record, created together with the record it belongs to. """ input CreateQuoteContactRelationNoQuoteBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to this quote.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new QuoteAccountRelation record, created together with the record it belongs to. """ input CreateQuoteAccountRelationNoQuoteBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to this quote.""" accountId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new QuoteSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateQuoteSharingSalesUnitRelationNoQuoteBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new QuoteSharingClientRelation record, created together with the record it belongs to. """ input CreateQuoteSharingClientRelationNoQuoteBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ProfileRelation record, created together with the record it belongs to. """ input CreateProfileRelationNoQuoteBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID! """Id of the linked project.""" projectId: ID } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoQuoteBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoOpptyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ProfileRelation record, created together with the record it belongs to. """ input CreateProfileRelationNoLeadOpptyBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the screen profile.""" profileId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID } """Result of the moveLead mutation.""" type MoveLeadPayload { """The moved lead.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the moveLead mutation.""" input MoveLeadInput { """ Id of the lead, the target step (stepId) and any field values to save with the move. """ entity: UpdateLeadInput! """Text of a memo added to the lead together with the move.""" memoText: String """Ids of tasks linked to the lead to mark as completed.""" completeActivityIds: [UUID!] """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Lead record and the field values to change.""" input UpdateLeadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency exchange rate list applied to this lead.""" currencyExchangeRatesListId: ID """Free-form description of the lead.""" description: String """ True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """User-set colored flag used to highlight the lead in lists and reports.""" labelFlag: Int """Time when an AI-suggested buying center was last applied to this lead.""" lastAiBuyingCenterApplied: DateTime """ Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). """ leadSourceId: ID """ Id of the lead type that classifies the lead and drives which form, fields and lead process apply. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String """Id of the lead owner.""" ownerId: ID """ Free-text company email captured at lead creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at lead creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at lead creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at lead creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at lead creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at lead creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. """ ranking: Int """ Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. """ reasonOfCloseDescription: String """ Id of the reason recorded when the lead is archived (lost), or empty when none was given. """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the lead process step.""" stepId: ID """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Contacts linked to this lead, including their roles and org-chart positions. """ contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!] """Accounts linked to this lead, including the primary-account flag.""" accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!] """ Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """ Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """Documents linked to this lead.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Tag labels applied to this lead.""" tags: [CreateTagRelationNoLeadBackrefInput!] """Saved view profiles this lead currently matches.""" staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!] """ Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. """ lostDate: DateTime } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoLeadBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the changeLeadProcess mutation.""" type ChangeLeadProcessPayload { """The updated lead.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeLeadProcess mutation.""" input ChangeLeadProcessInput { """ Id of the lead, the new leadTypeId and stepId, an optional new ownerId or unitId, and any other field values to save. """ entity: UpdateLeadInput! """ Adds the previous owner as an editor of the lead; a private lead becomes shared. """ keepOwnerAsEditor: Boolean! """Gives the new owner the lead's open activities and its notes.""" transferLinkedRecords: Boolean! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLead mutation.""" type CreateLeadPayload { """The created record.""" lead: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Lead record.""" input CreateLeadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency exchange rate list applied to this lead.""" currencyExchangeRatesListId: ID """Free-form description of the lead.""" description: String """ True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """User-set colored flag used to highlight the lead in lists and reports.""" labelFlag: Int """Time when an AI-suggested buying center was last applied to this lead.""" lastAiBuyingCenterApplied: DateTime """ Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). """ leadSourceId: ID """ Id of the lead type that classifies the lead and drives which form, fields and lead process apply. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String! """Id of the lead owner.""" ownerId: ID """ Free-text company email captured at lead creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at lead creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at lead creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at lead creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at lead creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at lead creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. """ ranking: Int """ Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. """ reasonOfCloseDescription: String """ Id of the reason recorded when the lead is archived (lost), or empty when none was given. """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the lead process step.""" stepId: ID """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Contacts linked to this lead, including their roles and org-chart positions. """ contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!] """Accounts linked to this lead, including the primary-account flag.""" accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!] """ Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """ Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """Documents linked to this lead.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Tag labels applied to this lead.""" tags: [CreateTagRelationNoLeadBackrefInput!] """Saved view profiles this lead currently matches.""" staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!] """ Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. """ lostDate: DateTime } """Result of the updateLead mutation.""" type UpdateLeadPayload { """The updated record.""" lead: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkUpdateLead mutation.""" type BulkUpdateLeadPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Lead record to create, or to update when its id is set. """ input CreateOrUpdateLeadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency exchange rate list applied to this lead.""" currencyExchangeRatesListId: ID """Free-form description of the lead.""" description: String """ True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """User-set colored flag used to highlight the lead in lists and reports.""" labelFlag: Int """Time when an AI-suggested buying center was last applied to this lead.""" lastAiBuyingCenterApplied: DateTime """ Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). """ leadSourceId: ID """ Id of the lead type that classifies the lead and drives which form, fields and lead process apply. """ leadTypeId: ID """Name of the entity and its default text representation.""" name: String """Id of the lead owner.""" ownerId: ID """ Free-text company email captured at lead creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at lead creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at lead creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at lead creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at lead creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at lead creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. """ ranking: Int """ Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. """ reasonOfCloseDescription: String """ Id of the reason recorded when the lead is archived (lost), or empty when none was given. """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the lead process step.""" stepId: ID """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Contacts linked to this lead, including their roles and org-chart positions. """ contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!] """Accounts linked to this lead, including the primary-account flag.""" accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!] """ Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """ Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """Documents linked to this lead.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Tag labels applied to this lead.""" tags: [CreateTagRelationNoLeadBackrefInput!] """Saved view profiles this lead currently matches.""" staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!] """ Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. """ lostDate: DateTime } """Id of the Lead record to delete.""" input DeleteLeadInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteLead mutation.""" type DeleteLeadPayload { """The deleted record.""" lead: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkArchiveLead mutation.""" type BulkArchiveLeadPayload { """Ids of the archived leads and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkArchiveLead mutation.""" input BulkArchiveLeadInput { """ Leads to archive: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """Optional field values saved on every archived lead.""" entity: CreateOrUpdateLeadInput = null """Text of a memo added to every archived lead.""" memoText: String = null """Ids of linked tasks to mark as completed.""" completeActivityIds: [UUID!] = null """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkReactivateLead mutation.""" type BulkReactivateLeadPayload { """Ids of the reactivated records and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkReactivateLead mutation.""" input BulkReactivateLeadInput { """ Records to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkQualifyLead mutation.""" type BulkQualifyLeadPayload { """ Ids of the qualified records (the new opportunities keep the lead ids) and the items that failed. """ result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkQualifyLead mutation.""" input BulkQualifyLeadInput { """ Leads to qualify: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ Target opportunity step (stepId) and opportunity field values applied to every lead. """ entity: CreateOrUpdateOpportunityInput! """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of an Opportunity record to create, or to update when its id is set. """ input CreateOrUpdateOpportunityInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the quote currently synchronized with this opportunity, or empty when no quote is active. A quote can be active on only one opportunity at a time. """ activeQuoteId: ID """Expected or actual closing date of the opportunity.""" closingDate: Date """Id of the currency exchange rate list applied to this opportunity.""" currencyExchangeRatesListId: ID """Free-form description of the opportunity.""" description: String """ True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. """ isValueAutoCalculate: Boolean """ User-set colored flag used to highlight the opportunity in lists and reports. """ labelFlag: Int """ Time when an AI-suggested buying center was last applied to this opportunity. """ lastAiBuyingCenterApplied: DateTime """Id of the lead source the opportunity originated from.""" leadSourceId: ID """Name of the entity and its default text representation.""" name: String """Id of the opportunity type.""" opptyTypeId: ID """Id of the opportunity owner.""" ownerId: ID """ Id of the currency used for product line-item prices on this opportunity. """ productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: JSONString """ Free-text company email captured at opportunity creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at opportunity creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at opportunity creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at opportunity creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at opportunity creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. """ ranking: Int """Free-form note explaining why the opportunity was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the opportunity was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the pipeline step.""" stepId: ID """Id of the sales unit.""" unitId: ID """ True when the opportunity has gone through the qualification step at least once. """ wasQualified: Boolean """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. """ value: CurrencyForeignFieldInput """ Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. """ opptyRecurrence: UpdateOpptyRecurrenceNoOpptyBackrefInput """ Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. """ revenueSchedule: UpdateOpptyRevenueScheduleNoIdBackrefInput """ Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when isValueAutoCalculate is true. """ productRelations: [CreateOrUpdateOpptyProductRelationNoBackrefInput!] """ Contacts linked to this opportunity, including their roles and org-chart positions. """ contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!] """ Accounts linked to this opportunity, including the primary-account flag. """ accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!] """Documents linked to this opportunity.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Quotes prepared for this opportunity.""" quoteRelations: [CreateQuoteNoOpptyBackrefInput!] """ Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. """ wonDate: DateTime """ Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. """ lostDate: DateTime """ Sales units that have been granted shared access to this opportunity. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """ Users that have been granted shared access to this opportunity. Editable only when shareMode allows user sharing. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """Tag labels applied to this opportunity.""" tags: [CreateTagRelationNoOpptyBackrefInput!] """Saved view profiles this opportunity currently matches.""" staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!] } """Result of the bulkMoveLead mutation.""" type BulkMoveLeadPayload { """Ids of the moved leads and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkMoveLead mutation.""" input BulkMoveLeadInput { """ Leads to move: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """Target step (stepId) and field values applied to every lead.""" entity: CreateOrUpdateLeadInput! """Text of a memo added to every moved lead.""" memoText: String = null """Ids of linked tasks to mark as completed.""" completeActivityIds: [UUID!] = null """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the convertLead mutation.""" type ConvertLeadPayload { """The created record.""" lead: LeadEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the reactivateLeadOppty mutation.""" type ReactivateLeadOpptyPayload { """The reactivated lead or opportunity.""" result: LeadOpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Either a lead or an opportunity.""" union LeadOpportunityEntity = LeadEntity | OpportunityEntity """Parameters of the reactivateLeadOppty mutation.""" input ReactivateLeadOpptyInput { """Id of the archived lead or opportunity.""" id: UUID! """ New expected closing date of a reactivated opportunity; when empty, the current closing date is kept. Not allowed for a lead. """ closingDate: Date """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptyAccountRelation mutation.""" type CreateLeadOpptyAccountRelationPayload { """The created record.""" leadOpptyAccountRelation: LeadOpptyAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadOpptyAccountRelation record.""" input CreateLeadOpptyAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to the lead or opportunity.""" accountId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateLeadOpptyAccountRelation mutation.""" type UpdateLeadOpptyAccountRelationPayload { """The updated record.""" leadOpptyAccountRelation: LeadOpptyAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a LeadOpptyAccountRelation record and the field values to change. """ input UpdateLeadOpptyAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to the lead or opportunity.""" accountId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateLeadOpptyAccountRelation mutation.""" type BulkUpdateLeadOpptyAccountRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptyAccountRelation record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptyAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to the lead or opportunity.""" accountId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the LeadOpptyAccountRelation record to delete.""" input DeleteLeadOpptyAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID } """Result of the deleteLeadOpptyAccountRelation mutation.""" type DeleteLeadOpptyAccountRelationPayload { """The deleted record.""" leadOpptyAccountRelation: LeadOpptyAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptyContactGroupRelation mutation.""" type CreateLeadOpptyContactGroupRelationPayload { """The created record.""" leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateLeadOpptyContactGroupRelation mutation.""" type UpdateLeadOpptyContactGroupRelationPayload { """The updated record.""" leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a LeadOpptyContactGroupRelation record and the field values to change. """ input UpdateLeadOpptyContactGroupRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """ Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }. """ groupPosition: JSONString """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: ID """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateLeadOpptyContactGroupRelation mutation.""" type BulkUpdateLeadOpptyContactGroupRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptyContactGroupRelation record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptyContactGroupRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """ Org-chart layout of the contact group, as a JSON object {"x": , "y": , "width": , "height": }. """ groupPosition: JSONString """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: ID """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int } """Id of the LeadOpptyContactGroupRelation record to delete.""" input DeleteLeadOpptyContactGroupRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the lead or opportunity the contact group belongs to.""" leadOpptyId: ID } """Result of the deleteLeadOpptyContactGroupRelation mutation.""" type DeleteLeadOpptyContactGroupRelationPayload { """The deleted record.""" leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptyContactRelation mutation.""" type CreateLeadOpptyContactRelationPayload { """The created record.""" leadOpptyContactRelation: LeadOpptyContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadOpptyContactRelation record.""" input CreateLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. """ leadOpptyContactGroupRelation: CreateLeadOpptyContactGroupRelationInput """Free-form note describing this contact link.""" comment: String """Id of the contact linked to the lead or opportunity.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: ID """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID! """ Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the contact for this lead or opportunity.""" salesRoles: [CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!] } """Result of the updateLeadOpptyContactRelation mutation.""" type UpdateLeadOpptyContactRelationPayload { """The updated record.""" leadOpptyContactRelation: LeadOpptyContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a LeadOpptyContactRelation record and the field values to change. """ input UpdateLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. """ leadOpptyContactGroupRelation: CreateLeadOpptyContactGroupRelationInput """Free-form note describing this contact link.""" comment: String """Id of the contact linked to the lead or opportunity.""" contactId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: ID """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID """ Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the contact for this lead or opportunity.""" salesRoles: [CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!] } """Result of the bulkUpdateLeadOpptyContactRelation mutation.""" type BulkUpdateLeadOpptyContactRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptyContactRelation record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. """ leadOpptyContactGroupRelation: CreateLeadOpptyContactGroupRelationInput """Free-form note describing this contact link.""" comment: String """Id of the contact linked to the lead or opportunity.""" contactId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """ Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. """ leadOpptyContactGroupRelationId: ID """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID """ Org-chart layout position of the contact within its group, as a JSON object {"x": , "y": }. """ positionInGroup: JSONString """ Org-chart relationship of the contact within the lead/opportunity hierarchy. """ relationship: OrgRelationshipTypeEnum """Revision when entity was lastly changed.""" revision: Int """Sales roles assigned to the contact for this lead or opportunity.""" salesRoles: [CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!] } """Id of the LeadOpptyContactRelation record to delete.""" input DeleteLeadOpptyContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the lead or opportunity this link belongs to.""" leadOpptyId: ID } """Result of the deleteLeadOpptyContactRelation mutation.""" type DeleteLeadOpptyContactRelationPayload { """The deleted record.""" leadOpptyContactRelation: LeadOpptyContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptyContactSalesRoleRelation mutation.""" type CreateLeadOpptyContactSalesRoleRelationPayload { """The created record.""" leadOpptyContactSalesRoleRelation: LeadOpptyContactSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadOpptyContactSalesRoleRelation record.""" input CreateLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Lead/opportunity-contact link this sales-role assignment belongs to.""" leadOpptyContactRelation: CreateLeadOpptyContactRelationInput """Id of the lead/opportunity-contact link.""" leadOpptyContactRelationId: ID """ Id of the sales role assigned to the contact on this lead or opportunity. """ salesRoleId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateLeadOpptyContactSalesRoleRelation mutation.""" type UpdateLeadOpptyContactSalesRoleRelationPayload { """The updated record.""" leadOpptyContactSalesRoleRelation: LeadOpptyContactSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a LeadOpptyContactSalesRoleRelation record and the field values to change. """ input UpdateLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Lead/opportunity-contact link this sales-role assignment belongs to.""" leadOpptyContactRelation: CreateLeadOpptyContactRelationInput """Id of the lead/opportunity-contact link.""" leadOpptyContactRelationId: ID """ Id of the sales role assigned to the contact on this lead or opportunity. """ salesRoleId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateLeadOpptyContactSalesRoleRelation mutation.""" type BulkUpdateLeadOpptyContactSalesRoleRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptyContactSalesRoleRelation record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Lead/opportunity-contact link this sales-role assignment belongs to.""" leadOpptyContactRelation: CreateLeadOpptyContactRelationInput """Id of the lead/opportunity-contact link.""" leadOpptyContactRelationId: ID """ Id of the sales role assigned to the contact on this lead or opportunity. """ salesRoleId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the LeadOpptyContactSalesRoleRelation record to delete.""" input DeleteLeadOpptyContactSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteLeadOpptyContactSalesRoleRelation mutation.""" type DeleteLeadOpptyContactSalesRoleRelationPayload { """The deleted record.""" leadOpptyContactSalesRoleRelation: LeadOpptyContactSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptyKpi mutation.""" type CreateLeadOpptyKPIPayload { """The created record.""" leadOpptyKpi: LeadOpptyKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadOpptyKPI record.""" input CreateLeadOpptyKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove or LastModified. """ kpi: LeadOpptyKpiEnum! """Id of the lead or opportunity the KPI event relates to.""" leadOpptyId: ID! """Id of the lead/opportunity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateLeadOpptyKpi mutation.""" type UpdateLeadOpptyKPIPayload { """The updated record.""" leadOpptyKpi: LeadOpptyKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a LeadOpptyKPI record and the field values to change.""" input UpdateLeadOpptyKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove or LastModified. """ kpi: LeadOpptyKpiEnum """Id of the lead or opportunity the KPI event relates to.""" leadOpptyId: ID """Id of the lead/opportunity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateLeadOpptyKpi mutation.""" type BulkUpdateLeadOpptyKPIPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptyKPI record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptyKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove or LastModified. """ kpi: LeadOpptyKpiEnum """Id of the lead or opportunity the KPI event relates to.""" leadOpptyId: ID """Id of the lead/opportunity owner at the time of the event.""" ownerId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the LeadOpptyKPI record to delete.""" input DeleteLeadOpptyKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the lead or opportunity the KPI event relates to.""" leadOpptyId: ID } """Result of the deleteLeadOpptyKpi mutation.""" type DeleteLeadOpptyKPIPayload { """The deleted record.""" leadOpptyKpi: LeadOpptyKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptySharingClientRelation mutation.""" type CreateLeadOpptySharingClientRelationPayload { """The created record.""" leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadOpptySharingClientRelation record.""" input CreateLeadOpptySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the lead or opportunity being shared.""" leadOpptyId: ID! """ Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateLeadOpptySharingClientRelation mutation.""" type UpdateLeadOpptySharingClientRelationPayload { """The updated record.""" leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a LeadOpptySharingClientRelation record and the field values to change. """ input UpdateLeadOpptySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the lead or opportunity being shared.""" leadOpptyId: ID """ Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateLeadOpptySharingClientRelation mutation.""" type BulkUpdateLeadOpptySharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptySharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the lead or opportunity being shared.""" leadOpptyId: ID """ Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the LeadOpptySharingClientRelation record to delete.""" input DeleteLeadOpptySharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the lead or opportunity being shared.""" leadOpptyId: ID } """Result of the deleteLeadOpptySharingClientRelation mutation.""" type DeleteLeadOpptySharingClientRelationPayload { """The deleted record.""" leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptySharingSalesUnitRelation mutation.""" type CreateLeadOpptySharingSalesUnitRelationPayload { """The created record.""" leadOpptySharingSalesUnitRelation: LeadOpptySharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadOpptySharingSalesUnitRelation record.""" input CreateLeadOpptySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the lead or opportunity being shared.""" leadOpptyId: ID! """ Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateLeadOpptySharingSalesUnitRelation mutation.""" type UpdateLeadOpptySharingSalesUnitRelationPayload { """The updated record.""" leadOpptySharingSalesUnitRelation: LeadOpptySharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a LeadOpptySharingSalesUnitRelation record and the field values to change. """ input UpdateLeadOpptySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the lead or opportunity being shared.""" leadOpptyId: ID """ Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateLeadOpptySharingSalesUnitRelation mutation.""" type BulkUpdateLeadOpptySharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptySharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the lead or opportunity being shared.""" leadOpptyId: ID """ Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the LeadOpptySharingSalesUnitRelation record to delete.""" input DeleteLeadOpptySharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the lead or opportunity being shared.""" leadOpptyId: ID } """Result of the deleteLeadOpptySharingSalesUnitRelation mutation.""" type DeleteLeadOpptySharingSalesUnitRelationPayload { """The deleted record.""" leadOpptySharingSalesUnitRelation: LeadOpptySharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadOpptyStepCheckListRelation mutation.""" type CreateLeadOpptyStepCheckListRelationPayload { """The created record.""" leadOpptyStepCheckListRelation: LeadOpptyStepCheckListRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadOpptyStepCheckListRelation record.""" input CreateLeadOpptyStepCheckListRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Document linked as evidence for this checklist item.""" cloudObject: CreateCloudObjectInput """Note linked as evidence for this checklist item.""" note: CreateNoteInput """ Id of the appointment or task linked as evidence for this checklist item. """ activityId: ID """Id of the document.""" cloudObjectId: ID """Id of the email linked as evidence for this checklist item.""" emailId: ID """ True when the checklist item has been completed for this lead, opportunity or quote. """ itemChecked: Boolean """ Id of the lead or opportunity, or empty when this completion belongs to a quote. """ leadOpptyId: ID """Id of the note linked as evidence for this checklist item.""" noteId: ID """ Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. """ quoteId: ID """Id of the step checklist item.""" stepChecklistId: ID! """Revision when entity was lastly changed.""" revision: Int } """Field values of a new Note record.""" input CreateNoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the note is attached to.""" accountId: ID """Id of the contact the note is attached to.""" contactId: ID """Id of the custom entity record the note is attached to.""" customEntityId: ID """Id of the lead or opportunity the note is attached to.""" leadOpptyId: ID """Free-form text body of the note (sanitized HTML allowed).""" note: String! """Id of the note author.""" ownerId: ID! """Id of the project the note is attached to.""" projectId: ID """Id of the quote the note is attached to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateLeadOpptyStepCheckListRelation mutation.""" type UpdateLeadOpptyStepCheckListRelationPayload { """The updated record.""" leadOpptyStepCheckListRelation: LeadOpptyStepCheckListRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a LeadOpptyStepCheckListRelation record and the field values to change. """ input UpdateLeadOpptyStepCheckListRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Document linked as evidence for this checklist item.""" cloudObject: CreateCloudObjectInput """Note linked as evidence for this checklist item.""" note: CreateNoteInput """ Id of the appointment or task linked as evidence for this checklist item. """ activityId: ID """Id of the document.""" cloudObjectId: ID """Id of the email linked as evidence for this checklist item.""" emailId: ID """ True when the checklist item has been completed for this lead, opportunity or quote. """ itemChecked: Boolean """ Id of the lead or opportunity, or empty when this completion belongs to a quote. """ leadOpptyId: ID """Id of the note linked as evidence for this checklist item.""" noteId: ID """ Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. """ quoteId: ID """Id of the step checklist item.""" stepChecklistId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateLeadOpptyStepCheckListRelation mutation.""" type BulkUpdateLeadOpptyStepCheckListRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadOpptyStepCheckListRelation record to create, or to update when its id is set. """ input CreateOrUpdateLeadOpptyStepCheckListRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Document linked as evidence for this checklist item.""" cloudObject: CreateCloudObjectInput """Note linked as evidence for this checklist item.""" note: CreateNoteInput """ Id of the appointment or task linked as evidence for this checklist item. """ activityId: ID """Id of the document.""" cloudObjectId: ID """Id of the email linked as evidence for this checklist item.""" emailId: ID """ True when the checklist item has been completed for this lead, opportunity or quote. """ itemChecked: Boolean """ Id of the lead or opportunity, or empty when this completion belongs to a quote. """ leadOpptyId: ID """Id of the note linked as evidence for this checklist item.""" noteId: ID """ Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. """ quoteId: ID """Id of the step checklist item.""" stepChecklistId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the LeadOpptyStepCheckListRelation record to delete.""" input DeleteLeadOpptyStepCheckListRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the appointment or task linked as evidence for this checklist item. """ activityId: ID """ Id of the lead or opportunity, or empty when this completion belongs to a quote. """ leadOpptyId: ID } """Result of the deleteLeadOpptyStepCheckListRelation mutation.""" type DeleteLeadOpptyStepCheckListRelationPayload { """The deleted record.""" leadOpptyStepCheckListRelation: LeadOpptyStepCheckListRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createLeadProcess mutation.""" type CreateLeadProcessPayload { """The created record.""" leadProcess: LeadProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new LeadProcess record.""" input CreateLeadProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """Steps that make up this lead process, in evaluation order.""" steps: [CreateStepNoLeadProcessBackrefInput!]! } """ Field values of a new Step record, created together with the record it belongs to. """ input CreateStepNoLeadProcessBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """Name of the entity and its default text representation.""" name: String! """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """Id of the opportunity pipeline.""" pipelineId: ID """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateStepChecklistNoStepBackrefInput!] } """ Field values of a new CloudObjectStepRelation record, created together with the record it belongs to. """ input CreateCloudObjectStepRelationNoStepBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """File attached to the step.""" cloudObject: CreateCloudObjectInput! """Id of the attached file.""" cloudObjectId: ID """Position of the file within the step's document list.""" sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new StepChecklist record, created together with the record it belongs to. """ input CreateStepChecklistNoStepBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplate: CreateCloudObjectTemplateInput """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: ID """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: StepChecklistDocumentFormatEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: ID """Free-text description shown alongside the checklist item.""" description: String """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: ID """Id of the related field.""" fieldId: ID """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: StepChecklistTypeEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: StepChecklistValidationEnum """Display label of the checklist item.""" label: String """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: Boolean """Id of the related process.""" processId: ID """Id of the recipient field.""" sendEmailFieldId: ID """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: ID """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: ID """ Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. This payload conforms to the `StepChecklistVisibilityFilter` JSON Schema: GET /api/v100/rest/schemas/StepChecklistVisibilityFilter.json on your region's API host """ visibilityCondition: StepChecklistVisibilityFilterJSONString! """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: StepChecklistVisibilityEnum """Revision when entity was lastly changed.""" revision: Int """ Sales roles the checklist item is shown to. Empty means the item is shown to all roles. """ salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!] } """ JSON object, sent as a string, conforming to the StepChecklistVisibilityFilter type. """ scalar StepChecklistVisibilityFilterJSONString """ Field values of a new StepChecklistSalesRoleRelation record, created together with the record it belongs to. """ input CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales role that sees the checklist item.""" salesRoleId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateLeadProcess mutation.""" type UpdateLeadProcessPayload { """The updated record.""" leadProcess: LeadProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a LeadProcess record and the field values to change.""" input UpdateLeadProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """Steps that make up this lead process, in evaluation order.""" steps: [CreateOrUpdateStepNoLeadProcessBackrefInput!] } """ Field values of a Step record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateStepNoLeadProcessBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """Name of the entity and its default text representation.""" name: String """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """Id of the opportunity pipeline.""" pipelineId: ID """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateOrUpdateStepChecklistNoStepBackrefInput!] } """ Field values of a CloudObjectStepRelation record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """File attached to the step.""" cloudObject: CreateCloudObjectInput """Id of the attached file.""" cloudObjectId: ID """Position of the file within the step's document list.""" sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """ Field values of a StepChecklist record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateStepChecklistNoStepBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplate: CreateCloudObjectTemplateInput """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: ID """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: StepChecklistDocumentFormatEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: ID """Free-text description shown alongside the checklist item.""" description: String """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: ID """Id of the related field.""" fieldId: ID """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: StepChecklistTypeEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: StepChecklistValidationEnum """Display label of the checklist item.""" label: String """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: Boolean """Id of the related process.""" processId: ID """Id of the recipient field.""" sendEmailFieldId: ID """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: ID """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: ID """ Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. This payload conforms to the `StepChecklistVisibilityFilter` JSON Schema: GET /api/v100/rest/schemas/StepChecklistVisibilityFilter.json on your region's API host """ visibilityCondition: StepChecklistVisibilityFilterJSONString """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: StepChecklistVisibilityEnum """Revision when entity was lastly changed.""" revision: Int """ Sales roles the checklist item is shown to. Empty means the item is shown to all roles. """ salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!] } """Result of the bulkUpdateLeadProcess mutation.""" type BulkUpdateLeadProcessPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a LeadProcess record to create, or to update when its id is set. """ input CreateOrUpdateLeadProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """Steps that make up this lead process, in evaluation order.""" steps: [CreateOrUpdateStepNoLeadProcessBackrefInput!] } """Id of the LeadProcess record to delete.""" input DeleteLeadProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteLeadProcess mutation.""" type DeleteLeadProcessPayload { """The deleted record.""" leadProcess: LeadProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createMasterRight mutation.""" type CreateMasterRightPayload { """The created record.""" masterRight: MasterRightEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new MasterRight record.""" input CreateMasterRightInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. """ accessAccountRelationTypes: Boolean """ Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. """ accessAccounts: Boolean """ Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. """ accessAiAutomatizer: Boolean """ Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. """ accessAiOnlineForms: Boolean """ Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. """ accessAiRecordDetail: Boolean """ Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. """ accessAiRecordEnrichment: Boolean """ Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. """ accessAiRelationshipCharts: Boolean """ Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. """ accessAiReports: Boolean """ Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. """ accessAiSmartField: Boolean """ Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. """ accessAppointmentScheduler: Boolean """ Allows users with this role to manage appointment schedules of other users. """ accessAppointmentSchedulerManagement: Boolean """ Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. """ accessApprovalProcesses: Boolean """ Allows users with this role to manage approval processes owned by other users. """ accessApprovalProcessesManagement: Boolean """ Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. """ accessApprovals: Boolean """ Allows users with this role to open the Archive screens listing lost, closed and archived records. """ accessArchive: Boolean """Allows users with this role to open the Audit screen.""" accessAudit: Boolean """ Allows users with this role to view the audit log of changes made in the space. """ accessAuditLog: Boolean """ Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. """ accessBottomMenuCustomization: Boolean """ Allows users with this role to update many records at once with bulk update. """ accessBulkUpdate: Boolean """ Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. """ accessCalling: Boolean """ Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessCallingCompanyPhone: AccessLevelCompanyEmailsEnum """ Allows users with this role to purchase and manage company phone numbers for the calling integration. """ accessCallingPurchasePhone: Boolean """ Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). """ accessCompanyEmails: AccessLevelCompanyEmailsEnum """ Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. """ accessContacts: Boolean """ Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. """ accessDocumentManagement: Boolean """ Allows users with this role to manage company documents and folders that are not tied to a record. """ accessDocumentManagementCompany: Boolean """ Allows users with this role to create and edit the document folders used for records. """ accessDocumentManagementRecord: Boolean """ Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. """ accessDuplicateChecker: Boolean """ When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. """ accessEmailNotificationEnforcement: Boolean """ Default email notification preferences applied to users with this role (which events trigger an email and through which channel). """ accessEmailNotificationSettings: NotificationSettingsParams """ Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. """ accessEntityAccount: AccessLevelEntityEnum """Allows users with this role to create copies of existing accounts.""" accessEntityAccountCopy: Boolean """Allows users with this role to delete accounts they can edit.""" accessEntityAccountDelete: Boolean """ Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAccountDirection: AccessDirectionEnum """ Allows users with this role to own private accounts, which are visible only to their owner. """ accessEntityAccountPrivate: Boolean """Allows users with this role to create new tags for accounts.""" accessEntityAccountTagCreate: Boolean """ Whether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected). """ accessEntityAccountTypes: AccessEntityTypesEnum """ Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. """ accessEntityAppointment: AccessLevelEntityEnum """Allows users with this role to delete appointments they can edit.""" accessEntityAppointmentDelete: Boolean """ Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAppointmentDirection: AccessDirectionEnum """Allows users with this role to create new tags for appointments.""" accessEntityAppointmentTagCreate: Boolean """ Whether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected). """ accessEntityAppointmentTypes: AccessEntityTypesEnum """ Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityBetterNavigator: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to delete Navigator screen layouts owned by other users. """ accessEntityBetterNavigatorDeleteNotOwned: Boolean """ Allows users with this role to delete Navigator screen layouts they own. """ accessEntityBetterNavigatorDeleteOwned: Boolean """ Allows users with this role to share their Navigator screen layouts with selected users and sales units. """ accessEntityBetterNavigatorSharingCustom: Boolean """ Allows users with this role to share their Navigator screen layouts with all users of the space. """ accessEntityBetterNavigatorSharingPublic: Boolean """ Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. """ accessEntityContact: AccessLevelEntityEnum """Allows users with this role to create copies of existing contacts.""" accessEntityContactCopy: Boolean """Allows users with this role to delete contacts they can edit.""" accessEntityContactDelete: Boolean """ Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityContactDirection: AccessDirectionEnum """ Allows users with this role to own private contacts, which are visible only to their owner. """ accessEntityContactPrivate: Boolean """Allows users with this role to create new tags for contacts.""" accessEntityContactTagCreate: Boolean """ Whether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected). """ accessEntityContactTypes: AccessEntityTypesEnum """ Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. """ accessEntityDashboard: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete dashboards owned by other users.""" accessEntityDashboardDeleteNotOwned: Boolean """Allows users with this role to delete dashboards they own.""" accessEntityDashboardDeleteOwned: Boolean """ Allows users with this role to share their dashboards with selected users and sales units. """ accessEntityDashboardSharingCustom: Boolean """ Allows users with this role to share their dashboards with all users of the space. """ accessEntityDashboardSharingPublic: Boolean """ Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). The Inbox is not affected. """ accessEntityEmailAccessLevel: EmailAccessLevelEnum """ Allow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default. """ accessEntityEmailAllowed: EmailAccessAllowListParams """ How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). """ accessEntityEmailContentShareMode: ContentShareModeConfigEnum """ Allows users with this role to delete emails they neither own nor sent. """ accessEntityEmailDeleteNotOwned: Boolean """ Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccounts: TernaryConfigEnum """ Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccountsByDomain: TernaryConfigEnum """ Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToContacts: TernaryConfigEnum """ Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityEmailSequence: AccessLevelEmailSequenceEnum """ Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityEmailTemplate: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to create and delete email template folders. """ accessEntityEmailTemplateCreateDeleteFolder: Boolean """ Allows users with this role to delete email templates owned by other users. """ accessEntityEmailTemplateDeleteNotOwned: Boolean """Allows users with this role to delete email templates they own.""" accessEntityEmailTemplateDeleteOwned: Boolean """ Allows users with this role to share their email templates with selected users and sales units. """ accessEntityEmailTemplateSharingCustom: Boolean """ Allows users with this role to share their email templates with all users of the space. """ accessEntityEmailTemplateSharingPublic: Boolean """ Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityForecast: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete forecasts owned by other users.""" accessEntityForecastDeleteNotOwned: Boolean """Allows users with this role to delete forecasts they own.""" accessEntityForecastDeleteOwned: Boolean """Allows users with this role to edit forecasts owned by other users.""" accessEntityForecastEditNotOwned: Boolean """ Allows users with this role to share their forecasts with selected users and sales units. """ accessEntityForecastSharingCustom: Boolean """ Allows users with this role to share their forecasts with all users of the space. """ accessEntityForecastSharingPublic: Boolean """ Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityFormView: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete form views owned by other users.""" accessEntityFormViewDeleteNotOwned: Boolean """Allows users with this role to delete form views they own.""" accessEntityFormViewDeleteOwned: Boolean """ Allows users with this role to share their form views with selected users and sales units. """ accessEntityFormViewSharingCustom: Boolean """ Allows users with this role to share their form views with all users of the space. """ accessEntityFormViewSharingPublic: Boolean """ Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. """ accessEntityLead: AccessLevelEntityEnum """Allows users with this role to create copies of existing leads.""" accessEntityLeadCopy: Boolean """Allows users with this role to delete leads they can edit.""" accessEntityLeadDelete: Boolean """ Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityLeadDirection: AccessDirectionEnum """ Allows users with this role to own private leads, which are visible only to their owner. """ accessEntityLeadPrivate: Boolean """Allows users with this role to create new tags for leads.""" accessEntityLeadTagCreate: Boolean """ Whether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected). """ accessEntityLeadTypes: AccessEntityTypesEnum """ Allows users with this role to create new tags for emails, memos and text messages. """ accessEntityMessageTagCreate: Boolean """ Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. """ accessEntityOppty: AccessLevelEntityEnum """ Allows users with this role to create copies of existing opportunities. """ accessEntityOpptyCopy: Boolean """Allows users with this role to delete opportunities they can edit.""" accessEntityOpptyDelete: Boolean """ Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityOpptyDirection: AccessDirectionEnum """ Allows users with this role to own private opportunities, which are visible only to their owner. """ accessEntityOpptyPrivate: Boolean """Allows users with this role to create new tags for opportunities.""" accessEntityOpptyTagCreate: Boolean """ Which pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). """ accessEntityPipeline: AccessLevelPipelineEnum """ Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityProcess: AccessLevelProcessBuilderEnum """ Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. """ accessEntityProfile: AccessLevelCommonRecordsEnumEnum """ Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.). """ accessEntityProfileDefaultScreenProfiles: ScreensDefaultProfilesParamsParams """ Allows users with this role to delete screen profiles owned by other users. """ accessEntityProfileDeleteNotOwned: Boolean """Allows users with this role to delete screen profiles they own.""" accessEntityProfileDeleteOwned: Boolean """ Allows users with this role to share their screen profiles with selected users and sales units. """ accessEntityProfileSharingCustom: Boolean """ Allows users with this role to share their screen profiles with all users of the space. """ accessEntityProfileSharingPublic: Boolean """ Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. """ accessEntityProject: AccessLevelEntityEnum """Allows users with this role to create copies of existing projects.""" accessEntityProjectCopy: Boolean """Allows users with this role to delete projects they can edit.""" accessEntityProjectDelete: Boolean """ Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityProjectDirection: AccessDirectionEnum """ Allows users with this role to own private projects, which are visible only to their owner. """ accessEntityProjectPrivate: Boolean """Allows users with this role to create new tags for projects.""" accessEntityProjectTagCreate: Boolean """ Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. """ accessEntityQuote: AccessLevelEntityEnum """Allows users with this role to create copies of existing quotes.""" accessEntityQuoteCopy: Boolean """Allows users with this role to delete quotes they can edit.""" accessEntityQuoteDelete: Boolean """ Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityQuoteDirection: AccessDirectionEnum """Allows users with this role to create new tags for quotes.""" accessEntityQuoteTagCreate: Boolean """ Whether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected). """ accessEntityQuoteTypes: AccessEntityTypesEnum """ Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityReport: AccessLevelCommonRecordsEnumEnum """Allows users with this role to create and delete report folders.""" accessEntityReportCreateDeleteFolder: Boolean """Allows users with this role to delete reports owned by other users.""" accessEntityReportDeleteNotOwned: Boolean """Allows users with this role to delete reports they own.""" accessEntityReportDeleteOwned: Boolean """ Allows users with this role to save reports as private, visible only to themselves. """ accessEntityReportPrivate: Boolean """Allows users with this role to schedule reports for regular delivery.""" accessEntityReportScheduleCreate: Boolean """ Allows users with this role to view and manage report schedules of other users. """ accessEntityReportScheduleManagement: Boolean """ Allows users with this role to share their reports with selected users and sales units. """ accessEntityReportSharingCustom: Boolean """ Allows users with this role to share their reports with all users of the space. """ accessEntityReportSharingPublic: Boolean """ Allows users with this role to view and follow solutions, when the feature is enabled for the space. """ accessEntitySolution: Boolean """Allows users with this role to create, edit and delete solutions.""" accessEntitySolutionManagement: Boolean """ Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityTarget: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete targets owned by other users.""" accessEntityTargetDeleteNotOwned: Boolean """Allows users with this role to delete targets they own.""" accessEntityTargetDeleteOwned: Boolean """ Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. """ accessEntityTask: AccessLevelEntityEnum """Allows users with this role to delete tasks they can edit.""" accessEntityTaskDelete: Boolean """ Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityTaskDirection: AccessDirectionEnum """Allows users with this role to create new tags for tasks.""" accessEntityTaskTagCreate: Boolean """ Whether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected). """ accessEntityTaskTypes: AccessEntityTypesEnum """ Allows users with this role to create tasks without an owner (unassigned tasks). """ accessEntityTaskUnassigned: Boolean """Allows users with this role to export records and reports to files.""" accessExport: Boolean """ Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. """ accessFeeds: Boolean """ Allows users with this role to manage currencies and exchange rate lists in Administration. """ accessForeignCurrencies: Boolean """ Allows users with this role to manage fields, forms, record types, tags and translations in Administration. """ accessFormAndFields: Boolean """ Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. """ accessGlobalSettings: Boolean """Allows users with this role to open the Navigator screen.""" accessHomeScreen: Boolean """Allows users with this role to import records from files.""" accessImport: Boolean """ Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. """ accessInsights: Boolean """ Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. """ accessLeads: Boolean """ Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. """ accessOnlineForms: Boolean """ Allows users with this role to edit and delete online forms owned by other users. """ accessOnlineFormsManagement: Boolean """ Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. """ accessOpportunity: Boolean """ Allows users with this role to manage pipelines, lead processes and quote processes in Administration. """ accessPipelineConfiguration: Boolean """Allows users with this role to print records and reports.""" accessPrint: Boolean """ Allows users with this role to manage products, product categories and price lists in Administration. """ accessProductsServices: Boolean """ Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. """ accessProjects: Boolean """ Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. """ accessQuotes: Boolean """Allows users with this role to manage sales roles in Administration.""" accessSalesRoles: Boolean """ Allows users with this role to manage the security settings of the space in Administration. """ accessSecurity: Boolean """Allows users with this role to manage sales units in Administration.""" accessUnits: Boolean """ Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. """ accessUserAndRoles: Boolean """ Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessWhatsAppCompanyPhone: AccessLevelCompanyEmailsEnum """ The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items. Stored as the client sent it; until it is saved once the default list is returned, everything enabled and pinned. The access_* flags of the role are not touched by it: the client sends both. """ bottomMenuLayout: [InterfaceBottomMenuRowParams!] """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """ Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted. """ allowedPipelines: [CreateAllowedPipelineNoMasterRightBackrefInput!] """ Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected. """ allowedLeadTypes: [CreateAllowedLeadTypeNoMasterRightBackrefInput!] """ Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected. """ allowedQuoteTypes: [CreateAllowedQuoteTypeNoMasterRightBackrefInput!] """ Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected. """ allowedAccountTypes: [CreateAllowedAccountTypeNoMasterRightBackrefInput!] """ Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected. """ allowedContactTypes: [CreateAllowedContactTypeNoMasterRightBackrefInput!] """ Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected. """ allowedTaskTypes: [CreateAllowedTaskTypeNoMasterRightBackrefInput!] """ Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. """ allowedAppointmentTypes: [CreateAllowedAppointmentTypeNoMasterRightBackrefInput!] """ Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected. """ allowedCompanyEmails: [CreateAllowedCompanyEmailNoMasterRightBackrefInput!] """ Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected. """ allowedCompanyPhones: [CreateAllowedCompanyPhoneNoMasterRightBackrefInput!] """ Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space. """ customEntities: [CustomEntityMasterRightParams!] } """ Which events a user is notified about, grouped by area such as emails, activities or automations. """ input NotificationSettingsParams { """Notification options for emails.""" Emails: EmailNotificationSettingsParams! """Notification options for accounts and contacts.""" AccountsAndContacts: AccountsAndContactsNotificationSettingsParams! """Notification options for leads and opportunities.""" LeadsAndOpportunities: LeadsAndOpportunitiesNotificationSettingsParams! """Notification options for feed posts.""" Feeds: FeedsNotificationSettingsParams! """Notification options for tasks and appointments.""" Activities: ActivitiesNotificationSettingsParams! """Notification options for WhatsApp messages.""" WhatsApp: TextMessageNotificationSettingsParams """Notification options for calling and text messaging.""" CallingAndMessaging: TextMessageNotificationSettingsParams """Notification options for automations.""" ProcessBuilder: ProcessBuilderNotificationSettingsParams """Notification options for projects.""" Projects: ProjectsNotificationSettingsParams """Notification options for quotes.""" Quotes: QuotesNotificationSettingsParams """Notification options for email sequences.""" EmailSequences: EmailSequencesNotificationSettingsParams """Notification options for approval processes.""" ApprovalProcesses: ApprovalProcessesNotificationSettingsParams """Notification options for online forms.""" OnlineForms: OnlineFormsNotificationSettingsParams """ Notification options per custom entity type. Custom entity types not listed notify about all their events. """ CustomEntities: [CustomEntitiesNotificationSettingParams!]! """ True when an administrator enforces these options for the user, so the user's own choices do not apply. Computed by the server; ignored on input. """ isSettingsEnforced: Boolean! = false } """ Which notifications a user receives about emails: sent and received emails, opens and bounces. """ input EmailNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about emails sent and received.""" LinkedItem: Boolean = true """Notifies when a sent email is opened.""" Tracking: Boolean = true """Notifies when a sent email bounces.""" Bounced: Boolean = true } """Which notifications a user receives about accounts and contacts.""" input AccountsAndContactsNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about owner changes of accounts and contacts and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when an item is linked to an account or contact.""" LinkedItem: Boolean! } """Which notifications a user receives about leads and opportunities.""" input LeadsAndOpportunitiesNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies when an item is linked to a lead or opportunity.""" LinkedItem: Boolean! """ Notifies when a lead or opportunity moves to another step or an opportunity is turned back into a lead. """ Move: Boolean! """ Notifies about owner changes of leads and opportunities and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when a lead is qualified to an opportunity.""" Qualification: Boolean! """Notifies when a lead or opportunity is won, lost or reactivated.""" StatusChange: Boolean! } """ Which notifications a user receives about feed posts and their comments. """ input FeedsNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about new feed posts.""" Create: Boolean! """Notifies about comments on feed posts.""" Comment: Boolean! } """Which notifications a user receives about tasks and appointments.""" input ActivitiesNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about owner changes of tasks and appointments and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """ Notifies when the status of a task or appointment changes or it is canceled. """ StatusChange: Boolean! """Notifies about appointment invitations received, accepted or rejected.""" Invitation: Boolean! """Notifies about comments on tasks and appointments.""" Comment: Boolean! } """ Which notifications a user receives about new text or WhatsApp messages. """ input TextMessageNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about new messages.""" LinkedItem: Boolean = true } """ Which notifications a user receives about warnings and errors of automations. """ input ProcessBuilderNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about warnings raised while the automation or sequence runs.""" Warnings: Boolean! """Notifies about errors raised while the automation or sequence runs.""" Errors: Boolean! } """Which notifications a user receives about projects.""" input ProjectsNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about owner changes of projects and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when the status of a project changes.""" StatusChange: Boolean! """Notifies when an item is linked to a project.""" LinkedItem: Boolean! } """Which notifications a user receives about quotes.""" input QuotesNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies when an item is linked to a quote.""" LinkedItem: Boolean! """Notifies when a quote moves to another step.""" Move: Boolean! """ Notifies about owner changes of quotes and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when a quote is won, lost or reactivated.""" StatusChange: Boolean! } """ Which notifications a user receives about warnings and errors of email sequences. """ input EmailSequencesNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about warnings raised while the automation or sequence runs.""" Warnings: Boolean! """Notifies about errors raised while the automation or sequence runs.""" Errors: Boolean! } """ Which notifications a user receives about approval requests, their responses, and approval process warnings and errors. """ input ApprovalProcessesNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """ Notifies about approval requests, including delegated requests and requests that found no approver. """ ApprovalRequest: Boolean! """Notifies when an approval request is approved or rejected.""" ApprovalResponse: Boolean! """Notifies about warnings raised while an approval process runs.""" ApprovalProcessWarning: Boolean """Notifies about errors raised while an approval process runs.""" ApprovalProcessError: Boolean } """ Which notifications a user receives about online form responses and the warnings and errors raised while they are processed. """ input OnlineFormsNotificationSettingsParams { """ Turns all notifications of this group on or off; when false, the other options of the group are ignored. """ IsActive: Boolean! """Notifies about responses submitted through online forms.""" Responses: Boolean! """ Notifies about warnings raised while an online form response is processed. """ Warnings: Boolean! """ Notifies about errors raised while an online form response is processed. """ Errors: Boolean! } """ Which notifications a user receives about the records of one custom entity type. """ input CustomEntitiesNotificationSettingParams { """API name of the custom entity type these options apply to.""" entityApiName: String! """ Turns all notifications of this custom entity type on or off; when false, the other options are ignored. """ IsActive: Boolean! """ Notifies about owner changes of records of this type and about assignments to their sales team as editor or watcher. """ OwnershipAndSalesTeamChange: Boolean! """Notifies when an item is linked to a record of this type.""" LinkedItem: Boolean! } """ Users and sales units whose emails stay visible to users with the role. """ input EmailAccessAllowListParams { """Ids of users whose emails stay visible.""" clientIds: [UUID!]! """Ids of sales units whose Member users' emails stay visible.""" unitIds: [UUID!]! } """ Default profiles (saved views) of the main screens for users with a given role. """ input ScreensDefaultProfilesParamsParams { """ Id of the default profile (saved view) of the original Navigator screen for users with this role. """ Navigator: UUID! """ Id of the default profile (saved view) of the Opportunities screen for users with this role. """ Pipelinescreen: UUID! """ Id of the default profile (saved view) of the Leads screen for users with this role. """ Leadscreen: UUID! """ Id of the default profile (saved view) of the Accounts screen for users with this role. """ Accountscreen: UUID! """ Id of the default profile (saved view) of the Contacts screen for users with this role. """ Contactscreen: UUID! """ Id of the default profile (saved view) of the Activities screen for users with this role. """ Activityscreen: UUID! """ Id of the default profile (saved view) of the Feed screen for users with this role. """ Feedscreen2: UUID! """ Id of the default profile (saved view) of the opportunity archive for users with this role. """ Archivescreen: UUID! """ Id of the default profile (saved view) of the lead archive for users with this role. """ LeadArchivescreen: UUID! = "00000000-0000-0015-0000-000000000000" """ Id of the default profile (saved view) of the Insights overview screen for users with this role. """ Insightsscreen: UUID! """ Id of the default profile (saved view) of the Insights indicators screen for users with this role. """ Indicatorsscreen: UUID! """ Id of the default profile (saved view) of the Insights conversions screen for users with this role. """ Conversionsscreen: UUID! """ Id of the default profile (saved view) of the Insights lifecycle screen for users with this role. """ Lifecyclescreen: UUID! """ Id of the default profile (saved view) of the Projects screen for users with this role. """ Projectscreen: UUID! """ Id of the default profile (saved view) of the Quotes screen for users with this role. """ Quotescreen: UUID! = "00000000-0000-0017-0000-000000000000" """ Id of the default profile (saved view) of the quote archive for users with this role. """ QuoteArchivescreen: UUID! = "00000000-0000-0018-0000-000000000000" """ Id of the default profile (saved view) of the Navigator screen for users with this role. """ BetterNavigatorscreen: UUID! = "00000000-0000-001e-0000-000000000000" } """ Written by hand, not via InterfaceBottomMenuRow.InputObjectType(): the generic converter builds field types eagerly, and the self-referencing `items` list makes it recurse without end. The lazy lambda below is what breaks the cycle. """ input InterfaceBottomMenuRowParams { """The screen of an item row; Section on a group row.""" kind: InterfaceBottomMenuItemKind! """Set on CustomEntity rows.""" entityApiName: String """Default Access of the item in the role; stored as the client sent it.""" isEnabled: Boolean """ Pinned to the bar. On the role's items it equals isEnabled after every role save; on a user's own layout it is what the user chose. """ isPinned: Boolean """ A group's name as the admin typed it, or a translation key (see useLang). """ name: String """ True when name is a translation key the client localizes, as on the default groups Communication, Analytics, Archive and Tools; false when shown as typed. """ useLang: Boolean """A group's icon.""" icon: EntityIconEnum = null """Members of a group row, in submenu order; null on items.""" items: [InterfaceBottomMenuRowParams!] } """ Field values of a new AllowedPipeline record, created together with the record it belongs to. """ input CreateAllowedPipelineNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the user role can access documents attached to steps of this pipeline. """ accessStepDocuments: Boolean """Id of the pipeline the user role can use.""" pipelineId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedLeadType record, created together with the record it belongs to. """ input CreateAllowedLeadTypeNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the lead type the user role can use.""" leadTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedQuoteType record, created together with the record it belongs to. """ input CreateAllowedQuoteTypeNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the quote type the user role can use.""" quoteTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedAccountType record, created together with the record it belongs to. """ input CreateAllowedAccountTypeNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account type the user role can use.""" accountTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedContactType record, created together with the record it belongs to. """ input CreateAllowedContactTypeNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact type the user role can use.""" contactTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedTaskType record, created together with the record it belongs to. """ input CreateAllowedTaskTypeNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the task type the user role can use.""" taskTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedAppointmentType record, created together with the record it belongs to. """ input CreateAllowedAppointmentTypeNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the appointment type the user role can use.""" appointmentTypeId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedCompanyEmail record, created together with the record it belongs to. """ input CreateAllowedCompanyEmailNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the company email address.""" companyEmailId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new AllowedCompanyPhone record, created together with the record it belongs to. """ input CreateAllowedCompanyPhoneNoMasterRightBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the company phone.""" phoneId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Rights of a user role to one custom entity: screen access, record access level and the actions its users may take. """ input CustomEntityMasterRightParams { """API name of the custom entity these settings apply to.""" entityApiName: String! """ Shows the screen of the custom entity to users with this role. Which records they can see and edit is set by accessLevel. """ navigationAccess: Boolean! """ Level of access to records of the custom entity for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the records the role can see. """ accessLevel: AccessLevelEntityEnum! """ Which records of the custom entity users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessDirection: AccessDirectionEnum! """ Allows users with this role to own private records of the custom entity, which are visible only to their owner. """ accessPrivate: Boolean! """ Allows users with this role to delete records of the custom entity they can edit. """ accessDelete: Boolean! """ Whether users with this role can work with all types of the custom entity (All) or only with those in allowedEntityTypeIds (Selected). """ accessEntityTypes: AccessEntityTypesEnum! """ Types of the custom entity this user role can use. Effective only when accessEntityTypes is set to Selected. """ allowedEntityTypeIds: [ID!]! """ Default screen profile (saved screen view) of the custom entity screen for users with this role. """ defaultProfileId: ID! """ Allows users with this role to create copies of existing records of the custom entity. """ accessCopy: Boolean! = true """ Allows users with this role to create new tags for records of the custom entity. """ accessTagCreate: Boolean! = true } """Result of the updateMasterRight mutation.""" type UpdateMasterRightPayload { """The updated record.""" masterRight: MasterRightEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a MasterRight record and the field values to change.""" input UpdateMasterRightInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. """ accessAccountRelationTypes: Boolean """ Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. """ accessAccounts: Boolean """ Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. """ accessAiAutomatizer: Boolean """ Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. """ accessAiOnlineForms: Boolean """ Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. """ accessAiRecordDetail: Boolean """ Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. """ accessAiRecordEnrichment: Boolean """ Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. """ accessAiRelationshipCharts: Boolean """ Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. """ accessAiReports: Boolean """ Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. """ accessAiSmartField: Boolean """ Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. """ accessAppointmentScheduler: Boolean """ Allows users with this role to manage appointment schedules of other users. """ accessAppointmentSchedulerManagement: Boolean """ Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. """ accessApprovalProcesses: Boolean """ Allows users with this role to manage approval processes owned by other users. """ accessApprovalProcessesManagement: Boolean """ Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. """ accessApprovals: Boolean """ Allows users with this role to open the Archive screens listing lost, closed and archived records. """ accessArchive: Boolean """Allows users with this role to open the Audit screen.""" accessAudit: Boolean """ Allows users with this role to view the audit log of changes made in the space. """ accessAuditLog: Boolean """ Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. """ accessBottomMenuCustomization: Boolean """ Allows users with this role to update many records at once with bulk update. """ accessBulkUpdate: Boolean """ Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. """ accessCalling: Boolean """ Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessCallingCompanyPhone: AccessLevelCompanyEmailsEnum """ Allows users with this role to purchase and manage company phone numbers for the calling integration. """ accessCallingPurchasePhone: Boolean """ Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). """ accessCompanyEmails: AccessLevelCompanyEmailsEnum """ Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. """ accessContacts: Boolean """ Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. """ accessDocumentManagement: Boolean """ Allows users with this role to manage company documents and folders that are not tied to a record. """ accessDocumentManagementCompany: Boolean """ Allows users with this role to create and edit the document folders used for records. """ accessDocumentManagementRecord: Boolean """ Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. """ accessDuplicateChecker: Boolean """ When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. """ accessEmailNotificationEnforcement: Boolean """ Default email notification preferences applied to users with this role (which events trigger an email and through which channel). """ accessEmailNotificationSettings: NotificationSettingsParams """ Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. """ accessEntityAccount: AccessLevelEntityEnum """Allows users with this role to create copies of existing accounts.""" accessEntityAccountCopy: Boolean """Allows users with this role to delete accounts they can edit.""" accessEntityAccountDelete: Boolean """ Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAccountDirection: AccessDirectionEnum """ Allows users with this role to own private accounts, which are visible only to their owner. """ accessEntityAccountPrivate: Boolean """Allows users with this role to create new tags for accounts.""" accessEntityAccountTagCreate: Boolean """ Whether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected). """ accessEntityAccountTypes: AccessEntityTypesEnum """ Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. """ accessEntityAppointment: AccessLevelEntityEnum """Allows users with this role to delete appointments they can edit.""" accessEntityAppointmentDelete: Boolean """ Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAppointmentDirection: AccessDirectionEnum """Allows users with this role to create new tags for appointments.""" accessEntityAppointmentTagCreate: Boolean """ Whether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected). """ accessEntityAppointmentTypes: AccessEntityTypesEnum """ Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityBetterNavigator: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to delete Navigator screen layouts owned by other users. """ accessEntityBetterNavigatorDeleteNotOwned: Boolean """ Allows users with this role to delete Navigator screen layouts they own. """ accessEntityBetterNavigatorDeleteOwned: Boolean """ Allows users with this role to share their Navigator screen layouts with selected users and sales units. """ accessEntityBetterNavigatorSharingCustom: Boolean """ Allows users with this role to share their Navigator screen layouts with all users of the space. """ accessEntityBetterNavigatorSharingPublic: Boolean """ Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. """ accessEntityContact: AccessLevelEntityEnum """Allows users with this role to create copies of existing contacts.""" accessEntityContactCopy: Boolean """Allows users with this role to delete contacts they can edit.""" accessEntityContactDelete: Boolean """ Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityContactDirection: AccessDirectionEnum """ Allows users with this role to own private contacts, which are visible only to their owner. """ accessEntityContactPrivate: Boolean """Allows users with this role to create new tags for contacts.""" accessEntityContactTagCreate: Boolean """ Whether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected). """ accessEntityContactTypes: AccessEntityTypesEnum """ Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. """ accessEntityDashboard: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete dashboards owned by other users.""" accessEntityDashboardDeleteNotOwned: Boolean """Allows users with this role to delete dashboards they own.""" accessEntityDashboardDeleteOwned: Boolean """ Allows users with this role to share their dashboards with selected users and sales units. """ accessEntityDashboardSharingCustom: Boolean """ Allows users with this role to share their dashboards with all users of the space. """ accessEntityDashboardSharingPublic: Boolean """ Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). The Inbox is not affected. """ accessEntityEmailAccessLevel: EmailAccessLevelEnum """ Allow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default. """ accessEntityEmailAllowed: EmailAccessAllowListParams """ How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). """ accessEntityEmailContentShareMode: ContentShareModeConfigEnum """ Allows users with this role to delete emails they neither own nor sent. """ accessEntityEmailDeleteNotOwned: Boolean """ Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccounts: TernaryConfigEnum """ Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccountsByDomain: TernaryConfigEnum """ Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToContacts: TernaryConfigEnum """ Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityEmailSequence: AccessLevelEmailSequenceEnum """ Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityEmailTemplate: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to create and delete email template folders. """ accessEntityEmailTemplateCreateDeleteFolder: Boolean """ Allows users with this role to delete email templates owned by other users. """ accessEntityEmailTemplateDeleteNotOwned: Boolean """Allows users with this role to delete email templates they own.""" accessEntityEmailTemplateDeleteOwned: Boolean """ Allows users with this role to share their email templates with selected users and sales units. """ accessEntityEmailTemplateSharingCustom: Boolean """ Allows users with this role to share their email templates with all users of the space. """ accessEntityEmailTemplateSharingPublic: Boolean """ Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityForecast: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete forecasts owned by other users.""" accessEntityForecastDeleteNotOwned: Boolean """Allows users with this role to delete forecasts they own.""" accessEntityForecastDeleteOwned: Boolean """Allows users with this role to edit forecasts owned by other users.""" accessEntityForecastEditNotOwned: Boolean """ Allows users with this role to share their forecasts with selected users and sales units. """ accessEntityForecastSharingCustom: Boolean """ Allows users with this role to share their forecasts with all users of the space. """ accessEntityForecastSharingPublic: Boolean """ Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityFormView: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete form views owned by other users.""" accessEntityFormViewDeleteNotOwned: Boolean """Allows users with this role to delete form views they own.""" accessEntityFormViewDeleteOwned: Boolean """ Allows users with this role to share their form views with selected users and sales units. """ accessEntityFormViewSharingCustom: Boolean """ Allows users with this role to share their form views with all users of the space. """ accessEntityFormViewSharingPublic: Boolean """ Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. """ accessEntityLead: AccessLevelEntityEnum """Allows users with this role to create copies of existing leads.""" accessEntityLeadCopy: Boolean """Allows users with this role to delete leads they can edit.""" accessEntityLeadDelete: Boolean """ Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityLeadDirection: AccessDirectionEnum """ Allows users with this role to own private leads, which are visible only to their owner. """ accessEntityLeadPrivate: Boolean """Allows users with this role to create new tags for leads.""" accessEntityLeadTagCreate: Boolean """ Whether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected). """ accessEntityLeadTypes: AccessEntityTypesEnum """ Allows users with this role to create new tags for emails, memos and text messages. """ accessEntityMessageTagCreate: Boolean """ Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. """ accessEntityOppty: AccessLevelEntityEnum """ Allows users with this role to create copies of existing opportunities. """ accessEntityOpptyCopy: Boolean """Allows users with this role to delete opportunities they can edit.""" accessEntityOpptyDelete: Boolean """ Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityOpptyDirection: AccessDirectionEnum """ Allows users with this role to own private opportunities, which are visible only to their owner. """ accessEntityOpptyPrivate: Boolean """Allows users with this role to create new tags for opportunities.""" accessEntityOpptyTagCreate: Boolean """ Which pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). """ accessEntityPipeline: AccessLevelPipelineEnum """ Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityProcess: AccessLevelProcessBuilderEnum """ Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. """ accessEntityProfile: AccessLevelCommonRecordsEnumEnum """ Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.). """ accessEntityProfileDefaultScreenProfiles: ScreensDefaultProfilesParamsParams """ Allows users with this role to delete screen profiles owned by other users. """ accessEntityProfileDeleteNotOwned: Boolean """Allows users with this role to delete screen profiles they own.""" accessEntityProfileDeleteOwned: Boolean """ Allows users with this role to share their screen profiles with selected users and sales units. """ accessEntityProfileSharingCustom: Boolean """ Allows users with this role to share their screen profiles with all users of the space. """ accessEntityProfileSharingPublic: Boolean """ Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. """ accessEntityProject: AccessLevelEntityEnum """Allows users with this role to create copies of existing projects.""" accessEntityProjectCopy: Boolean """Allows users with this role to delete projects they can edit.""" accessEntityProjectDelete: Boolean """ Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityProjectDirection: AccessDirectionEnum """ Allows users with this role to own private projects, which are visible only to their owner. """ accessEntityProjectPrivate: Boolean """Allows users with this role to create new tags for projects.""" accessEntityProjectTagCreate: Boolean """ Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. """ accessEntityQuote: AccessLevelEntityEnum """Allows users with this role to create copies of existing quotes.""" accessEntityQuoteCopy: Boolean """Allows users with this role to delete quotes they can edit.""" accessEntityQuoteDelete: Boolean """ Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityQuoteDirection: AccessDirectionEnum """Allows users with this role to create new tags for quotes.""" accessEntityQuoteTagCreate: Boolean """ Whether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected). """ accessEntityQuoteTypes: AccessEntityTypesEnum """ Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityReport: AccessLevelCommonRecordsEnumEnum """Allows users with this role to create and delete report folders.""" accessEntityReportCreateDeleteFolder: Boolean """Allows users with this role to delete reports owned by other users.""" accessEntityReportDeleteNotOwned: Boolean """Allows users with this role to delete reports they own.""" accessEntityReportDeleteOwned: Boolean """ Allows users with this role to save reports as private, visible only to themselves. """ accessEntityReportPrivate: Boolean """Allows users with this role to schedule reports for regular delivery.""" accessEntityReportScheduleCreate: Boolean """ Allows users with this role to view and manage report schedules of other users. """ accessEntityReportScheduleManagement: Boolean """ Allows users with this role to share their reports with selected users and sales units. """ accessEntityReportSharingCustom: Boolean """ Allows users with this role to share their reports with all users of the space. """ accessEntityReportSharingPublic: Boolean """ Allows users with this role to view and follow solutions, when the feature is enabled for the space. """ accessEntitySolution: Boolean """Allows users with this role to create, edit and delete solutions.""" accessEntitySolutionManagement: Boolean """ Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityTarget: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete targets owned by other users.""" accessEntityTargetDeleteNotOwned: Boolean """Allows users with this role to delete targets they own.""" accessEntityTargetDeleteOwned: Boolean """ Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. """ accessEntityTask: AccessLevelEntityEnum """Allows users with this role to delete tasks they can edit.""" accessEntityTaskDelete: Boolean """ Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityTaskDirection: AccessDirectionEnum """Allows users with this role to create new tags for tasks.""" accessEntityTaskTagCreate: Boolean """ Whether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected). """ accessEntityTaskTypes: AccessEntityTypesEnum """ Allows users with this role to create tasks without an owner (unassigned tasks). """ accessEntityTaskUnassigned: Boolean """Allows users with this role to export records and reports to files.""" accessExport: Boolean """ Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. """ accessFeeds: Boolean """ Allows users with this role to manage currencies and exchange rate lists in Administration. """ accessForeignCurrencies: Boolean """ Allows users with this role to manage fields, forms, record types, tags and translations in Administration. """ accessFormAndFields: Boolean """ Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. """ accessGlobalSettings: Boolean """Allows users with this role to open the Navigator screen.""" accessHomeScreen: Boolean """Allows users with this role to import records from files.""" accessImport: Boolean """ Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. """ accessInsights: Boolean """ Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. """ accessLeads: Boolean """ Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. """ accessOnlineForms: Boolean """ Allows users with this role to edit and delete online forms owned by other users. """ accessOnlineFormsManagement: Boolean """ Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. """ accessOpportunity: Boolean """ Allows users with this role to manage pipelines, lead processes and quote processes in Administration. """ accessPipelineConfiguration: Boolean """Allows users with this role to print records and reports.""" accessPrint: Boolean """ Allows users with this role to manage products, product categories and price lists in Administration. """ accessProductsServices: Boolean """ Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. """ accessProjects: Boolean """ Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. """ accessQuotes: Boolean """Allows users with this role to manage sales roles in Administration.""" accessSalesRoles: Boolean """ Allows users with this role to manage the security settings of the space in Administration. """ accessSecurity: Boolean """Allows users with this role to manage sales units in Administration.""" accessUnits: Boolean """ Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. """ accessUserAndRoles: Boolean """ Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessWhatsAppCompanyPhone: AccessLevelCompanyEmailsEnum """ The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items. Stored as the client sent it; until it is saved once the default list is returned, everything enabled and pinned. The access_* flags of the role are not touched by it: the client sends both. """ bottomMenuLayout: [InterfaceBottomMenuRowParams!] """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """ Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted. """ allowedPipelines: [CreateAllowedPipelineNoMasterRightBackrefInput!] """ Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected. """ allowedLeadTypes: [CreateAllowedLeadTypeNoMasterRightBackrefInput!] """ Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected. """ allowedQuoteTypes: [CreateAllowedQuoteTypeNoMasterRightBackrefInput!] """ Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected. """ allowedAccountTypes: [CreateAllowedAccountTypeNoMasterRightBackrefInput!] """ Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected. """ allowedContactTypes: [CreateAllowedContactTypeNoMasterRightBackrefInput!] """ Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected. """ allowedTaskTypes: [CreateAllowedTaskTypeNoMasterRightBackrefInput!] """ Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. """ allowedAppointmentTypes: [CreateAllowedAppointmentTypeNoMasterRightBackrefInput!] """ Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected. """ allowedCompanyEmails: [CreateAllowedCompanyEmailNoMasterRightBackrefInput!] """ Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected. """ allowedCompanyPhones: [CreateAllowedCompanyPhoneNoMasterRightBackrefInput!] """ Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space. """ customEntities: [CustomEntityMasterRightParams!] } """Result of the bulkUpdateMasterRight mutation.""" type BulkUpdateMasterRightPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a MasterRight record to create, or to update when its id is set. """ input CreateOrUpdateMasterRightInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration. """ accessAccountRelationTypes: Boolean """ Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by accessEntityAccount. """ accessAccounts: Boolean """ Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space. """ accessAiAutomatizer: Boolean """ Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space. """ accessAiOnlineForms: Boolean """ Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space. """ accessAiRecordDetail: Boolean """ Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space. """ accessAiRecordEnrichment: Boolean """ Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space. """ accessAiRelationshipCharts: Boolean """ Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space. """ accessAiReports: Boolean """ Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space. """ accessAiSmartField: Boolean """ Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role. """ accessAppointmentScheduler: Boolean """ Allows users with this role to manage appointment schedules of other users. """ accessAppointmentSchedulerManagement: Boolean """ Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space. """ accessApprovalProcesses: Boolean """ Allows users with this role to manage approval processes owned by other users. """ accessApprovalProcessesManagement: Boolean """ Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space. """ accessApprovals: Boolean """ Allows users with this role to open the Archive screens listing lost, closed and archived records. """ accessArchive: Boolean """Allows users with this role to open the Audit screen.""" accessAudit: Boolean """ Allows users with this role to view the audit log of changes made in the space. """ accessAuditLog: Boolean """ Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottomMenuLayout; a layout of their own (UISettings.bottomMenuLayout) is still stored but read as null until this is switched on. """ accessBottomMenuCustomization: Boolean """ Allows users with this role to update many records at once with bulk update. """ accessBulkUpdate: Boolean """ Allows users with this role to make calls through the calling integration, when the feature is enabled for the space. """ accessCalling: Boolean """ Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessCallingCompanyPhone: AccessLevelCompanyEmailsEnum """ Allows users with this role to purchase and manage company phone numbers for the calling integration. """ accessCallingPurchasePhone: Boolean """ Which shared company email accounts users with this role can send from: none (NoAccess), those in allowedCompanyEmails (Selected) or all (All). """ accessCompanyEmails: AccessLevelCompanyEmailsEnum """ Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by accessEntityContact. """ accessContacts: Boolean """ Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space. """ accessDocumentManagement: Boolean """ Allows users with this role to manage company documents and folders that are not tied to a record. """ accessDocumentManagementCompany: Boolean """ Allows users with this role to create and edit the document folders used for records. """ accessDocumentManagementRecord: Boolean """ Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space. """ accessDuplicateChecker: Boolean """ When true, users with this role get the email notification preferences from accessEmailNotificationSettings and cannot change their own. """ accessEmailNotificationEnforcement: Boolean """ Default email notification preferences applied to users with this role (which events trigger an email and through which channel). """ accessEmailNotificationSettings: NotificationSettingsParams """ Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see. """ accessEntityAccount: AccessLevelEntityEnum """Allows users with this role to create copies of existing accounts.""" accessEntityAccountCopy: Boolean """Allows users with this role to delete accounts they can edit.""" accessEntityAccountDelete: Boolean """ Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAccountDirection: AccessDirectionEnum """ Allows users with this role to own private accounts, which are visible only to their owner. """ accessEntityAccountPrivate: Boolean """Allows users with this role to create new tags for accounts.""" accessEntityAccountTagCreate: Boolean """ Whether users with this role can work with all account types (All) or only with those in allowedAccountTypes (Selected). """ accessEntityAccountTypes: AccessEntityTypesEnum """ Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see. """ accessEntityAppointment: AccessLevelEntityEnum """Allows users with this role to delete appointments they can edit.""" accessEntityAppointmentDelete: Boolean """ Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityAppointmentDirection: AccessDirectionEnum """Allows users with this role to create new tags for appointments.""" accessEntityAppointmentTagCreate: Boolean """ Whether users with this role can work with all appointment types (All) or only with those in allowedAppointmentTypes (Selected). """ accessEntityAppointmentTypes: AccessEntityTypesEnum """ Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityBetterNavigator: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to delete Navigator screen layouts owned by other users. """ accessEntityBetterNavigatorDeleteNotOwned: Boolean """ Allows users with this role to delete Navigator screen layouts they own. """ accessEntityBetterNavigatorDeleteOwned: Boolean """ Allows users with this role to share their Navigator screen layouts with selected users and sales units. """ accessEntityBetterNavigatorSharingCustom: Boolean """ Allows users with this role to share their Navigator screen layouts with all users of the space. """ accessEntityBetterNavigatorSharingPublic: Boolean """ Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see. """ accessEntityContact: AccessLevelEntityEnum """Allows users with this role to create copies of existing contacts.""" accessEntityContactCopy: Boolean """Allows users with this role to delete contacts they can edit.""" accessEntityContactDelete: Boolean """ Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityContactDirection: AccessDirectionEnum """ Allows users with this role to own private contacts, which are visible only to their owner. """ accessEntityContactPrivate: Boolean """Allows users with this role to create new tags for contacts.""" accessEntityContactTagCreate: Boolean """ Whether users with this role can work with all contact types (All) or only with those in allowedContactTypes (Selected). """ accessEntityContactTypes: AccessEntityTypesEnum """ Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while accessEntityReport is NoAccess. """ accessEntityDashboard: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete dashboards owned by other users.""" accessEntityDashboardDeleteNotOwned: Boolean """Allows users with this role to delete dashboards they own.""" accessEntityDashboardDeleteOwned: Boolean """ Allows users with this role to share their dashboards with selected users and sales units. """ accessEntityDashboardSharingCustom: Boolean """ Allows users with this role to share their dashboards with all users of the space. """ accessEntityDashboardSharingPublic: Boolean """ Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in accessEntityEmailAllowed (own and shared-with-me emails always stay visible). The Inbox is not affected. """ accessEntityEmailAccessLevel: EmailAccessLevelEnum """ Allow-list for accessEntityEmailAccessLevel = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default. """ accessEntityEmailAllowed: EmailAccessAllowListParams """ How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom). """ accessEntityEmailContentShareMode: ContentShareModeConfigEnum """ Allows users with this role to delete emails they neither own nor sent. """ accessEntityEmailDeleteNotOwned: Boolean """ Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccounts: TernaryConfigEnum """ Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToAccountsByDomain: TernaryConfigEnum """ Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings. """ accessEntityEmailLinkToContacts: TernaryConfigEnum """ Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityEmailSequence: AccessLevelEmailSequenceEnum """ Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityEmailTemplate: AccessLevelCommonRecordsEnumEnum """ Allows users with this role to create and delete email template folders. """ accessEntityEmailTemplateCreateDeleteFolder: Boolean """ Allows users with this role to delete email templates owned by other users. """ accessEntityEmailTemplateDeleteNotOwned: Boolean """Allows users with this role to delete email templates they own.""" accessEntityEmailTemplateDeleteOwned: Boolean """ Allows users with this role to share their email templates with selected users and sales units. """ accessEntityEmailTemplateSharingCustom: Boolean """ Allows users with this role to share their email templates with all users of the space. """ accessEntityEmailTemplateSharingPublic: Boolean """ Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityForecast: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete forecasts owned by other users.""" accessEntityForecastDeleteNotOwned: Boolean """Allows users with this role to delete forecasts they own.""" accessEntityForecastDeleteOwned: Boolean """Allows users with this role to edit forecasts owned by other users.""" accessEntityForecastEditNotOwned: Boolean """ Allows users with this role to share their forecasts with selected users and sales units. """ accessEntityForecastSharingCustom: Boolean """ Allows users with this role to share their forecasts with all users of the space. """ accessEntityForecastSharingPublic: Boolean """ Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityFormView: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete form views owned by other users.""" accessEntityFormViewDeleteNotOwned: Boolean """Allows users with this role to delete form views they own.""" accessEntityFormViewDeleteOwned: Boolean """ Allows users with this role to share their form views with selected users and sales units. """ accessEntityFormViewSharingCustom: Boolean """ Allows users with this role to share their form views with all users of the space. """ accessEntityFormViewSharingPublic: Boolean """ Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see. """ accessEntityLead: AccessLevelEntityEnum """Allows users with this role to create copies of existing leads.""" accessEntityLeadCopy: Boolean """Allows users with this role to delete leads they can edit.""" accessEntityLeadDelete: Boolean """ Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityLeadDirection: AccessDirectionEnum """ Allows users with this role to own private leads, which are visible only to their owner. """ accessEntityLeadPrivate: Boolean """Allows users with this role to create new tags for leads.""" accessEntityLeadTagCreate: Boolean """ Whether users with this role can work with all lead types (All) or only with those in allowedLeadTypes (Selected). """ accessEntityLeadTypes: AccessEntityTypesEnum """ Allows users with this role to create new tags for emails, memos and text messages. """ accessEntityMessageTagCreate: Boolean """ Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see. """ accessEntityOppty: AccessLevelEntityEnum """ Allows users with this role to create copies of existing opportunities. """ accessEntityOpptyCopy: Boolean """Allows users with this role to delete opportunities they can edit.""" accessEntityOpptyDelete: Boolean """ Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityOpptyDirection: AccessDirectionEnum """ Allows users with this role to own private opportunities, which are visible only to their owner. """ accessEntityOpptyPrivate: Boolean """Allows users with this role to create new tags for opportunities.""" accessEntityOpptyTagCreate: Boolean """ Which pipelines users with this role can work with: none (NoPipeline), those in allowedPipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments). """ accessEntityPipeline: AccessLevelPipelineEnum """ Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess). """ accessEntityProcess: AccessLevelProcessBuilderEnum """ Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected. """ accessEntityProfile: AccessLevelCommonRecordsEnumEnum """ Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.). """ accessEntityProfileDefaultScreenProfiles: ScreensDefaultProfilesParamsParams """ Allows users with this role to delete screen profiles owned by other users. """ accessEntityProfileDeleteNotOwned: Boolean """Allows users with this role to delete screen profiles they own.""" accessEntityProfileDeleteOwned: Boolean """ Allows users with this role to share their screen profiles with selected users and sales units. """ accessEntityProfileSharingCustom: Boolean """ Allows users with this role to share their screen profiles with all users of the space. """ accessEntityProfileSharingPublic: Boolean """ Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see. """ accessEntityProject: AccessLevelEntityEnum """Allows users with this role to create copies of existing projects.""" accessEntityProjectCopy: Boolean """Allows users with this role to delete projects they can edit.""" accessEntityProjectDelete: Boolean """ Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityProjectDirection: AccessDirectionEnum """ Allows users with this role to own private projects, which are visible only to their owner. """ accessEntityProjectPrivate: Boolean """Allows users with this role to create new tags for projects.""" accessEntityProjectTagCreate: Boolean """ Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see. """ accessEntityQuote: AccessLevelEntityEnum """Allows users with this role to create copies of existing quotes.""" accessEntityQuoteCopy: Boolean """Allows users with this role to delete quotes they can edit.""" accessEntityQuoteDelete: Boolean """ Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityQuoteDirection: AccessDirectionEnum """Allows users with this role to create new tags for quotes.""" accessEntityQuoteTagCreate: Boolean """ Whether users with this role can work with all quote types (All) or only with those in allowedQuoteTypes (Selected). """ accessEntityQuoteTypes: AccessEntityTypesEnum """ Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityReport: AccessLevelCommonRecordsEnumEnum """Allows users with this role to create and delete report folders.""" accessEntityReportCreateDeleteFolder: Boolean """Allows users with this role to delete reports owned by other users.""" accessEntityReportDeleteNotOwned: Boolean """Allows users with this role to delete reports they own.""" accessEntityReportDeleteOwned: Boolean """ Allows users with this role to save reports as private, visible only to themselves. """ accessEntityReportPrivate: Boolean """Allows users with this role to schedule reports for regular delivery.""" accessEntityReportScheduleCreate: Boolean """ Allows users with this role to view and manage report schedules of other users. """ accessEntityReportScheduleManagement: Boolean """ Allows users with this role to share their reports with selected users and sales units. """ accessEntityReportSharingCustom: Boolean """ Allows users with this role to share their reports with all users of the space. """ accessEntityReportSharingPublic: Boolean """ Allows users with this role to view and follow solutions, when the feature is enabled for the space. """ accessEntitySolution: Boolean """Allows users with this role to create, edit and delete solutions.""" accessEntitySolutionManagement: Boolean """ Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). """ accessEntityTarget: AccessLevelCommonRecordsEnumEnum """Allows users with this role to delete targets owned by other users.""" accessEntityTargetDeleteNotOwned: Boolean """Allows users with this role to delete targets they own.""" accessEntityTargetDeleteOwned: Boolean """ Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see. """ accessEntityTask: AccessLevelEntityEnum """Allows users with this role to delete tasks they can edit.""" accessEntityTaskDelete: Boolean """ Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All). """ accessEntityTaskDirection: AccessDirectionEnum """Allows users with this role to create new tags for tasks.""" accessEntityTaskTagCreate: Boolean """ Whether users with this role can work with all task types (All) or only with those in allowedTaskTypes (Selected). """ accessEntityTaskTypes: AccessEntityTypesEnum """ Allows users with this role to create tasks without an owner (unassigned tasks). """ accessEntityTaskUnassigned: Boolean """Allows users with this role to export records and reports to files.""" accessExport: Boolean """ Allows users with this role to open the Feed screen with the stream of activities, emails and other updates. """ accessFeeds: Boolean """ Allows users with this role to manage currencies and exchange rate lists in Administration. """ accessForeignCurrencies: Boolean """ Allows users with this role to manage fields, forms, record types, tags and translations in Administration. """ accessFormAndFields: Boolean """ Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access. """ accessGlobalSettings: Boolean """Allows users with this role to open the Navigator screen.""" accessHomeScreen: Boolean """Allows users with this role to import records from files.""" accessImport: Boolean """ Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews. """ accessInsights: Boolean """ Shows the Leads screen to users with this role. Which leads they can see and edit is set by accessEntityLead. """ accessLeads: Boolean """ Allows users with this role to create online forms and manage their own, when online forms are enabled for the space. """ accessOnlineForms: Boolean """ Allows users with this role to edit and delete online forms owned by other users. """ accessOnlineFormsManagement: Boolean """ Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by accessEntityOppty. """ accessOpportunity: Boolean """ Allows users with this role to manage pipelines, lead processes and quote processes in Administration. """ accessPipelineConfiguration: Boolean """Allows users with this role to print records and reports.""" accessPrint: Boolean """ Allows users with this role to manage products, product categories and price lists in Administration. """ accessProductsServices: Boolean """ Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by accessEntityProject. """ accessProjects: Boolean """ Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by accessEntityQuote. """ accessQuotes: Boolean """Allows users with this role to manage sales roles in Administration.""" accessSalesRoles: Boolean """ Allows users with this role to manage the security settings of the space in Administration. """ accessSecurity: Boolean """Allows users with this role to manage sales units in Administration.""" accessUnits: Boolean """ Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role. """ accessUserAndRoles: Boolean """ Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowedCompanyPhones (Selected) or all (All). """ accessWhatsAppCompanyPhone: AccessLevelCompanyEmailsEnum """ The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items. Stored as the client sent it; until it is saved once the default list is returned, everything enabled and pinned. The access_* flags of the role are not touched by it: the client sends both. """ bottomMenuLayout: [InterfaceBottomMenuRowParams!] """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """ Pipelines this user role can use. Effective only when accessEntityPipeline is set to Selected; with All-* values every pipeline is granted. """ allowedPipelines: [CreateAllowedPipelineNoMasterRightBackrefInput!] """ Lead types this user role can use. Effective only when accessEntityLeadTypes is set to Selected. """ allowedLeadTypes: [CreateAllowedLeadTypeNoMasterRightBackrefInput!] """ Quote types this user role can use. Effective only when accessEntityQuoteTypes is set to Selected. """ allowedQuoteTypes: [CreateAllowedQuoteTypeNoMasterRightBackrefInput!] """ Account types this user role can use. Effective only when accessEntityAccountTypes is set to Selected. """ allowedAccountTypes: [CreateAllowedAccountTypeNoMasterRightBackrefInput!] """ Contact types this user role can use. Effective only when accessEntityContactTypes is set to Selected. """ allowedContactTypes: [CreateAllowedContactTypeNoMasterRightBackrefInput!] """ Task types this user role can use. Effective only when accessEntityTaskTypes is set to Selected. """ allowedTaskTypes: [CreateAllowedTaskTypeNoMasterRightBackrefInput!] """ Appointment types this user role can use. Effective only when accessEntityAppointmentTypes is set to Selected. The recurrent appointment type is always granted implicitly and cannot be stored here. """ allowedAppointmentTypes: [CreateAllowedAppointmentTypeNoMasterRightBackrefInput!] """ Company email addresses this user role can send from. Effective only when accessCompanyEmails is set to Selected. """ allowedCompanyEmails: [CreateAllowedCompanyEmailNoMasterRightBackrefInput!] """ Company phones this user role can use for calling/SMS. Effective only when accessCallingCompanyPhone is set to Selected. """ allowedCompanyPhones: [CreateAllowedCompanyPhoneNoMasterRightBackrefInput!] """ Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space. """ customEntities: [CustomEntityMasterRightParams!] } """Id of the MasterRight record to delete.""" input DeleteMasterRightInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteMasterRight mutation.""" type DeleteMasterRightPayload { """The deleted record.""" masterRight: MasterRightEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateMedia mutation.""" type UpdateMediaPayload { """The updated record.""" media: MediaEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Media record and the field values to change.""" input UpdateMediaInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the linked appointment or task, or empty when not linked to an activity. """ activityId: ID """Id of the linked call, or empty when not linked.""" callId: ID """ Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object. """ data: JSONString """Free-text description of the media.""" description: String """ Error code reported by the calling/recording provider when processing failed; empty on success. """ errorCode: Int """ Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode. """ status: MediaStatusEnum """ Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set. """ type: MediaTypeEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateMedia mutation.""" type BulkUpdateMediaPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Media record to create, or to update when its id is set. """ input CreateOrUpdateMediaInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the linked appointment or task, or empty when not linked to an activity. """ activityId: ID """Id of the linked call, or empty when not linked.""" callId: ID """ Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object. """ data: JSONString """Free-text description of the media.""" description: String """ Error code reported by the calling/recording provider when processing failed; empty on success. """ errorCode: Int """ Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode. """ status: MediaStatusEnum """ Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set. """ type: MediaTypeEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the Media record to delete.""" input DeleteMediaInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the linked appointment or task, or empty when not linked to an activity. """ activityId: ID } """Result of the deleteMedia mutation.""" type DeleteMediaPayload { """The deleted record.""" media: MediaEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createMemo mutation.""" type CreateMemoPayload { """The created record.""" memo: MemoEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Memo record.""" input CreateMemoInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the memo author.""" ownerId: ID! """Short summary line of the memo.""" subject: String! """Revision when entity was lastly changed.""" revision: Int """Sales units that have been granted shared access to this memo.""" sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!] """Users that have been granted shared access to this memo.""" sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!] """Accounts this memo is linked to.""" accountRelations: [CreateMessageRelationNoMessageBackrefInput!] """Contacts this memo is linked to.""" contactRelations: [CreateMessageRelationNoMessageBackrefInput!] """Projects this memo is linked to.""" projectRelations: [CreateMessageRelationNoMessageBackrefInput!] """Leads this memo is linked to.""" leadRelations: [CreateMessageRelationNoMessageBackrefInput!] """Quotes this memo is linked to.""" quoteRelations: [CreateMessageRelationNoMessageBackrefInput!] """Opportunities this memo is linked to.""" opportunityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Custom entity records this memo is linked to.""" customEntityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Documents linked to this memo.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this memo.""" comments: [CreateMemoCommentNoMemoBackrefInput!] } """ Field values of a new MemoComment record, created together with the record it belongs to. """ input CreateMemoCommentNoMemoBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form text body of the comment.""" comment: String! """Id of the comment author.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateMemo mutation.""" type UpdateMemoPayload { """The updated record.""" memo: MemoEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Memo record and the field values to change.""" input UpdateMemoInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the memo author.""" ownerId: ID """Short summary line of the memo.""" subject: String """Revision when entity was lastly changed.""" revision: Int """Sales units that have been granted shared access to this memo.""" sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!] """Users that have been granted shared access to this memo.""" sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!] """Accounts this memo is linked to.""" accountRelations: [CreateMessageRelationNoMessageBackrefInput!] """Contacts this memo is linked to.""" contactRelations: [CreateMessageRelationNoMessageBackrefInput!] """Projects this memo is linked to.""" projectRelations: [CreateMessageRelationNoMessageBackrefInput!] """Leads this memo is linked to.""" leadRelations: [CreateMessageRelationNoMessageBackrefInput!] """Quotes this memo is linked to.""" quoteRelations: [CreateMessageRelationNoMessageBackrefInput!] """Opportunities this memo is linked to.""" opportunityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Custom entity records this memo is linked to.""" customEntityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Documents linked to this memo.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this memo.""" comments: [CreateMemoCommentNoMemoBackrefInput!] } """Result of the bulkUpdateMemo mutation.""" type BulkUpdateMemoPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Memo record to create, or to update when its id is set. """ input CreateOrUpdateMemoInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the memo author.""" ownerId: ID """Short summary line of the memo.""" subject: String """Revision when entity was lastly changed.""" revision: Int """Sales units that have been granted shared access to this memo.""" sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!] """Users that have been granted shared access to this memo.""" sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!] """Accounts this memo is linked to.""" accountRelations: [CreateMessageRelationNoMessageBackrefInput!] """Contacts this memo is linked to.""" contactRelations: [CreateMessageRelationNoMessageBackrefInput!] """Projects this memo is linked to.""" projectRelations: [CreateMessageRelationNoMessageBackrefInput!] """Leads this memo is linked to.""" leadRelations: [CreateMessageRelationNoMessageBackrefInput!] """Quotes this memo is linked to.""" quoteRelations: [CreateMessageRelationNoMessageBackrefInput!] """Opportunities this memo is linked to.""" opportunityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Custom entity records this memo is linked to.""" customEntityRelations: [CreateMessageRelationNoMessageBackrefInput!] """Documents linked to this memo.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this memo.""" comments: [CreateMemoCommentNoMemoBackrefInput!] } """Id of the Memo record to delete.""" input DeleteMemoInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteMemo mutation.""" type DeleteMemoPayload { """The deleted record.""" memo: MemoEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createMemoComment mutation.""" type CreateMemoCommentPayload { """The created record.""" memoComment: MemoCommentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new MemoComment record.""" input CreateMemoCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form text body of the comment.""" comment: String! """Id of the memo this comment belongs to.""" memoId: ID! """Id of the comment author.""" ownerId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateMemoComment mutation.""" type UpdateMemoCommentPayload { """The updated record.""" memoComment: MemoCommentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a MemoComment record and the field values to change.""" input UpdateMemoCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form text body of the comment.""" comment: String """Id of the memo this comment belongs to.""" memoId: ID """Id of the comment author.""" ownerId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateMemoComment mutation.""" type BulkUpdateMemoCommentPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a MemoComment record to create, or to update when its id is set. """ input CreateOrUpdateMemoCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form text body of the comment.""" comment: String """Id of the memo this comment belongs to.""" memoId: ID """Id of the comment author.""" ownerId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the MemoComment record to delete.""" input DeleteMemoCommentInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteMemoComment mutation.""" type DeleteMemoCommentPayload { """The deleted record.""" memoComment: MemoCommentEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createMessageRelation mutation.""" type CreateMessageRelationPayload { """The created record.""" messageRelation: MessageRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new MessageRelation record.""" input CreateMessageRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the email or memo on this link.""" messageId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateMessageRelation mutation.""" type UpdateMessageRelationPayload { """The updated record.""" messageRelation: MessageRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a MessageRelation record and the field values to change.""" input UpdateMessageRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the email or memo on this link.""" messageId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateMessageRelation mutation.""" type BulkUpdateMessageRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a MessageRelation record to create, or to update when its id is set. """ input CreateOrUpdateMessageRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the email or memo on this link.""" messageId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the MessageRelation record to delete.""" input DeleteMessageRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the lead or opportunity the message is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the email or memo on this link.""" messageId: ID } """Result of the deleteMessageRelation mutation.""" type DeleteMessageRelationPayload { """The deleted record.""" messageRelation: MessageRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createMessageSharingClientRelation mutation.""" type CreateMessageSharingClientRelationPayload { """The created record.""" messageSharingClientRelation: MessageSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new MessageSharingClientRelation record.""" input CreateMessageSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the email or memo being shared.""" messageId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateMessageSharingClientRelation mutation.""" type UpdateMessageSharingClientRelationPayload { """The updated record.""" messageSharingClientRelation: MessageSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a MessageSharingClientRelation record and the field values to change. """ input UpdateMessageSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the email or memo being shared.""" messageId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateMessageSharingClientRelation mutation.""" type BulkUpdateMessageSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a MessageSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateMessageSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the email or memo being shared.""" messageId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the MessageSharingClientRelation record to delete.""" input DeleteMessageSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the email or memo being shared.""" messageId: ID } """Result of the deleteMessageSharingClientRelation mutation.""" type DeleteMessageSharingClientRelationPayload { """The deleted record.""" messageSharingClientRelation: MessageSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createMessageSharingSalesUnitRelation mutation.""" type CreateMessageSharingSalesUnitRelationPayload { """The created record.""" messageSharingSalesUnitRelation: MessageSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new MessageSharingSalesUnitRelation record.""" input CreateMessageSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email or memo being shared.""" messageId: ID! """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateMessageSharingSalesUnitRelation mutation.""" type UpdateMessageSharingSalesUnitRelationPayload { """The updated record.""" messageSharingSalesUnitRelation: MessageSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a MessageSharingSalesUnitRelation record and the field values to change. """ input UpdateMessageSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email or memo being shared.""" messageId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateMessageSharingSalesUnitRelation mutation.""" type BulkUpdateMessageSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a MessageSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateMessageSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the email or memo being shared.""" messageId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the MessageSharingSalesUnitRelation record to delete.""" input DeleteMessageSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the email or memo being shared.""" messageId: ID } """Result of the deleteMessageSharingSalesUnitRelation mutation.""" type DeleteMessageSharingSalesUnitRelationPayload { """The deleted record.""" messageSharingSalesUnitRelation: MessageSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyNote mutation.""" type CopyNotePayload { """Created copy of entity.""" result: NoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyNote mutation.""" input CopyNoteInput { """Identifier of the NoteEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createNote mutation.""" type CreateNotePayload { """The created record.""" note: NoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateNote mutation.""" type UpdateNotePayload { """The updated record.""" note: NoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Note record and the field values to change.""" input UpdateNoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the note is attached to.""" accountId: ID """Id of the contact the note is attached to.""" contactId: ID """Id of the custom entity record the note is attached to.""" customEntityId: ID """Id of the lead or opportunity the note is attached to.""" leadOpptyId: ID """Free-form text body of the note (sanitized HTML allowed).""" note: String """Id of the note author.""" ownerId: ID """Id of the project the note is attached to.""" projectId: ID """Id of the quote the note is attached to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateNote mutation.""" type BulkUpdateNotePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Note record to create, or to update when its id is set. """ input CreateOrUpdateNoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account the note is attached to.""" accountId: ID """Id of the contact the note is attached to.""" contactId: ID """Id of the custom entity record the note is attached to.""" customEntityId: ID """Id of the lead or opportunity the note is attached to.""" leadOpptyId: ID """Free-form text body of the note (sanitized HTML allowed).""" note: String """Id of the note author.""" ownerId: ID """Id of the project the note is attached to.""" projectId: ID """Id of the quote the note is attached to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the Note record to delete.""" input DeleteNoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the lead or opportunity the note is attached to.""" leadOpptyId: ID } """Result of the deleteNote mutation.""" type DeleteNotePayload { """The deleted record.""" note: NoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOnlineForm mutation.""" type CreateOnlineFormPayload { """The created record.""" onlineForm: OnlineFormEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OnlineForm record.""" input CreateOnlineFormInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the currency exchange rate list applied to product line items at submission time. """ currencyExchangeRatesListId: ID """Id of the linked email record, when available.""" emailId: ID """ Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). """ fieldIds: JSONString! """Id of the online form definition.""" onlineFormTypeId: ID! """Id of the selected currency.""" productCurrencyId: ID """Id of the selected price list.""" productPriceListId: ID """ Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. """ status: ProcessStatusEnum """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Accounts the submission was linked to.""" accountRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Contacts the submission was linked to.""" contactRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Leads the submission was linked to.""" leadRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Opportunities the submission was linked to.""" opportunityRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Quotes the submission was linked to.""" quoteRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Projects the submission was linked to.""" projectRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Custom entity records the submission was linked to.""" customEntityRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] } """ Field values of a new OnlineFormRelation record, created together with the record it belongs to. """ input CreateOnlineFormRelationNoOnlineFormBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType. """ isPrimary: Boolean! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOnlineForm mutation.""" type UpdateOnlineFormPayload { """The updated record.""" onlineForm: OnlineFormEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an OnlineForm record and the field values to change.""" input UpdateOnlineFormInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the currency exchange rate list applied to product line items at submission time. """ currencyExchangeRatesListId: ID """Id of the linked email record, when available.""" emailId: ID """ Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). """ fieldIds: JSONString """Id of the online form definition.""" onlineFormTypeId: ID """Id of the selected currency.""" productCurrencyId: ID """Id of the selected price list.""" productPriceListId: ID """ Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. """ status: ProcessStatusEnum """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Accounts the submission was linked to.""" accountRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Contacts the submission was linked to.""" contactRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Leads the submission was linked to.""" leadRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Opportunities the submission was linked to.""" opportunityRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Quotes the submission was linked to.""" quoteRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Projects the submission was linked to.""" projectRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Custom entity records the submission was linked to.""" customEntityRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] } """Result of the bulkUpdateOnlineForm mutation.""" type BulkUpdateOnlineFormPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OnlineForm record to create, or to update when its id is set. """ input CreateOrUpdateOnlineFormInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the currency exchange rate list applied to product line items at submission time. """ currencyExchangeRatesListId: ID """Id of the linked email record, when available.""" emailId: ID """ Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). """ fieldIds: JSONString """Id of the online form definition.""" onlineFormTypeId: ID """Id of the selected currency.""" productCurrencyId: ID """Id of the selected price list.""" productPriceListId: ID """ Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed. """ status: ProcessStatusEnum """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Accounts the submission was linked to.""" accountRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Contacts the submission was linked to.""" contactRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Leads the submission was linked to.""" leadRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Opportunities the submission was linked to.""" opportunityRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Quotes the submission was linked to.""" quoteRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Projects the submission was linked to.""" projectRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] """Custom entity records the submission was linked to.""" customEntityRelations: [CreateOnlineFormRelationNoOnlineFormBackrefInput!] } """Id of the OnlineForm record to delete.""" input DeleteOnlineFormInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOnlineForm mutation.""" type DeleteOnlineFormPayload { """The deleted record.""" onlineForm: OnlineFormEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOnlineFormActivityLogLine mutation.""" type CreateOnlineFormActivityLogLinePayload { """The created record.""" onlineFormActivityLogLine: OnlineFormActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OnlineFormActivityLogLine record.""" input CreateOnlineFormActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the submission.""" onlineFormId: ID! """Position of the line within its log run.""" sortOrder: Int! """ Result of the processing step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum } """Result of the updateOnlineFormActivityLogLine mutation.""" type UpdateOnlineFormActivityLogLinePayload { """The updated record.""" onlineFormActivityLogLine: OnlineFormActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an OnlineFormActivityLogLine record and the field values to change. """ input UpdateOnlineFormActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the submission.""" onlineFormId: ID """Position of the line within its log run.""" sortOrder: Int """ Result of the processing step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum } """Result of the bulkUpdateOnlineFormActivityLogLine mutation.""" type BulkUpdateOnlineFormActivityLogLinePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OnlineFormActivityLogLine record to create, or to update when its id is set. """ input CreateOrUpdateOnlineFormActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the submission.""" onlineFormId: ID """Position of the line within its log run.""" sortOrder: Int """ Result of the processing step recorded by this line, such as Ok, Warning or Error. """ status: ProcessStatusEnum } """Id of the OnlineFormActivityLogLine record to delete.""" input DeleteOnlineFormActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOnlineFormActivityLogLine mutation.""" type DeleteOnlineFormActivityLogLinePayload { """The deleted record.""" onlineFormActivityLogLine: OnlineFormActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOnlineFormDataExRelation mutation.""" type CreateOnlineFormDataExRelationPayload { """The created record.""" onlineFormDataExRelation: OnlineFormDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OnlineFormDataExRelation record.""" input CreateOnlineFormDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the online form submission.""" onlineFormId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOnlineFormDataExRelation mutation.""" type UpdateOnlineFormDataExRelationPayload { """The updated record.""" onlineFormDataExRelation: OnlineFormDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an OnlineFormDataExRelation record and the field values to change. """ input UpdateOnlineFormDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Id of the online form submission.""" onlineFormId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateOnlineFormDataExRelation mutation.""" type BulkUpdateOnlineFormDataExRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OnlineFormDataExRelation record to create, or to update when its id is set. """ input CreateOrUpdateOnlineFormDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Id of the online form submission.""" onlineFormId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the OnlineFormDataExRelation record to delete.""" input DeleteOnlineFormDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOnlineFormDataExRelation mutation.""" type DeleteOnlineFormDataExRelationPayload { """The deleted record.""" onlineFormDataExRelation: OnlineFormDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOnlineFormRelation mutation.""" type CreateOnlineFormRelationPayload { """The created record.""" onlineFormRelation: OnlineFormRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OnlineFormRelation record.""" input CreateOnlineFormRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType. """ isPrimary: Boolean! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the submission.""" onlineFormId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOnlineFormRelation mutation.""" type UpdateOnlineFormRelationPayload { """The updated record.""" onlineFormRelation: OnlineFormRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an OnlineFormRelation record and the field values to change.""" input UpdateOnlineFormRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType. """ isPrimary: Boolean """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the submission.""" onlineFormId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateOnlineFormRelation mutation.""" type BulkUpdateOnlineFormRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OnlineFormRelation record to create, or to update when its id is set. """ input CreateOrUpdateOnlineFormRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType. """ isPrimary: Boolean """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the submission.""" onlineFormId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the OnlineFormRelation record to delete.""" input DeleteOnlineFormRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID } """Result of the deleteOnlineFormRelation mutation.""" type DeleteOnlineFormRelationPayload { """The deleted record.""" onlineFormRelation: OnlineFormRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOnlineFormStyle mutation.""" type CreateOnlineFormStylePayload { """The created record.""" onlineFormStyle: OnlineFormStyleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OnlineFormStyle record.""" input CreateOnlineFormStyleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """ JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. """ settings: JSONString """ When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOnlineFormStyle mutation.""" type UpdateOnlineFormStylePayload { """The updated record.""" onlineFormStyle: OnlineFormStyleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an OnlineFormStyle record and the field values to change.""" input UpdateOnlineFormStyleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. """ settings: JSONString """ When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateOnlineFormStyle mutation.""" type BulkUpdateOnlineFormStylePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OnlineFormStyle record to create, or to update when its id is set. """ input CreateOrUpdateOnlineFormStyleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. """ settings: JSONString """ When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Id of the OnlineFormStyle record to delete.""" input DeleteOnlineFormStyleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOnlineFormStyle mutation.""" type DeleteOnlineFormStylePayload { """The deleted record.""" onlineFormStyle: OnlineFormStyleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOnlineFormType mutation.""" type CreateOnlineFormTypePayload { """The created record.""" onlineFormType: OnlineFormTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OnlineFormType record.""" input CreateOnlineFormTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. """ autoPrefillWithJavascript: Boolean """Free-text description shown alongside the form definition in the UI.""" description: String """ API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. """ entityApiName: String """ Entity the form is built for: its fields can be placed on the form and each submission is linked to a record of this entity. For custom entities, entityApiName identifies the custom entity. """ entityType: BaseEntityTypeEnum! """ Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. This payload conforms to the `OnlineForm` JSON Schema: GET /api/v100/rest/schemas/OnlineForm.json on your region's API host """ formEdit: JSONString! """ When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. """ isEnabled: Boolean! """ True when the form is system-managed and its schema cannot be edited by users. """ isReadonly: Boolean! """Timestamp of the most recent change to formEdit (form schema).""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String! """ Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. """ notificationsStatus: JSONString """Id of the owning user.""" ownerId: ID! """Id of the form style.""" styleId: ID! """Revision when entity was lastly changed.""" revision: Int """ Custom reCAPTCHA keys (siteKey and secretKey) used on the forms of this type instead of the platform default; null switches back to the default. Write-only; hasCustomRecaptcha tells whether keys are set. """ customRecaptcha: CustomRecaptcha } """ Own Google reCAPTCHA keys that protect the published forms of an online form type. """ input CustomRecaptcha { """ Site key of your Google reCAPTCHA registration, used by the published form. """ siteKey: String! """ Server-side secret of the same reCAPTCHA registration, used to verify the answers of respondents. Write-only; it is never returned. """ secretKey: String! } """Result of the updateOnlineFormType mutation.""" type UpdateOnlineFormTypePayload { """The updated record.""" onlineFormType: OnlineFormTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an OnlineFormType record and the field values to change.""" input UpdateOnlineFormTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. """ autoPrefillWithJavascript: Boolean """Free-text description shown alongside the form definition in the UI.""" description: String """ API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. """ entityApiName: String """ Entity the form is built for: its fields can be placed on the form and each submission is linked to a record of this entity. For custom entities, entityApiName identifies the custom entity. """ entityType: BaseEntityTypeEnum """ Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. This payload conforms to the `OnlineForm` JSON Schema: GET /api/v100/rest/schemas/OnlineForm.json on your region's API host """ formEdit: JSONString """ When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. """ isEnabled: Boolean """ True when the form is system-managed and its schema cannot be edited by users. """ isReadonly: Boolean """Timestamp of the most recent change to formEdit (form schema).""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String """ Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. """ notificationsStatus: JSONString """Id of the owning user.""" ownerId: ID """Id of the form style.""" styleId: ID """Revision when entity was lastly changed.""" revision: Int """ Custom reCAPTCHA keys (siteKey and secretKey) used on the forms of this type instead of the platform default; null switches back to the default. Write-only; hasCustomRecaptcha tells whether keys are set. """ customRecaptcha: CustomRecaptcha } """Result of the bulkUpdateOnlineFormType mutation.""" type BulkUpdateOnlineFormTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OnlineFormType record to create, or to update when its id is set. """ input CreateOrUpdateOnlineFormTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. """ autoPrefillWithJavascript: Boolean """Free-text description shown alongside the form definition in the UI.""" description: String """ API name of the custom entity the form targets. Set only when entityType is CustomEntity; otherwise empty. """ entityApiName: String """ Entity the form is built for: its fields can be placed on the form and each submission is linked to a record of this entity. For custom entities, entityApiName identifies the custom entity. """ entityType: BaseEntityTypeEnum """ Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. This payload conforms to the `OnlineForm` JSON Schema: GET /api/v100/rest/schemas/OnlineForm.json on your region's API host """ formEdit: JSONString """ When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. """ isEnabled: Boolean """ True when the form is system-managed and its schema cannot be edited by users. """ isReadonly: Boolean """Timestamp of the most recent change to formEdit (form schema).""" lastSchemaChange: DateTime """Timestamp of the most recent change to isEnabled.""" lastStatusChange: DateTime """Name of the entity and its default text representation.""" name: String """ Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. """ notificationsStatus: JSONString """Id of the owning user.""" ownerId: ID """Id of the form style.""" styleId: ID """Revision when entity was lastly changed.""" revision: Int """ Custom reCAPTCHA keys (siteKey and secretKey) used on the forms of this type instead of the platform default; null switches back to the default. Write-only; hasCustomRecaptcha tells whether keys are set. """ customRecaptcha: CustomRecaptcha } """Id of the OnlineFormType record to delete.""" input DeleteOnlineFormTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOnlineFormType mutation.""" type DeleteOnlineFormTypePayload { """The deleted record.""" onlineFormType: OnlineFormTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOnlineFormTypeEmailRelation mutation.""" type CreateOnlineFormTypeEmailRelationPayload { """The created record.""" onlineFormTypeEmailRelation: OnlineFormTypeEmailRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OnlineFormTypeEmailRelation record.""" input CreateOnlineFormTypeEmailRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the email message.""" emailId: ID! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the online form whose link the email delivers to the recipient.""" onlineFormTypeId: ID! """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOnlineFormTypeEmailRelation mutation.""" type UpdateOnlineFormTypeEmailRelationPayload { """The updated record.""" onlineFormTypeEmailRelation: OnlineFormTypeEmailRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an OnlineFormTypeEmailRelation record and the field values to change. """ input UpdateOnlineFormTypeEmailRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the email message.""" emailId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the online form whose link the email delivers to the recipient.""" onlineFormTypeId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateOnlineFormTypeEmailRelation mutation.""" type BulkUpdateOnlineFormTypeEmailRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OnlineFormTypeEmailRelation record to create, or to update when its id is set. """ input CreateOrUpdateOnlineFormTypeEmailRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the email message.""" emailId: ID """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID """Id of the online form whose link the email delivers to the recipient.""" onlineFormTypeId: ID """Id of the linked quote.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the OnlineFormTypeEmailRelation record to delete.""" input DeleteOnlineFormTypeEmailRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Id of the linked lead or opportunity, or empty when not linked.""" leadOpptyId: ID } """Result of the deleteOnlineFormTypeEmailRelation mutation.""" type DeleteOnlineFormTypeEmailRelationPayload { """The deleted record.""" onlineFormTypeEmailRelation: OnlineFormTypeEmailRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipOpportunity mutation.""" type ChangeOwnershipOpportunityPayload { """The record with its new owner.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipOpportunity mutation.""" input ChangeOwnershipOpportunityInput { """User who becomes the new owner of the record.""" ownerId: ID! """Sales unit the record is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the record as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """ When true, the new owner and sales unit are also applied to the record's open tasks and appointments and its notes. Linked records that cannot be transferred are skipped without failing the mutation. """ transferLinkedRecords: Boolean! """Identifier of the OpportunityEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingOpportunity mutation.""" type ManageSharingOpportunityPayload { """The record with its updated sharing.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingOpportunity mutation.""" input ManageSharingOpportunityInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """Identifier of the OpportunityEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeLabelFlagOpportunity mutation.""" type ChangeLabelFlagOpportunityPayload { """The updated record.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeLabelFlagOpportunity mutation.""" input ChangeLabelFlagOpportunityInput { """Marks the record as hot.""" hot: Boolean! """Marks the record as priority.""" priority: Boolean! """Marks the record as stalled.""" stalled: Boolean! """Identifier of the OpportunityEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the restoreOpportunity mutation.""" type RestoreOpportunityPayload { """The restored record.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreOpportunity mutation.""" input RestoreOpportunityInput { """Identifier of the OpportunityEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the archiveOpportunity mutation.""" type ArchiveOpportunityPayload { """The archived opportunity.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the archiveOpportunity mutation.""" input ArchiveOpportunityInput { """ Id of the opportunity and optional field values to save together with the archive, such as reasonOfCloseId. """ entity: UpdateOpportunityInput! """Text of a memo added to the opportunity together with the archive.""" memoText: String """Ids of tasks linked to the opportunity to mark as completed.""" completeActivityIds: [UUID!] """Ids of the opportunity's open quotes to archive as canceled.""" archiveQuoteIds: [UUID!] """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the moveOpportunity mutation.""" type MoveOpportunityPayload { """The moved opportunity.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the moveOpportunity mutation.""" input MoveOpportunityInput { """ Id of the opportunity, the target step (stepId) and any field values to save with the move. """ entity: UpdateOpportunityInput! """Text of a memo added to the opportunity together with the move.""" memoText: String """ Ids of tasks linked to the opportunity or its quotes to mark as completed. """ completeActivityIds: [UUID!] """ Ids of the opportunity's open quotes to move to the last (accepted) step of their quote process. """ acceptQuoteIds: [UUID!] """Ids of the opportunity's open quotes to archive as canceled.""" archiveQuoteIds: [UUID!] """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changePipelineOpportunity mutation.""" type ChangePipelineOpportunityPayload { """The updated opportunity.""" result: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changePipelineOpportunity mutation.""" input ChangePipelineOpportunityInput { """ Id of the opportunity, the target stepId, an optional new ownerId or unitId, and any other field values to save. """ entity: UpdateOpportunityInput! """ Adds the previous owner as an editor of the opportunity; a private opportunity becomes shared. """ keepOwnerAsEditor: Boolean! """Gives the new owner the opportunity's open activities and its notes.""" transferLinkedRecords: Boolean! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the backToLead mutation.""" type BackToLeadPayload { """The resulting lead.""" result: LeadEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the backToLead mutation.""" input BackToLeadInput { """ Id of the opportunity, the target lead step (stepId) and any lead field values to save with the conversion. """ entity: UpdateLeadInput! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOpportunity mutation.""" type CreateOpportunityPayload { """The created record.""" opportunity: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Opportunity record.""" input CreateOpportunityInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the quote currently synchronized with this opportunity, or empty when no quote is active. A quote can be active on only one opportunity at a time. """ activeQuoteId: ID """Expected or actual closing date of the opportunity.""" closingDate: Date! """Id of the currency exchange rate list applied to this opportunity.""" currencyExchangeRatesListId: ID """Free-form description of the opportunity.""" description: String """ True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """ True when value is auto-calculated from the opportunity product line items. False when the user enters value directly. """ isValueAutoCalculate: Boolean """ User-set colored flag used to highlight the opportunity in lists and reports. """ labelFlag: Int """ Time when an AI-suggested buying center was last applied to this opportunity. """ lastAiBuyingCenterApplied: DateTime """Id of the lead source the opportunity originated from.""" leadSourceId: ID """Name of the entity and its default text representation.""" name: String! """Id of the opportunity type.""" opptyTypeId: ID """Id of the opportunity owner.""" ownerId: ID! """ Id of the currency used for product line-item prices on this opportunity. """ productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this opportunity, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: JSONString """ Free-text company email captured at opportunity creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at opportunity creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at opportunity creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at opportunity creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at opportunity creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at opportunity creation when no Contact record has been linked yet. """ quickPhone: String """ Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity. """ ranking: Int """Free-form note explaining why the opportunity was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the opportunity was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the pipeline step.""" stepId: ID! """Id of the sales unit.""" unitId: ID """ True when the opportunity has gone through the qualification step at least once. """ wasQualified: Boolean """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside. """ value: CurrencyForeignFieldInput """ Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up. """ opptyRecurrence: CreateOpptyRecurrenceNoOpptyBackrefInput """ Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity. """ revenueSchedule: CreateOpptyRevenueScheduleNoIdBackrefInput """ Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when isValueAutoCalculate is true. """ productRelations: [CreateOpptyProductRelationNoBackrefInput!] """ Contacts linked to this opportunity, including their roles and org-chart positions. """ contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!] """ Accounts linked to this opportunity, including the primary-account flag. """ accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!] """Documents linked to this opportunity.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Quotes prepared for this opportunity.""" quoteRelations: [CreateQuoteNoOpptyBackrefInput!] """ Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won. """ wonDate: DateTime """ Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived. """ lostDate: DateTime """ Sales units that have been granted shared access to this opportunity. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!] """ Users that have been granted shared access to this opportunity. Editable only when shareMode allows user sharing. """ sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!] """Tag labels applied to this opportunity.""" tags: [CreateTagRelationNoOpptyBackrefInput!] """Saved view profiles this opportunity currently matches.""" staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!] } """ Field values of a new OpptyRecurrence record, created together with the record it belongs to. """ input CreateOpptyRecurrenceNoOpptyBackrefInput { """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: Int """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date! """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: ID! """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new OpptyRevenueSchedule record, created together with the record it belongs to. """ input CreateOpptyRevenueScheduleNoIdBackrefInput { """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Date when the revenue schedule was cancelled. Empty for active schedules. """ cancelationDate: Date """Number of periods the opportunity value is split into.""" periodCount: Int """Length of each period (e.g. Monthly, Quarterly, Yearly).""" periodType: RevenueSchedulePeriodTypeEnum """Date when revenue recognition for the opportunity begins.""" startDate: Date """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOpportunity mutation.""" type UpdateOpportunityPayload { """The updated record.""" opportunity: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkUpdateOpportunity mutation.""" type BulkUpdateOpportunityPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """Id of the Opportunity record to delete.""" input DeleteOpportunityInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOpportunity mutation.""" type DeleteOpportunityPayload { """The deleted record.""" opportunity: OpportunityEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkArchiveOpportunity mutation.""" type BulkArchiveOpportunityPayload { """Ids of the archived opportunities and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkArchiveOpportunity mutation.""" input BulkArchiveOpportunityInput { """ Opportunities to archive: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ Field values saved on every archived opportunity, such as reasonOfCloseId. """ entity: CreateOrUpdateOpportunityInput! """Text of a memo added to every archived opportunity.""" memoText: String = null """Ids of linked tasks to mark as completed.""" completeActivityIds: [UUID!] = null """Ids of open quotes of these opportunities to archive as canceled.""" archiveQuoteIds: [UUID!] = null """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkReactivateOpportunity mutation.""" type BulkReactivateOpportunityPayload { """Ids of the reactivated opportunities and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkReactivateOpportunity mutation.""" input BulkReactivateOpportunityInput { """ Opportunities to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ New expected closing date set on every reactivated opportunity; when empty, each opportunity keeps its current closing date. """ closingDate: Date """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkBackToLead mutation.""" type BulkBackToLeadPayload { """Ids of the converted records and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkBackToLead mutation.""" input BulkBackToLeadInput { """ Opportunities to convert: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ Lead field values applied to every converted record, such as the target lead stepId. """ entity: CreateOrUpdateLeadInput! """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkMoveOpportunity mutation.""" type BulkMoveOpportunityPayload { """Ids of the moved opportunities and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkMoveOpportunity mutation.""" input BulkMoveOpportunityInput { """ Opportunities to move: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """Target step (stepId) and field values applied to every opportunity.""" entity: CreateOrUpdateOpportunityInput! """Text of a memo added to every moved opportunity.""" memoText: String = null """Ids of linked tasks to mark as completed.""" completeActivityIds: [UUID!] = null """ Ids of open quotes of these opportunities to move to their last (accepted) step. """ acceptQuoteIds: [UUID!] = null """Ids of open quotes of these opportunities to archive as canceled.""" archiveQuoteIds: [UUID!] = null """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the convertOpportunity mutation.""" type ConvertOpportunityPayload { """The created record.""" opportunity: OpportunityEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOpptyProductRelation mutation.""" type CreateOpptyProductRelationPayload { """The created record.""" opptyProductRelation: OpptyProductRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateOpptyProductRelation mutation.""" type UpdateOpptyProductRelationPayload { """The updated record.""" opptyProductRelation: OpptyProductRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an OpptyProductRelation record and the field values to change.""" input UpdateOpptyProductRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. """ pairedOpptyProductRelation: CreateOpptyProductRelationInput """ Total amount of the line item (price * quantity, with discounts applied). """ amount: Float """Free-form note describing this line item.""" comment: String """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: ID """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: ID """ Id of the online form submission this line item came from, or empty when it was not created through a form. """ onlineFormId: ID """Id of the opportunity.""" opptyId: ID """Id of the line-item type.""" opptyProductRelationTypeId: ID """Id of the paired line item.""" pairedOpptyProductRelationId: ID """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: Float """Number of product units on this line item.""" quantity: Float """ Id of the quote this line item belongs to. Mutually exclusive with opptyId. """ quoteId: ID """ Identifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote). """ sectionId: ID """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. """ revenueSchedule: UpdateOpptyProductRelationRevenueScheduleNoIdBackrefInput } """Result of the bulkUpdateOpptyProductRelation mutation.""" type BulkUpdateOpptyProductRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OpptyProductRelation record to create, or to update when its id is set. """ input CreateOrUpdateOpptyProductRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. """ pairedOpptyProductRelation: CreateOpptyProductRelationInput """ Total amount of the line item (price * quantity, with discounts applied). """ amount: Float """Free-form note describing this line item.""" comment: String """ Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. """ currencyExchangeRatesListId: ID """ Id of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission. """ onlineFormFieldId: ID """ Id of the online form submission this line item came from, or empty when it was not created through a form. """ onlineFormId: ID """Id of the opportunity.""" opptyId: ID """Id of the line-item type.""" opptyProductRelationTypeId: ID """Id of the paired line item.""" pairedOpptyProductRelationId: ID """ Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly. """ price: Float """ Id of the product on this line item. Set on create; cannot be changed afterwards. """ productId: ID """Number of product units on this line item.""" quantity: Float """ Id of the quote this line item belongs to. Mutually exclusive with opptyId. """ quoteId: ID """ Identifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote). """ sectionId: ID """ Display order of the line item within its section. Maintained automatically when lines are added or moved. """ sortOrder: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. """ revenueSchedule: UpdateOpptyProductRelationRevenueScheduleNoIdBackrefInput } """Id of the OpptyProductRelation record to delete.""" input DeleteOpptyProductRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOpptyProductRelation mutation.""" type DeleteOpptyProductRelationPayload { """The deleted record.""" opptyProductRelation: OpptyProductRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOpptyProductRelationDataExRelation mutation.""" type CreateOpptyProductRelationDataExRelationPayload { """The created record.""" opptyProductRelationDataExRelation: OpptyProductRelationDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OpptyProductRelationDataExRelation record.""" input CreateOpptyProductRelationDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Product line item on which the option is selected.""" opptyProductRelation: CreateOpptyProductRelationInput! """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the product line item.""" opptyProductRelationId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOpptyProductRelationDataExRelation mutation.""" type UpdateOpptyProductRelationDataExRelationPayload { """The updated record.""" opptyProductRelationDataExRelation: OpptyProductRelationDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of an OpptyProductRelationDataExRelation record and the field values to change. """ input UpdateOpptyProductRelationDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Product line item on which the option is selected.""" opptyProductRelation: CreateOpptyProductRelationInput """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Id of the product line item.""" opptyProductRelationId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateOpptyProductRelationDataExRelation mutation.""" type BulkUpdateOpptyProductRelationDataExRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OpptyProductRelationDataExRelation record to create, or to update when its id is set. """ input CreateOrUpdateOpptyProductRelationDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Product line item on which the option is selected.""" opptyProductRelation: CreateOpptyProductRelationInput """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Id of the product line item.""" opptyProductRelationId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the OpptyProductRelationDataExRelation record to delete.""" input DeleteOpptyProductRelationDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOpptyProductRelationDataExRelation mutation.""" type DeleteOpptyProductRelationDataExRelationPayload { """The deleted record.""" opptyProductRelationDataExRelation: OpptyProductRelationDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createOpptyRecurrence mutation.""" type CreateOpptyRecurrencePayload { """The created record.""" opptyRecurrence: OpptyRecurrenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new OpptyRecurrence record.""" input CreateOpptyRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: Int """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """Id of the parent opportunity.""" opptyId: ID! """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date! """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: ID! """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateOpptyRecurrence mutation.""" type UpdateOpptyRecurrencePayload { """The updated record.""" opptyRecurrence: OpptyRecurrenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an OpptyRecurrence record and the field values to change.""" input UpdateOpptyRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: Int """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """Id of the parent opportunity.""" opptyId: ID """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: ID """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateOpptyRecurrence mutation.""" type BulkUpdateOpptyRecurrencePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an OpptyRecurrence record to create, or to update when its id is set. """ input CreateOrUpdateOpptyRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won." condition: Int """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """Id of the parent opportunity.""" opptyId: ID """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date """ Id of the pipeline step the opportunities created by the recurrence start in. """ stepId: ID """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the OpptyRecurrence record to delete.""" input DeleteOpptyRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteOpptyRecurrence mutation.""" type DeleteOpptyRecurrencePayload { """The deleted record.""" opptyRecurrence: OpptyRecurrenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createParentAccountRelationType mutation.""" type CreateParentAccountRelationTypePayload { """The created record.""" parentAccountRelationType: ParentAccountRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ParentAccountRelationType record.""" input CreateParentAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). """ childLabel: String! """ Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). """ parentLabel: String! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateParentAccountRelationType mutation.""" type UpdateParentAccountRelationTypePayload { """The updated record.""" parentAccountRelationType: ParentAccountRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a ParentAccountRelationType record and the field values to change. """ input UpdateParentAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). """ childLabel: String """ Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). """ parentLabel: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateParentAccountRelationType mutation.""" type BulkUpdateParentAccountRelationTypePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ParentAccountRelationType record to create, or to update when its id is set. """ input CreateOrUpdateParentAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). """ childLabel: String """ Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). """ parentLabel: String """Revision when entity was lastly changed.""" revision: Int } """Id of the ParentAccountRelationType record to delete.""" input DeleteParentAccountRelationTypeInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteParentAccountRelationType mutation.""" type DeleteParentAccountRelationTypePayload { """The deleted record.""" parentAccountRelationType: ParentAccountRelationTypeEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createPhone mutation.""" type CreatePhonePayload { """The created record.""" phone: PhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Phone record.""" input CreatePhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy. """ errorCode: Int """Name of the entity and its default text representation.""" name: String! """ Id of the assigned user, or empty when the phone is a company-level resource. """ ownerId: ID """Phone number in E.164 format (e.g. "+12025550123").""" phoneNumber: String """ External caller identifier from the calling provider (e.g. Twilio caller SID). """ twilioCallerSid: String """ Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. """ type: PhoneTypeEnum! """Revision when entity was lastly changed.""" revision: Int """ False when the user has disabled the calling/SMS integration on this phone (errorCode is set to indicate user disablement); true otherwise. """ enabled: Boolean! } """Result of the updatePhone mutation.""" type UpdatePhonePayload { """The updated record.""" phone: PhoneEntity } """Id of a Phone record and the field values to change.""" input UpdatePhoneInput { """Id of the phone.""" id: ID! """Id of the user the phone is assigned to.""" ownerId: ID """Time the phone was created.""" created: DateTime """Time the phone was last modified.""" modified: DateTime """Display name of the phone.""" name: String """Phone number in E.164 format (e.g. "+12025550123").""" phoneNumber: String """Identifier of the phone at the calling provider.""" twilioCallerSid: String """ Kind of phone: calling only, calling and text messaging (personal, company or unassigned), or WhatsApp (personal or company). """ type: PhoneTypeEnum """Phone number that incoming calls and text messages are forwarded to.""" forwardCallsToPhone: String """Email address that incoming text messages are forwarded to.""" forwardMessagesToEmail: String """ True to remove the phone. Only used when phones are synchronized from the subscription's calling settings. """ isDeleted: Boolean } """Result of the bulkUpdatePhone mutation.""" type BulkUpdatePhonePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Phone record to create, or to update when its id is set. """ input CreateOrUpdatePhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy. """ errorCode: Int """Name of the entity and its default text representation.""" name: String """ Id of the assigned user, or empty when the phone is a company-level resource. """ ownerId: ID """Phone number in E.164 format (e.g. "+12025550123").""" phoneNumber: String """ External caller identifier from the calling provider (e.g. Twilio caller SID). """ twilioCallerSid: String """ Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. """ type: PhoneTypeEnum """Revision when entity was lastly changed.""" revision: Int """ False when the user has disabled the calling/SMS integration on this phone (errorCode is set to indicate user disablement); true otherwise. """ enabled: Boolean } """Id of the Phone record to delete.""" input DeletePhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deletePhone mutation.""" type DeletePhonePayload { """The deleted record.""" phone: PhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateMessagingPhone mutation.""" type UpdateMessagingPhonePayload { """The updated phone.""" phone: PhoneEntity } """Result of the deleteMessagingPhone mutation.""" type DeleteMessagingPhonePayload { """The deleted phone.""" phone: PhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the enableMessagingPhone mutation.""" type EnableMessagingPhonePayload { """The updated phone.""" phone: PhoneEntity } """Result of the disableMessagingPhone mutation.""" type DisableMessagingPhonePayload { """The updated phone.""" phone: PhoneEntity } """Result of the createPipeline mutation.""" type CreatePipelinePayload { """The created record.""" pipeline: PipelineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Pipeline record.""" input CreatePipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int! """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """ Steps that make up this pipeline, in the order opportunities move through them. """ steps: [CreateStepNoPipelineBackrefInput!]! } """ Field values of a new Step record, created together with the record it belongs to. """ input CreateStepNoPipelineBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String! """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateStepChecklistNoStepBackrefInput!] } """Result of the updatePipeline mutation.""" type UpdatePipelinePayload { """The updated record.""" pipeline: PipelineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Pipeline record and the field values to change.""" input UpdatePipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """ Steps that make up this pipeline, in the order opportunities move through them. """ steps: [CreateOrUpdateStepNoPipelineBackrefInput!] } """ Field values of a Step record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateStepNoPipelineBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateOrUpdateStepChecklistNoStepBackrefInput!] } """Result of the bulkUpdatePipeline mutation.""" type BulkUpdatePipelinePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Pipeline record to create, or to update when its id is set. """ input CreateOrUpdatePipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """ Steps that make up this pipeline, in the order opportunities move through them. """ steps: [CreateOrUpdateStepNoPipelineBackrefInput!] } """Id of the Pipeline record to delete.""" input DeletePipelineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deletePipeline mutation.""" type DeletePipelinePayload { """The deleted record.""" pipeline: PipelineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProcess mutation.""" type CreateProcessPayload { """The created record.""" process: ProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Process record.""" input CreateProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ AI assistant conversation associated with the process (e.g. records of AI-driven schema generation). """ aiConversation: [AiConversationItemParams!] """Free-text description shown alongside the process.""" description: String """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ Process schema as a JSON object conforming to the ProcessSchema type — trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema This payload conforms to the `ProcessSchema` JSON Schema: GET /api/v100/rest/schemas/ProcessSchema.json on your region's API host """ settings: ProcessSchemaJSONString """ Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. """ type: ProcessTypeEnum! """Tags attached to the process for organisation/filtering.""" tags: [CreateTagRelationNoProcessBackrefInput!] """Files attached to the process (e.g. process documentation).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """ One message of a conversation with the AI assistant, written by the user or by the assistant. """ input AiConversationItemParams { """Text of the message.""" text: String! """Author of the message: the user or the AI assistant.""" actor: AiConversationItemActor! } """JSON object, sent as a string, conforming to the ProcessSchema type.""" scalar ProcessSchemaJSONString """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoProcessBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateProcess mutation.""" type UpdateProcessPayload { """The updated record.""" process: ProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Process record and the field values to change.""" input UpdateProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ AI assistant conversation associated with the process (e.g. records of AI-driven schema generation). """ aiConversation: [AiConversationItemParams!] """Free-text description shown alongside the process.""" description: String """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Process schema as a JSON object conforming to the ProcessSchema type — trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema This payload conforms to the `ProcessSchema` JSON Schema: GET /api/v100/rest/schemas/ProcessSchema.json on your region's API host """ settings: ProcessSchemaJSONString """ Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. """ type: ProcessTypeEnum """Tags attached to the process for organisation/filtering.""" tags: [CreateTagRelationNoProcessBackrefInput!] """Files attached to the process (e.g. process documentation).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateProcess mutation.""" type BulkUpdateProcessPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Process record to create, or to update when its id is set. """ input CreateOrUpdateProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ AI assistant conversation associated with the process (e.g. records of AI-driven schema generation). """ aiConversation: [AiConversationItemParams!] """Free-text description shown alongside the process.""" description: String """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Process schema as a JSON object conforming to the ProcessSchema type — trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema This payload conforms to the `ProcessSchema` JSON Schema: GET /api/v100/rest/schemas/ProcessSchema.json on your region's API host """ settings: ProcessSchemaJSONString """ Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. """ type: ProcessTypeEnum """Tags attached to the process for organisation/filtering.""" tags: [CreateTagRelationNoProcessBackrefInput!] """Files attached to the process (e.g. process documentation).""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Id of the Process record to delete.""" input DeleteProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProcess mutation.""" type DeleteProcessPayload { """The deleted record.""" process: ProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProcessFromTemplate mutation.""" type CreateProcessFromTemplatePayload { """The created process.""" process: ProcessEntity } """Parameters of the createProcessFromTemplate mutation.""" input CreateProcessFromTemplateInput { """Description of the new process.""" description: String! """Name of the new process.""" name: String! """ Id of the user who owns the new process. Owner placeholders in the template steps are set to this user. """ ownerId: ID! """Id of the process template to create the process from.""" processTemplateId: ID! """Type of the new process.""" type: ProcessTypeEnum! } """Result of the createProcessActivityLog mutation.""" type CreateProcessActivityLogPayload { """The created record.""" processActivityLog: ProcessActivityLogEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProcessActivityLog record.""" input CreateProcessActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the user who triggered the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. """ applicationId: ID! """Total CPU time consumed by the run, in seconds.""" cpuRunTime: Float """ Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). """ endTime: DateTime """ True when the run was triggered as a test (results are not persisted to records). """ isTestRun: Boolean """ Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. """ parentProcessIds: JSONString """Id of the Automatizer process whose run this log records.""" processId: ID! """ Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. """ runId: ID """Timestamp the run started.""" startTime: DateTime! """ Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. """ status: ProcessStatusEnum! } """Result of the updateProcessActivityLog mutation.""" type UpdateProcessActivityLogPayload { """The updated record.""" processActivityLog: ProcessActivityLogEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProcessActivityLog record and the field values to change.""" input UpdateProcessActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the user who triggered the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. """ applicationId: ID """Total CPU time consumed by the run, in seconds.""" cpuRunTime: Float """ Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). """ endTime: DateTime """ True when the run was triggered as a test (results are not persisted to records). """ isTestRun: Boolean """ Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. """ parentProcessIds: JSONString """Id of the Automatizer process whose run this log records.""" processId: ID """ Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. """ runId: ID """Timestamp the run started.""" startTime: DateTime """ Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. """ status: ProcessStatusEnum } """Result of the bulkUpdateProcessActivityLog mutation.""" type BulkUpdateProcessActivityLogPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProcessActivityLog record to create, or to update when its id is set. """ input CreateOrUpdateProcessActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the user who triggered the run, or empty for runs triggered by automation. """ actorId: ID """ Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. """ applicationId: ID """Total CPU time consumed by the run, in seconds.""" cpuRunTime: Float """ Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). """ endTime: DateTime """ True when the run was triggered as a test (results are not persisted to records). """ isTestRun: Boolean """ Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. """ parentProcessIds: JSONString """Id of the Automatizer process whose run this log records.""" processId: ID """ Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. """ runId: ID """Timestamp the run started.""" startTime: DateTime """ Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. """ status: ProcessStatusEnum } """Id of the ProcessActivityLog record to delete.""" input DeleteProcessActivityLogInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProcessActivityLog mutation.""" type DeleteProcessActivityLogPayload { """The deleted record.""" processActivityLog: ProcessActivityLogEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProcessActivityLogLine mutation.""" type CreateProcessActivityLogLinePayload { """The created record.""" processActivityLogLine: ProcessActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProcessActivityLogLine record.""" input CreateProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the process run (activity log) this line belongs to.""" processActivityLogId: ID! """Position of the line within its log run.""" sortOrder: Int! """ Result of the process step recorded by this line, such as Ok, Warning (for example a scheduled action that was canceled) or Error. """ status: ProcessStatusEnum } """Result of the updateProcessActivityLogLine mutation.""" type UpdateProcessActivityLogLinePayload { """The updated record.""" processActivityLogLine: ProcessActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProcessActivityLogLine record and the field values to change.""" input UpdateProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the process run (activity log) this line belongs to.""" processActivityLogId: ID """Position of the line within its log run.""" sortOrder: Int """ Result of the process step recorded by this line, such as Ok, Warning (for example a scheduled action that was canceled) or Error. """ status: ProcessStatusEnum } """Result of the bulkUpdateProcessActivityLogLine mutation.""" type BulkUpdateProcessActivityLogLinePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProcessActivityLogLine record to create, or to update when its id is set. """ input CreateOrUpdateProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. """ executedAt: DateTime """ True when the line is shown in the activity log UI; false for internal-only lines. """ isVisible: Boolean """Id of the process run (activity log) this line belongs to.""" processActivityLogId: ID """Position of the line within its log run.""" sortOrder: Int """ Result of the process step recorded by this line, such as Ok, Warning (for example a scheduled action that was canceled) or Error. """ status: ProcessStatusEnum } """Id of the ProcessActivityLogLine record to delete.""" input DeleteProcessActivityLogLineInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProcessActivityLogLine mutation.""" type DeleteProcessActivityLogLinePayload { """The deleted record.""" processActivityLogLine: ProcessActivityLogLineEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProcessTemplate mutation.""" type CreateProcessTemplatePayload { """The created record.""" processTemplate: ProcessTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProcessTemplate record.""" input CreateProcessTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template does.""" description: String """ True when the platform recommends this template (highlighted in the template gallery). """ isRecommended: Boolean """Name of the entity and its default text representation.""" name: String! """ Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema """ settings: ProcessSchemaJSONString! """ Files attached to the template (e.g. reference documents, screenshots). """ documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the updateProcessTemplate mutation.""" type UpdateProcessTemplatePayload { """The updated record.""" processTemplate: ProcessTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProcessTemplate record and the field values to change.""" input UpdateProcessTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template does.""" description: String """ True when the platform recommends this template (highlighted in the template gallery). """ isRecommended: Boolean """Name of the entity and its default text representation.""" name: String """ Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema """ settings: ProcessSchemaJSONString """ Files attached to the template (e.g. reference documents, screenshots). """ documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateProcessTemplate mutation.""" type BulkUpdateProcessTemplatePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProcessTemplate record to create, or to update when its id is set. """ input CreateOrUpdateProcessTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template does.""" description: String """ True when the platform recommends this template (highlighted in the template gallery). """ isRecommended: Boolean """Name of the entity and its default text representation.""" name: String """ Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema """ settings: ProcessSchemaJSONString """ Files attached to the template (e.g. reference documents, screenshots). """ documents: [CreateCloudObjectRelationNoBackrefInput!] } """Id of the ProcessTemplate record to delete.""" input DeleteProcessTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProcessTemplate mutation.""" type DeleteProcessTemplatePayload { """The deleted record.""" processTemplate: ProcessTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProduct mutation.""" type CreateProductPayload { """The created record.""" product: ProductEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Product record.""" input CreateProductInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Product picture.""" picture: CreateCloudObjectInput """ Whether this product can be added to all pipelines or only the explicitly linked subset (see productPipelineRelations). """ allowedPipelines: AccessPipelinesEnum """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: ID """Free-form description of the product.""" description: String """Name of the product, shown in catalogues and pickers.""" name: String! """Id of the product picture document.""" pictureId: ID """ Id of the product category this product belongs to, or empty when it is not categorized. """ productCategoryId: ID """Id of the product type that classifies this product.""" productTypeId: ID """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: String """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Deprecated pipeline connection.""" productPipelineRelations: [CreateProductPipelineRelationNoProductBackrefInput!] """Configuration of Pipelines where the Product can be used.""" productPipelines: ProductPipelinesInput """ URL of an image to use as the product picture. The image is downloaded from this URL and checked; only pictures are supported. """ pictureSourceUrl: String } """ Field values of a new ProductPipelineRelation record, created together with the record it belongs to. """ input CreateProductPipelineRelationNoProductBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the pipeline in which the product can be added as a line item.""" pipelineId: ID! """Revision when entity was lastly changed.""" revision: Int } """ Pipelines in which a product can be added to opportunities, as set on create or update. """ input ProductPipelinesInput { """ Ids of the pipelines the product can be added in. Effective only when allowedPipelines is Selected. """ pipelines: [ID!]! """ Whether the product can be added in all pipelines (All) or only in those listed in pipelines (Selected). """ allowedPipelines: AccessPipelinesEnum! } """Parameters of the createProduct mutation.""" input SetProductPriceList { """ Which price lists the new products are added to: none (DontSet), all (All) or those in priceListIds (Selected). """ operation: SetProductPriceListOperation! """ Ids of the price lists to add the products to when operation is Selected. """ priceListIds: [UUID!]! } """Which price lists newly created products are added to.""" enum SetProductPriceListOperation { """Products are not added to any price list.""" DontSet """ Products are added to every price list, with a zero price in each currency. """ All """ Products are added to the price lists in priceListIds, with a zero price in each currency. """ Selected } """Result of the updateProduct mutation.""" type UpdateProductPayload { """The updated record.""" product: ProductEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Product record and the field values to change.""" input UpdateProductInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Product picture.""" picture: CreateCloudObjectInput """ Whether this product can be added to all pipelines or only the explicitly linked subset (see productPipelineRelations). """ allowedPipelines: AccessPipelinesEnum """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: ID """Free-form description of the product.""" description: String """Name of the product, shown in catalogues and pickers.""" name: String """Id of the product picture document.""" pictureId: ID """ Id of the product category this product belongs to, or empty when it is not categorized. """ productCategoryId: ID """Id of the product type that classifies this product.""" productTypeId: ID """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: String """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Deprecated pipeline connection.""" productPipelineRelations: [CreateProductPipelineRelationNoProductBackrefInput!] """Configuration of Pipelines where the Product can be used.""" productPipelines: ProductPipelinesInput """ URL of an image to use as the product picture. The image is downloaded from this URL and checked; only pictures are supported. """ pictureSourceUrl: String } """Result of the bulkUpdateProduct mutation.""" type BulkUpdateProductPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Product record to create, or to update when its id is set. """ input CreateOrUpdateProductInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Product picture.""" picture: CreateCloudObjectInput """ Whether this product can be added to all pipelines or only the explicitly linked subset (see productPipelineRelations). """ allowedPipelines: AccessPipelinesEnum """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: ID """Free-form description of the product.""" description: String """Name of the product, shown in catalogues and pickers.""" name: String """Id of the product picture document.""" pictureId: ID """ Id of the product category this product belongs to, or empty when it is not categorized. """ productCategoryId: ID """Id of the product type that classifies this product.""" productTypeId: ID """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: String """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Deprecated pipeline connection.""" productPipelineRelations: [CreateProductPipelineRelationNoProductBackrefInput!] """Configuration of Pipelines where the Product can be used.""" productPipelines: ProductPipelinesInput """ URL of an image to use as the product picture. The image is downloaded from this URL and checked; only pictures are supported. """ pictureSourceUrl: String } """Result of the deleteProduct mutation.""" type DeleteProductPayload { """The deleted record.""" product: ProductEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of the Product record to delete.""" input DeleteProductInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the createProductCategory mutation.""" type CreateProductCategoryPayload { """The created record.""" productCategory: ProductCategoryEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProductCategory record.""" input CreateProductCategoryInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String! """Id of the parent category.""" parentId: ID """Revision when entity was lastly changed.""" revision: Int """All Products in this category.""" productRelations: [CreateProductNoProductCategoryBackrefInput!] } """ Field values of a new Product record, created together with the record it belongs to. """ input CreateProductNoProductCategoryBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Product picture.""" picture: CreateCloudObjectInput """ Whether this product can be added to all pipelines or only the explicitly linked subset (see productPipelineRelations). """ allowedPipelines: AccessPipelinesEnum """Id of the currency exchange rate list applied to this product.""" currencyExchangeRatesListId: ID """Free-form description of the product.""" description: String """Name of the product, shown in catalogues and pickers.""" name: String! """Id of the product picture document.""" pictureId: ID """Id of the product type that classifies this product.""" productTypeId: ID """ Stock-keeping unit (SKU) identifier of the product. Must be unique across products. """ sku: String """ Unit of measure shown next to product quantities (e.g. pcs, kg, hours). """ unitSymbol: String """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """Deprecated pipeline connection.""" productPipelineRelations: [CreateProductPipelineRelationNoProductBackrefInput!] """Configuration of Pipelines where the Product can be used.""" productPipelines: ProductPipelinesInput """ URL of an image to use as the product picture. The image is downloaded from this URL and checked; only pictures are supported. """ pictureSourceUrl: String } """Result of the updateProductCategory mutation.""" type UpdateProductCategoryPayload { """The updated record.""" productCategory: ProductCategoryEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProductCategory record and the field values to change.""" input UpdateProductCategoryInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """Id of the parent category.""" parentId: ID """Revision when entity was lastly changed.""" revision: Int """All Products in this category.""" productRelations: [CreateProductNoProductCategoryBackrefInput!] } """Result of the bulkUpdateProductCategory mutation.""" type BulkUpdateProductCategoryPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProductCategory record to create, or to update when its id is set. """ input CreateOrUpdateProductCategoryInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """Id of the parent category.""" parentId: ID """Revision when entity was lastly changed.""" revision: Int """All Products in this category.""" productRelations: [CreateProductNoProductCategoryBackrefInput!] } """Id of the ProductCategory record to delete.""" input DeleteProductCategoryInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProductCategory mutation.""" type DeleteProductCategoryPayload { """The deleted record.""" productCategory: ProductCategoryEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProductPipelineRelation mutation.""" type CreateProductPipelineRelationPayload { """The created record.""" productPipelineRelation: ProductPipelineRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProductPipelineRelation record.""" input CreateProductPipelineRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the pipeline in which the product can be added as a line item.""" pipelineId: ID! """Id of the product made available in the pipeline.""" productId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateProductPipelineRelation mutation.""" type UpdateProductPipelineRelationPayload { """The updated record.""" productPipelineRelation: ProductPipelineRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProductPipelineRelation record and the field values to change.""" input UpdateProductPipelineRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the pipeline in which the product can be added as a line item.""" pipelineId: ID """Id of the product made available in the pipeline.""" productId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateProductPipelineRelation mutation.""" type BulkUpdateProductPipelineRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProductPipelineRelation record to create, or to update when its id is set. """ input CreateOrUpdateProductPipelineRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the pipeline in which the product can be added as a line item.""" pipelineId: ID """Id of the product made available in the pipeline.""" productId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ProductPipelineRelation record to delete.""" input DeleteProductPipelineRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProductPipelineRelation mutation.""" type DeleteProductPipelineRelationPayload { """The deleted record.""" productPipelineRelation: ProductPipelineRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProductPriceList mutation.""" type CreateProductPriceListPayload { """The created record.""" productPriceList: ProductPriceListEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProductPriceList record.""" input CreateProductPriceListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form description of the price list.""" description: String """Date when the price list expires. Empty means open-ended.""" endDate: Date """ Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates. """ isActive: Boolean """Name of the entity and its default text representation.""" name: String! """ Filter expression — a FieldFilter JSON object — deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/f/#FieldFilter """ rules: JSONString """Date when the price list becomes active. Empty means immediately.""" startDate: Date """ Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled). """ type: ProductPriceListTypeEnum """Revision when entity was lastly changed.""" revision: Int """Per-product, per-currency prices configured in the price list.""" productPriceListPrices: [CreateProductPriceListPriceNoProductPriceListBackrefInput!] } """ Field values of a new ProductPriceListPrice record, created together with the record it belongs to. """ input CreateProductPriceListPriceNoProductPriceListBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency the price is denominated in.""" currencyId: ID! """ Price amount stored at 6-decimal precision; values set via the API are rounded. """ price: Float """Id of the product the price applies to.""" productId: ID! """ Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object. """ settings: ProductPriceListPriceSettingsJSONString! """Revision when entity was lastly changed.""" revision: Int } """ JSON object, sent as a string, conforming to the ProductPriceListPriceSettings type. """ scalar ProductPriceListPriceSettingsJSONString """Result of the updateProductPriceList mutation.""" type UpdateProductPriceListPayload { """The updated record.""" productPriceList: ProductPriceListEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProductPriceList record and the field values to change.""" input UpdateProductPriceListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form description of the price list.""" description: String """Date when the price list expires. Empty means open-ended.""" endDate: Date """ Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates. """ isActive: Boolean """Name of the entity and its default text representation.""" name: String """ Filter expression — a FieldFilter JSON object — deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/f/#FieldFilter """ rules: JSONString """Date when the price list becomes active. Empty means immediately.""" startDate: Date """ Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled). """ type: ProductPriceListTypeEnum """Revision when entity was lastly changed.""" revision: Int """Per-product, per-currency prices configured in the price list.""" productPriceListPrices: [CreateProductPriceListPriceNoProductPriceListBackrefInput!] } """ Whether changed price-list prices are applied to existing opportunities and quotes. """ enum UpdateProductPriceListActionEnum { """ Product lines of all open opportunities and quotes using the price list get the new prices. """ UpdateAll """ Same as UpdateAll, but lines whose price was changed manually keep their price. """ UpdateAllExceptModified """Existing opportunities and quotes keep their prices (default).""" DontUpdatePrices } """Result of the bulkUpdateProductPriceList mutation.""" type BulkUpdateProductPriceListPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProductPriceList record to create, or to update when its id is set. """ input CreateOrUpdateProductPriceListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-form description of the price list.""" description: String """Date when the price list expires. Empty means open-ended.""" endDate: Date """ Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates. """ isActive: Boolean """Name of the entity and its default text representation.""" name: String """ Filter expression — a FieldFilter JSON object — deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/f/#FieldFilter """ rules: JSONString """Date when the price list becomes active. Empty means immediately.""" startDate: Date """ Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled). """ type: ProductPriceListTypeEnum """Revision when entity was lastly changed.""" revision: Int """Per-product, per-currency prices configured in the price list.""" productPriceListPrices: [CreateProductPriceListPriceNoProductPriceListBackrefInput!] } """Id of the ProductPriceList record to delete.""" input DeleteProductPriceListInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProductPriceList mutation.""" type DeleteProductPriceListPayload { """The deleted record.""" productPriceList: ProductPriceListEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProductPriceListPrice mutation.""" type CreateProductPriceListPricePayload { """The created record.""" productPriceListPrice: ProductPriceListPriceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProductPriceListPrice record.""" input CreateProductPriceListPriceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency the price is denominated in.""" currencyId: ID! """ Price amount stored at 6-decimal precision; values set via the API are rounded. """ price: Float """Id of the product the price applies to.""" productId: ID! """Id of the price list this price belongs to.""" productPriceListId: ID! """ Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object. """ settings: ProductPriceListPriceSettingsJSONString! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateProductPriceListPrice mutation.""" type UpdateProductPriceListPricePayload { """The updated record.""" productPriceListPrice: ProductPriceListPriceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProductPriceListPrice record and the field values to change.""" input UpdateProductPriceListPriceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency the price is denominated in.""" currencyId: ID """ Price amount stored at 6-decimal precision; values set via the API are rounded. """ price: Float """Id of the product the price applies to.""" productId: ID """Id of the price list this price belongs to.""" productPriceListId: ID """ Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object. """ settings: ProductPriceListPriceSettingsJSONString """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateProductPriceListPrice mutation.""" type BulkUpdateProductPriceListPricePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProductPriceListPrice record to create, or to update when its id is set. """ input CreateOrUpdateProductPriceListPriceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency the price is denominated in.""" currencyId: ID """ Price amount stored at 6-decimal precision; values set via the API are rounded. """ price: Float """Id of the product the price applies to.""" productId: ID """Id of the price list this price belongs to.""" productPriceListId: ID """ Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object. """ settings: ProductPriceListPriceSettingsJSONString """Revision when entity was lastly changed.""" revision: Int } """Id of the ProductPriceListPrice record to delete.""" input DeleteProductPriceListPriceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProductPriceListPrice mutation.""" type DeleteProductPriceListPricePayload { """The deleted record.""" productPriceListPrice: ProductPriceListPriceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createClientFavorite mutation.""" type CreateClientFavoritePayload { """The created record.""" clientFavorite: ClientFavoriteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ClientFavorite record.""" input CreateClientFavoriteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the favorite account.""" accountId: ID """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: ID """Id of the favorite contact.""" contactId: ID """Id of the favorite custom entity record.""" customEntityId: ID """Id of the favorite email.""" emailId: ID """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the owning user.""" ownerId: ID! """Id of the favorite screen profile.""" profileId: ID """Id of the favorite project.""" projectId: ID """Id of the favorite quote.""" quoteId: ID """Id of the favorite report.""" reportId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateClientFavorite mutation.""" type UpdateClientFavoritePayload { """The updated record.""" clientFavorite: ClientFavoriteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ClientFavorite record and the field values to change.""" input UpdateClientFavoriteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the favorite account.""" accountId: ID """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: ID """Id of the favorite contact.""" contactId: ID """Id of the favorite custom entity record.""" customEntityId: ID """Id of the favorite email.""" emailId: ID """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the owning user.""" ownerId: ID """Id of the favorite screen profile.""" profileId: ID """Id of the favorite project.""" projectId: ID """Id of the favorite quote.""" quoteId: ID """Id of the favorite report.""" reportId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateClientFavorite mutation.""" type BulkUpdateClientFavoritePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ClientFavorite record to create, or to update when its id is set. """ input CreateOrUpdateClientFavoriteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the favorite account.""" accountId: ID """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: ID """Id of the favorite contact.""" contactId: ID """Id of the favorite custom entity record.""" customEntityId: ID """Id of the favorite email.""" emailId: ID """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the owning user.""" ownerId: ID """Id of the favorite screen profile.""" profileId: ID """Id of the favorite project.""" projectId: ID """Id of the favorite quote.""" quoteId: ID """Id of the favorite report.""" reportId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ClientFavorite record to delete.""" input DeleteClientFavoriteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the favorite appointment or task, or empty when not pointing to an activity. """ activityId: ID """ Id of the favorite lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID } """Result of the deleteClientFavorite mutation.""" type DeleteClientFavoritePayload { """The deleted record.""" clientFavorite: ClientFavoriteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProfileRelation mutation.""" type CreateProfileRelationPayload { """The created record.""" profileRelation: ProfileRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProfileRelation record.""" input CreateProfileRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID! """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID } """Result of the updateProfileRelation mutation.""" type UpdateProfileRelationPayload { """The updated record.""" profileRelation: ProfileRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProfileRelation record and the field values to change.""" input UpdateProfileRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID } """Result of the bulkUpdateProfileRelation mutation.""" type BulkUpdateProfileRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProfileRelation record to create, or to update when its id is set. """ input CreateOrUpdateProfileRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID } """Id of the ProfileRelation record to delete.""" input DeleteProfileRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID } """Result of the deleteProfileRelation mutation.""" type DeleteProfileRelationPayload { """The deleted record.""" profileRelation: ProfileRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipProject mutation.""" type ChangeOwnershipProjectPayload { """The record with its new owner.""" result: ProjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipProject mutation.""" input ChangeOwnershipProjectInput { """User who becomes the new owner of the record.""" ownerId: ID! """Sales unit the record is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the record as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """ When true, the new owner and sales unit are also applied to the record's open tasks and appointments and its notes. Linked records that cannot be transferred are skipped without failing the mutation. """ transferLinkedRecords: Boolean! """Identifier of the ProjectEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingProject mutation.""" type ManageSharingProjectPayload { """The record with its updated sharing.""" result: ProjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingProject mutation.""" input ManageSharingProjectInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateProjectSharingClientRelationNoProjectBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateProjectSharingSalesUnitRelationNoProjectBackrefInput!] """Identifier of the ProjectEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new ProjectSharingClientRelation record, created together with the record it belongs to. """ input CreateProjectSharingClientRelationNoProjectBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ProjectSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateProjectSharingSalesUnitRelationNoProjectBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the completeTasksProject mutation.""" type BulkUpdateEntitiesPayload { """ Numbers of updated, failed and skipped records, each with a session for listing them. """ result: BulkUpdatePayload! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Outcome of a bulk change of records: the records that were changed, skipped and failed. """ type BulkUpdatePayload { """ Records that could not be changed. Also includes the skipped records when errorsIncludeSkippedRecords is true. """ errors: BulkUpdateResult! """ Records left unchanged because the user is not allowed to change them, or that are no longer available. """ skipped: BulkUpdateResult! """Records that were changed.""" updated: BulkUpdateResult! } """ Group of records in the outcome of a bulk change, with their count and a session to list them. """ type BulkUpdateResult { """Number of records in this group.""" count: Int! """ How many of these records the user can no longer see, e.g. because they were deleted; they are left out of sessionId. """ notAvailableCount: Int! """ Session that identifies consistent snapshot of the view data used for scrolling """ sessionId: String """First entity id from session.""" firstEntityId: ID } """Parameters of the completeTasksProject mutation.""" input CompleteTasksProjectInput { """ Objective whose tasks are completed; leave empty for the tasks without an objective. """ projectObjectiveId: UUID """Identifier of the ProjectEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the completeProject mutation.""" input CompleteProjectInput { """ When true, every unfinished task linked to the project is marked as completed. """ completeTasks: Boolean! """ When true, appointments linked to the project that have not started yet are deleted. """ deleteUnstartedAppointments: Boolean! """ New start date of the project period; must be sent together with newEndDate. """ newStartDate: Date """ New end date of the project period; must be sent together with newStartDate and must not be before it. """ newEndDate: Date """Identifier of the ProjectEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the reopenProject mutation.""" type ReopenProjectPayload { """The reopened project.""" result: ProjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the reopenProject mutation.""" input ReopenProjectInput { """New start date of the project.""" startDate: Date! """ New end date of the project; must not be before startDate or in the past. """ endDate: Date! """Identifier of the ProjectEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the restoreProject mutation.""" type RestoreProjectPayload { """The restored record.""" result: ProjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreProject mutation.""" input RestoreProjectInput { """Identifier of the ProjectEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProject mutation.""" type CreateProjectPayload { """The created record.""" project: ProjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Project record.""" input CreateProjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the related account.""" accountId: ID """Id of the currency exchange rate list applied to this project.""" currencyExchangeRatesListId: ID """Free-form description of the project.""" description: String """ Planned end date of the project. Must be on or after startDate when both are set. """ endDate: Date! """Name of the entity and its default text representation.""" name: String! """Id of the project owner.""" ownerId: ID! """Id of the project type that classifies this project.""" projectTypeId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when the project starts.""" startDate: Date """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. """ revenueGoal: CurrencyForeignFieldInput """Documents linked to this project.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ Sales units that have been granted shared access to this project. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateProjectSharingSalesUnitRelationNoProjectBackrefInput!] """ Users that have been granted shared access to this project. Editable only when shareMode allows user sharing. """ sharingClients: [CreateProjectSharingClientRelationNoProjectBackrefInput!] """Contacts linked to this project, including the primary-contact flag.""" contactRelations: [CreateProjectContactRelationNoProjectBackrefInput!] """Tag labels applied to this project.""" tags: [CreateTagRelationNoProjectBackrefInput!] """Saved view profiles this project currently matches.""" staticProfiles: [CreateProfileRelationNoProjectBackrefInput!] } """ Field values of a new ProjectContactRelation record, created together with the record it belongs to. """ input CreateProjectContactRelationNoProjectBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to the project.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoProjectBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new ProfileRelation record, created together with the record it belongs to. """ input CreateProfileRelationNoProjectBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """ Id of the linked lead or opportunity, or empty when not pointing to one. """ leadOpptyId: ID """Id of the screen profile.""" profileId: ID! """Id of the linked quote.""" quoteId: ID } """Result of the updateProject mutation.""" type UpdateProjectPayload { """The updated record.""" project: ProjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Project record and the field values to change.""" input UpdateProjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the related account.""" accountId: ID """Id of the currency exchange rate list applied to this project.""" currencyExchangeRatesListId: ID """Free-form description of the project.""" description: String """ Planned end date of the project. Must be on or after startDate when both are set. """ endDate: Date """Name of the entity and its default text representation.""" name: String """Id of the project owner.""" ownerId: ID """Id of the project type that classifies this project.""" projectTypeId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when the project starts.""" startDate: Date """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. """ revenueGoal: CurrencyForeignFieldInput """Documents linked to this project.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ Sales units that have been granted shared access to this project. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateProjectSharingSalesUnitRelationNoProjectBackrefInput!] """ Users that have been granted shared access to this project. Editable only when shareMode allows user sharing. """ sharingClients: [CreateProjectSharingClientRelationNoProjectBackrefInput!] """Contacts linked to this project, including the primary-contact flag.""" contactRelations: [CreateProjectContactRelationNoProjectBackrefInput!] """Tag labels applied to this project.""" tags: [CreateTagRelationNoProjectBackrefInput!] """Saved view profiles this project currently matches.""" staticProfiles: [CreateProfileRelationNoProjectBackrefInput!] } """Result of the bulkUpdateProject mutation.""" type BulkUpdateProjectPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Project record to create, or to update when its id is set. """ input CreateOrUpdateProjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the related account.""" accountId: ID """Id of the currency exchange rate list applied to this project.""" currencyExchangeRatesListId: ID """Free-form description of the project.""" description: String """ Planned end date of the project. Must be on or after startDate when both are set. """ endDate: Date """Name of the entity and its default text representation.""" name: String """Id of the project owner.""" ownerId: ID """Id of the project type that classifies this project.""" projectTypeId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when the project starts.""" startDate: Date """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside. """ revenueGoal: CurrencyForeignFieldInput """Documents linked to this project.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ Sales units that have been granted shared access to this project. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateProjectSharingSalesUnitRelationNoProjectBackrefInput!] """ Users that have been granted shared access to this project. Editable only when shareMode allows user sharing. """ sharingClients: [CreateProjectSharingClientRelationNoProjectBackrefInput!] """Contacts linked to this project, including the primary-contact flag.""" contactRelations: [CreateProjectContactRelationNoProjectBackrefInput!] """Tag labels applied to this project.""" tags: [CreateTagRelationNoProjectBackrefInput!] """Saved view profiles this project currently matches.""" staticProfiles: [CreateProfileRelationNoProjectBackrefInput!] } """Id of the Project record to delete.""" input DeleteProjectInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProject mutation.""" type DeleteProjectPayload { """The deleted record.""" project: ProjectEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the convertProject mutation.""" type ConvertProjectPayload { """The created record.""" project: ProjectEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProjectContactRelation mutation.""" type CreateProjectContactRelationPayload { """The created record.""" projectContactRelation: ProjectContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProjectContactRelation record.""" input CreateProjectContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to the project.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the project the contact is linked to.""" projectId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateProjectContactRelation mutation.""" type UpdateProjectContactRelationPayload { """The updated record.""" projectContactRelation: ProjectContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProjectContactRelation record and the field values to change.""" input UpdateProjectContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to the project.""" contactId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the project the contact is linked to.""" projectId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateProjectContactRelation mutation.""" type BulkUpdateProjectContactRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProjectContactRelation record to create, or to update when its id is set. """ input CreateOrUpdateProjectContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to the project.""" contactId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the project the contact is linked to.""" projectId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ProjectContactRelation record to delete.""" input DeleteProjectContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProjectContactRelation mutation.""" type DeleteProjectContactRelationPayload { """The deleted record.""" projectContactRelation: ProjectContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProjectKpi mutation.""" type CreateProjectKPIPayload { """The created record.""" projectKpi: ProjectKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProjectKPI record.""" input CreateProjectKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, ProjectCompleted or LastModified. """ kpi: ProjectKpiEnum! """Id of the project owner at the time of the event.""" ownerId: ID! """Id of the project this KPI event relates to.""" projectId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateProjectKpi mutation.""" type UpdateProjectKPIPayload { """The updated record.""" projectKpi: ProjectKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProjectKPI record and the field values to change.""" input UpdateProjectKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, ProjectCompleted or LastModified. """ kpi: ProjectKpiEnum """Id of the project owner at the time of the event.""" ownerId: ID """Id of the project this KPI event relates to.""" projectId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateProjectKpi mutation.""" type BulkUpdateProjectKPIPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProjectKPI record to create, or to update when its id is set. """ input CreateOrUpdateProjectKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, ProjectCompleted or LastModified. """ kpi: ProjectKpiEnum """Id of the project owner at the time of the event.""" ownerId: ID """Id of the project this KPI event relates to.""" projectId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ProjectKPI record to delete.""" input DeleteProjectKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProjectKpi mutation.""" type DeleteProjectKPIPayload { """The deleted record.""" projectKpi: ProjectKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateProjectObjectiveSort mutation.""" type UpdateProjectObjectiveSortPayload { """The moved objective.""" result: ProjectObjectiveEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the updateProjectObjectiveSort mutation.""" input UpdateProjectObjectiveSortInput { """ Objective of the same project that this objective is placed before; leave empty to move it to the end. """ beforeId: ID """ Id of an open list view of the project's activities that is reordered to match. Integrations can leave it empty. """ sessionIdToUpdate: String """Identifier of the ProjectObjectiveEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyProjectObjective mutation.""" type CopyProjectObjectivePayload { """The new objective.""" result: ProjectObjectiveEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyProjectObjective mutation.""" input CopyProjectObjectiveInput { """ When true, the objective's tasks are copied as well, as not-started tasks without dates or duration. """ copyTasks: Boolean! """Identifier of the ProjectObjectiveEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateProjectObjectiveActivitiesSort mutation.""" type UpdateProjectObjectiveActivitiesSortPayload { """True when the activities were moved.""" result: Boolean """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the updateProjectObjectiveActivitiesSort mutation.""" input UpdateProjectObjectiveActivitiesSortInput { """Project the activities belong to.""" projectId: ID! """Activities to move; all must be linked to the project.""" ids: [ID!]! """ Activity in the destination objective that the moved activities are placed before; leave empty to add them at the end. """ beforeId: ID """ Objective the activities are moved to; leave empty to move them out of any objective. """ objectiveId: ID """ Id of an open list view of the project's activities that is reordered to match. Integrations can leave it empty. """ sessionIdToUpdate: String """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProjectObjective mutation.""" type CreateProjectObjectivePayload { """The created record.""" projectObjective: ProjectObjectiveEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateProjectObjective mutation.""" type UpdateProjectObjectivePayload { """The updated record.""" projectObjective: ProjectObjectiveEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ProjectObjective record and the field values to change.""" input UpdateProjectObjectiveInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ Id of the project this objective belongs to. Set on create; cannot be changed afterwards. """ projectId: ID """ Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateProjectObjective mutation.""" type BulkUpdateProjectObjectivePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProjectObjective record to create, or to update when its id is set. """ input CreateOrUpdateProjectObjectiveInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Name of the entity and its default text representation.""" name: String """ Id of the project this objective belongs to. Set on create; cannot be changed afterwards. """ projectId: ID """ Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed. """ sortOrder: Int """Revision when entity was lastly changed.""" revision: Int } """Id of the ProjectObjective record to delete.""" input DeleteProjectObjectiveInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the createProjectSharingClientRelation mutation.""" type CreateProjectSharingClientRelationPayload { """The created record.""" projectSharingClientRelation: ProjectSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProjectSharingClientRelation record.""" input CreateProjectSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the shared project.""" projectId: ID! """ Access the sharing gives the user on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateProjectSharingClientRelation mutation.""" type UpdateProjectSharingClientRelationPayload { """The updated record.""" projectSharingClientRelation: ProjectSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a ProjectSharingClientRelation record and the field values to change. """ input UpdateProjectSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared project.""" projectId: ID """ Access the sharing gives the user on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateProjectSharingClientRelation mutation.""" type BulkUpdateProjectSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProjectSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateProjectSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared project.""" projectId: ID """ Access the sharing gives the user on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the ProjectSharingClientRelation record to delete.""" input DeleteProjectSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProjectSharingClientRelation mutation.""" type DeleteProjectSharingClientRelationPayload { """The deleted record.""" projectSharingClientRelation: ProjectSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createProjectSharingSalesUnitRelation mutation.""" type CreateProjectSharingSalesUnitRelationPayload { """The created record.""" projectSharingSalesUnitRelation: ProjectSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new ProjectSharingSalesUnitRelation record.""" input CreateProjectSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared project.""" projectId: ID! """ Access the sharing gives the sales unit on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateProjectSharingSalesUnitRelation mutation.""" type UpdateProjectSharingSalesUnitRelationPayload { """The updated record.""" projectSharingSalesUnitRelation: ProjectSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a ProjectSharingSalesUnitRelation record and the field values to change. """ input UpdateProjectSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared project.""" projectId: ID """ Access the sharing gives the sales unit on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateProjectSharingSalesUnitRelation mutation.""" type BulkUpdateProjectSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ProjectSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateProjectSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared project.""" projectId: ID """ Access the sharing gives the sales unit on the project: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the ProjectSharingSalesUnitRelation record to delete.""" input DeleteProjectSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteProjectSharingSalesUnitRelation mutation.""" type DeleteProjectSharingSalesUnitRelationPayload { """The deleted record.""" projectSharingSalesUnitRelation: ProjectSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipQuote mutation.""" type ChangeOwnershipQuotePayload { """The quote with its new owner.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipQuote mutation.""" input ChangeOwnershipQuoteInput { """User who becomes the new owner of the quote.""" ownerId: ID! """Sales unit the quote is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the quote as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """ When true, the new owner and sales unit are also applied to the quote's open tasks and appointments, its notes, its linked contacts and accounts and its opportunity. Linked records that cannot be transferred are skipped without failing the mutation. """ transferLinkedRecords: Boolean! """Identifier of the QuoteEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingQuote mutation.""" type ManageSharingQuotePayload { """The record with its updated sharing.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingQuote mutation.""" input ManageSharingQuoteInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateQuoteSharingClientRelationNoQuoteBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateQuoteSharingSalesUnitRelationNoQuoteBackrefInput!] """Identifier of the QuoteEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the restoreQuote mutation.""" type RestoreQuotePayload { """The restored record.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreQuote mutation.""" input RestoreQuoteInput { """Identifier of the QuoteEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the archiveQuote mutation.""" type ArchiveQuotePayload { """The archived quote.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the archiveQuote mutation.""" input ArchiveQuoteInput { """ Id of the quote and optional field values to save together with the archive. """ entity: UpdateQuoteInput! """ Ids of tasks linked to the quote, or to an opportunity archived with it, to mark as completed. """ completeActivityIds: [UUID!] """ Archives the quote's opportunity when its id is listed and it is still open; other ids are ignored. """ archiveOpportunityIds: [UUID!] """Marks all tasks of the quote's opportunity as completed.""" completeAllRelatedOpportunitiesTasks: Boolean """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Quote record and the field values to change.""" input UpdateQuoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: ID """Free-form description of the quote.""" description: String """Date after which the quote is no longer considered valid.""" expirationDate: Date """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Name of the entity and its default text representation.""" name: String """Id of the opportunity.""" opptyId: ID """Id of the quote owner.""" ownerId: ID """Id of the currency used for product line-item prices on this quote.""" productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: JSONString """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: String """Id of the quote type that classifies this quote.""" quoteTypeId: ID """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the quote-process step.""" stepId: ID """Id of the sales unit.""" unitId: ID """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. """ totalAmount: CurrencyForeignFieldInput """ Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to totalAmount. """ productRelations: [CreateOrUpdateOpptyProductRelationNoBackrefInput!] """Contacts linked to this quote.""" contactRelations: [CreateQuoteContactRelationNoQuoteBackrefInput!] """Accounts linked to this quote, including the primary-account flag.""" accountRelations: [CreateQuoteAccountRelationNoQuoteBackrefInput!] """Documents linked to this quote.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ Sales units that have been granted shared access to this quote. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateQuoteSharingSalesUnitRelationNoQuoteBackrefInput!] """ Users that have been granted shared access to this quote. Editable only when shareMode allows user sharing. """ sharingClients: [CreateQuoteSharingClientRelationNoQuoteBackrefInput!] """If quote is set as active in opportunity.""" isActiveInOpportunity: Boolean """Saved view profiles this quote currently matches.""" staticProfiles: [CreateProfileRelationNoQuoteBackrefInput!] """Tag labels applied to this quote.""" tags: [CreateTagRelationNoQuoteBackrefInput!] } """Result of the reactivateQuote mutation.""" type ReactivateQuotePayload { """The reactivated quote.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the reactivateQuote mutation.""" input ReactivateQuoteInput { """Id of the archived quote.""" id: UUID! """ New expiration date of the quote; when empty, the current expiration date is kept. """ closingDate: Date """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the moveQuote mutation.""" type MoveQuotePayload { """The moved quote.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the moveQuote mutation.""" input MoveQuoteInput { """ Id of the quote, the target step (stepId) and any field values to save with the move. """ entity: UpdateQuoteInput! """ Ids of tasks linked to the quote or affected records to mark as completed. """ completeActivityIds: [UUID!] """ Moves the quote's opportunity to its won step when its id is listed and it is still open; other ids are ignored. """ winOpportunityIds: [UUID!] """Ids of other quotes of the same opportunity to archive.""" archiveQuoteIds: [UUID!] """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changePipelineQuote mutation.""" type ChangePipelineQuotePayload { """The updated quote.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changePipelineQuote mutation.""" input ChangePipelineQuoteInput { """ Id of the quote, the target stepId, an optional new ownerId or unitId, and any other field values to save. """ entity: UpdateQuoteInput! """ Adds the previous owner as an editor of the quote; a private quote becomes shared. """ keepOwnerAsEditor: Boolean! """Gives the new owner the quote's open activities and its notes.""" transferLinkedRecords: Boolean! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeQuoteProcess mutation.""" type ChangeQuoteProcessPayload { """The updated quote.""" result: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeQuoteProcess mutation.""" input ChangeQuoteProcessInput { """ Id of the quote, the new quoteTypeId and stepId, an optional new ownerId or unitId, and any other field values to save. """ entity: UpdateQuoteInput! """ Adds the previous owner as an editor of the quote; a private quote becomes shared. """ keepOwnerAsEditor: Boolean! """Gives the new owner the quote's open activities and its notes.""" transferLinkedRecords: Boolean! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuote mutation.""" type CreateQuotePayload { """The created record.""" quote: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Quote record.""" input CreateQuoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: ID """Free-form description of the quote.""" description: String """Date after which the quote is no longer considered valid.""" expirationDate: Date """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Name of the entity and its default text representation.""" name: String! """Id of the opportunity.""" opptyId: ID """Id of the quote owner.""" ownerId: ID! """Id of the currency used for product line-item prices on this quote.""" productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: JSONString """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: String """Id of the quote type that classifies this quote.""" quoteTypeId: ID """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the quote-process step.""" stepId: ID! """Id of the sales unit.""" unitId: ID """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. """ totalAmount: CurrencyForeignFieldInput """ Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to totalAmount. """ productRelations: [CreateOpptyProductRelationNoBackrefInput!] """Contacts linked to this quote.""" contactRelations: [CreateQuoteContactRelationNoQuoteBackrefInput!] """Accounts linked to this quote, including the primary-account flag.""" accountRelations: [CreateQuoteAccountRelationNoQuoteBackrefInput!] """Documents linked to this quote.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ Sales units that have been granted shared access to this quote. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateQuoteSharingSalesUnitRelationNoQuoteBackrefInput!] """ Users that have been granted shared access to this quote. Editable only when shareMode allows user sharing. """ sharingClients: [CreateQuoteSharingClientRelationNoQuoteBackrefInput!] """If quote is set as active in opportunity.""" isActiveInOpportunity: Boolean """Saved view profiles this quote currently matches.""" staticProfiles: [CreateProfileRelationNoQuoteBackrefInput!] """Tag labels applied to this quote.""" tags: [CreateTagRelationNoQuoteBackrefInput!] } """Result of the updateQuote mutation.""" type UpdateQuotePayload { """The updated record.""" quote: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkUpdateQuote mutation.""" type BulkUpdateQuotePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Quote record to create, or to update when its id is set. """ input CreateOrUpdateQuoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the currency exchange rate list applied to this quote.""" currencyExchangeRatesListId: ID """Free-form description of the quote.""" description: String """Date after which the quote is no longer considered valid.""" expirationDate: Date """ True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. """ isArchived: Boolean """Name of the entity and its default text representation.""" name: String """Id of the opportunity.""" opptyId: ID """Id of the quote owner.""" ownerId: ID """Id of the currency used for product line-item prices on this quote.""" productCurrencyId: ID """ Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults. """ productPriceListId: ID """ Product sections grouping the record's line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProductSection This payload conforms to the `ProductSection` JSON Schema: GET /api/v100/rest/schemas/ProductSection.json on your region's API host """ productSections: JSONString """ Free-text company email captured at quote creation when no Account record has been linked yet. """ quickAccountEmail: String """ Free-text company name captured at quote creation when no Account record has been linked yet. """ quickAccountName: String """ Free-text company phone captured at quote creation when no Account record has been linked yet. """ quickAccountPhone: String """ Free-text contact name captured at quote creation when no Contact record has been linked yet. """ quickContactName: String """ Free-text contact email captured at quote creation when no Contact record has been linked yet. """ quickEmail: String """ Free-text contact phone captured at quote creation when no Contact record has been linked yet. """ quickPhone: String """Id of the quote type that classifies this quote.""" quoteTypeId: ID """Free-form note explaining why the quote was archived (lost).""" reasonOfCloseDescription: String """ Id of the reason of close option selected when the quote was archived (lost). """ reasonOfCloseId: ID """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. """ shareMode: ShareModeEnum """Id of the quote-process step.""" stepId: ID """Id of the sales unit.""" unitId: ID """ Revision number of the quote, incremented when a new version of the same quote is created. """ version: Int """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. """ totalAmount: CurrencyForeignFieldInput """ Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to totalAmount. """ productRelations: [CreateOrUpdateOpptyProductRelationNoBackrefInput!] """Contacts linked to this quote.""" contactRelations: [CreateQuoteContactRelationNoQuoteBackrefInput!] """Accounts linked to this quote, including the primary-account flag.""" accountRelations: [CreateQuoteAccountRelationNoQuoteBackrefInput!] """Documents linked to this quote.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """ Sales units that have been granted shared access to this quote. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateQuoteSharingSalesUnitRelationNoQuoteBackrefInput!] """ Users that have been granted shared access to this quote. Editable only when shareMode allows user sharing. """ sharingClients: [CreateQuoteSharingClientRelationNoQuoteBackrefInput!] """If quote is set as active in opportunity.""" isActiveInOpportunity: Boolean """Saved view profiles this quote currently matches.""" staticProfiles: [CreateProfileRelationNoQuoteBackrefInput!] """Tag labels applied to this quote.""" tags: [CreateTagRelationNoQuoteBackrefInput!] } """Id of the Quote record to delete.""" input DeleteQuoteInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuote mutation.""" type DeleteQuotePayload { """The deleted record.""" quote: QuoteEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkArchiveQuote mutation.""" type BulkArchiveQuotePayload { """Ids of the archived quotes and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkArchiveQuote mutation.""" input BulkArchiveQuoteInput { """ Quotes to archive: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """Field values saved on every archived quote.""" entity: CreateOrUpdateQuoteInput! """Ids of linked tasks to mark as completed.""" completeActivityIds: [UUID!] = null """Opportunities of these quotes to archive when still open.""" archiveOpportunityIds: [UUID!] = null """Marks all tasks of each quote's opportunity as completed.""" completeAllRelatedOpportunitiesTasks: Boolean = false """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkReactivateQuote mutation.""" type BulkReactivateQuotePayload { """Ids of the reactivated quotes and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkReactivateQuote mutation.""" input BulkReactivateQuoteInput { """ Quotes to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """ New expiration date set on every reactivated quote; when empty, each quote keeps its current expiration date. """ expirationDate: Date """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkMoveQuote mutation.""" type BulkMoveQuotePayload { """Ids of the moved quotes and the items that failed.""" result: BulkUpdateResults! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkMoveQuote mutation.""" input BulkMoveQuoteInput { """ Quotes to move: includedIds minus excludedIds. Integrations can leave sessionId empty. """ bulkFilter: BulkOperationInput! """Target step (stepId) and field values applied to every quote.""" entity: CreateOrUpdateQuoteInput! """Ids of linked tasks to mark as completed.""" completeActivityIds: [UUID!] = null """ Opportunities of these quotes to move to their won step when still open. """ winOpportunityIds: [UUID!] = null """Ids of other quotes of the same opportunities to archive.""" archiveQuoteIds: [UUID!] = null """ ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. """ rollbackMethod: RollbackMethod = ROLLBACK_ALL """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the convertQuote mutation.""" type ConvertQuotePayload { """The created record.""" quote: QuoteEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuoteAccountRelation mutation.""" type CreateQuoteAccountRelationPayload { """The created record.""" quoteAccountRelation: QuoteAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new QuoteAccountRelation record.""" input CreateQuoteAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to this quote.""" accountId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the quote the account is linked to.""" quoteId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateQuoteAccountRelation mutation.""" type UpdateQuoteAccountRelationPayload { """The updated record.""" quoteAccountRelation: QuoteAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a QuoteAccountRelation record and the field values to change.""" input UpdateQuoteAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to this quote.""" accountId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the quote the account is linked to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateQuoteAccountRelation mutation.""" type BulkUpdateQuoteAccountRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a QuoteAccountRelation record to create, or to update when its id is set. """ input CreateOrUpdateQuoteAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the account linked to this quote.""" accountId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the quote the account is linked to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the QuoteAccountRelation record to delete.""" input DeleteQuoteAccountRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuoteAccountRelation mutation.""" type DeleteQuoteAccountRelationPayload { """The deleted record.""" quoteAccountRelation: QuoteAccountRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuoteContactRelation mutation.""" type CreateQuoteContactRelationPayload { """The created record.""" quoteContactRelation: QuoteContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new QuoteContactRelation record.""" input CreateQuoteContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to this quote.""" contactId: ID! """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean! """Id of the quote the contact is linked to.""" quoteId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateQuoteContactRelation mutation.""" type UpdateQuoteContactRelationPayload { """The updated record.""" quoteContactRelation: QuoteContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a QuoteContactRelation record and the field values to change.""" input UpdateQuoteContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to this quote.""" contactId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the quote the contact is linked to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateQuoteContactRelation mutation.""" type BulkUpdateQuoteContactRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a QuoteContactRelation record to create, or to update when its id is set. """ input CreateOrUpdateQuoteContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the contact linked to this quote.""" contactId: ID """ True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. """ isPrimary: Boolean """Id of the quote the contact is linked to.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the QuoteContactRelation record to delete.""" input DeleteQuoteContactRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuoteContactRelation mutation.""" type DeleteQuoteContactRelationPayload { """The deleted record.""" quoteContactRelation: QuoteContactRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuoteDataExRelation mutation.""" type CreateQuoteDataExRelationPayload { """The created record.""" quoteDataExRelation: QuoteDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new QuoteDataExRelation record.""" input CreateQuoteDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the selected option.""" dataId: ID! """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID! """Id of the quote on which the option is selected.""" quoteId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateQuoteDataExRelation mutation.""" type UpdateQuoteDataExRelationPayload { """The updated record.""" quoteDataExRelation: QuoteDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a QuoteDataExRelation record and the field values to change.""" input UpdateQuoteDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Id of the quote on which the option is selected.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateQuoteDataExRelation mutation.""" type BulkUpdateQuoteDataExRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a QuoteDataExRelation record to create, or to update when its id is set. """ input CreateOrUpdateQuoteDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the selected option.""" dataId: ID """ Id of the data set (the option list of a multi-select field) the selected option belongs to. """ dataSetId: ID """Id of the quote on which the option is selected.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the QuoteDataExRelation record to delete.""" input DeleteQuoteDataExRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuoteDataExRelation mutation.""" type DeleteQuoteDataExRelationPayload { """The deleted record.""" quoteDataExRelation: QuoteDataExRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuoteKpi mutation.""" type CreateQuoteKPIPayload { """The created record.""" quoteKpi: QuoteKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new QuoteKPI record.""" input CreateQuoteKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, Accept, Archive, LastMove or LastModified. """ kpi: QuoteKpiEnum! """Id of the quote owner at the time of the event.""" ownerId: ID! """Id of the quote this KPI event relates to.""" quoteId: ID! """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateQuoteKpi mutation.""" type UpdateQuoteKPIPayload { """The updated record.""" quoteKpi: QuoteKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a QuoteKPI record and the field values to change.""" input UpdateQuoteKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, Accept, Archive, LastMove or LastModified. """ kpi: QuoteKpiEnum """Id of the quote owner at the time of the event.""" ownerId: ID """Id of the quote this KPI event relates to.""" quoteId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateQuoteKpi mutation.""" type BulkUpdateQuoteKPIPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a QuoteKPI record to create, or to update when its id is set. """ input CreateOrUpdateQuoteKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). """ applicationId: ID """Id of the user who triggered the event.""" clientId: ID """ KPI metric this event represents: Create, Accept, Archive, LastMove or LastModified. """ kpi: QuoteKpiEnum """Id of the quote owner at the time of the event.""" ownerId: ID """Id of the quote this KPI event relates to.""" quoteId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the QuoteKPI record to delete.""" input DeleteQuoteKPIInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuoteKpi mutation.""" type DeleteQuoteKPIPayload { """The deleted record.""" quoteKpi: QuoteKPIEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuoteProcess mutation.""" type CreateQuoteProcessPayload { """The created record.""" quoteProcess: QuoteProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new QuoteProcess record.""" input CreateQuoteProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int """Steps that make up this quote process, in evaluation order.""" steps: [CreateStepNoQuoteProcessBackrefInput!]! } """ Field values of a new Step record, created together with the record it belongs to. """ input CreateStepNoQuoteProcessBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String! """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """Id of the opportunity pipeline.""" pipelineId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateStepChecklistNoStepBackrefInput!] } """Result of the updateQuoteProcess mutation.""" type UpdateQuoteProcessPayload { """The updated record.""" quoteProcess: QuoteProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a QuoteProcess record and the field values to change.""" input UpdateQuoteProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """Steps that make up this quote process, in evaluation order.""" steps: [CreateOrUpdateStepNoQuoteProcessBackrefInput!] } """ Field values of a Step record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateStepNoQuoteProcessBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """Id of the opportunity pipeline.""" pipelineId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateOrUpdateStepChecklistNoStepBackrefInput!] } """Result of the bulkUpdateQuoteProcess mutation.""" type BulkUpdateQuoteProcessPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a QuoteProcess record to create, or to update when its id is set. """ input CreateOrUpdateQuoteProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. """ color: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int """Steps that make up this quote process, in evaluation order.""" steps: [CreateOrUpdateStepNoQuoteProcessBackrefInput!] } """Id of the QuoteProcess record to delete.""" input DeleteQuoteProcessInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuoteProcess mutation.""" type DeleteQuoteProcessPayload { """The deleted record.""" quoteProcess: QuoteProcessEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuoteSharingClientRelation mutation.""" type CreateQuoteSharingClientRelationPayload { """The created record.""" quoteSharingClientRelation: QuoteSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new QuoteSharingClientRelation record.""" input CreateQuoteSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """Id of the shared quote.""" quoteId: ID! """ Access the sharing gives the user on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateQuoteSharingClientRelation mutation.""" type UpdateQuoteSharingClientRelationPayload { """The updated record.""" quoteSharingClientRelation: QuoteSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a QuoteSharingClientRelation record and the field values to change. """ input UpdateQuoteSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared quote.""" quoteId: ID """ Access the sharing gives the user on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateQuoteSharingClientRelation mutation.""" type BulkUpdateQuoteSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a QuoteSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateQuoteSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """Id of the shared quote.""" quoteId: ID """ Access the sharing gives the user on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the QuoteSharingClientRelation record to delete.""" input DeleteQuoteSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuoteSharingClientRelation mutation.""" type DeleteQuoteSharingClientRelationPayload { """The deleted record.""" quoteSharingClientRelation: QuoteSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createQuoteSharingSalesUnitRelation mutation.""" type CreateQuoteSharingSalesUnitRelationPayload { """The created record.""" quoteSharingSalesUnitRelation: QuoteSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new QuoteSharingSalesUnitRelation record.""" input CreateQuoteSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared quote.""" quoteId: ID! """ Access the sharing gives the sales unit on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateQuoteSharingSalesUnitRelation mutation.""" type UpdateQuoteSharingSalesUnitRelationPayload { """The updated record.""" quoteSharingSalesUnitRelation: QuoteSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a QuoteSharingSalesUnitRelation record and the field values to change. """ input UpdateQuoteSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared quote.""" quoteId: ID """ Access the sharing gives the sales unit on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateQuoteSharingSalesUnitRelation mutation.""" type BulkUpdateQuoteSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a QuoteSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateQuoteSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the shared quote.""" quoteId: ID """ Access the sharing gives the sales unit on the quote: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the QuoteSharingSalesUnitRelation record to delete.""" input DeleteQuoteSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteQuoteSharingSalesUnitRelation mutation.""" type DeleteQuoteSharingSalesUnitRelationPayload { """The deleted record.""" quoteSharingSalesUnitRelation: QuoteSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipReport mutation.""" type ChangeOwnershipReportPayload { """The report with its new owner.""" result: ReportEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipReport mutation.""" input ChangeOwnershipReportInput { """User who becomes the new owner of the report.""" ownerId: ID! """ When true, the previous owner (if still an active user) keeps the report shared with the Watcher role, and a Private sharing mode is switched to Standard. """ keepOwnerAsWatcher: Boolean! """ When true, the calling user's own delivery schedule of this report is copied to the new owner, replacing any schedule the new owner already has on it. """ copyScheduledReport: Boolean! """Identifier of the ReportEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the setScheduleReport mutation.""" type SetScheduleReportPayload { """The report with its updated schedule.""" result: ReportEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the setScheduleReport mutation.""" input SetScheduleReportInput { """ Delivery schedule conforming to the ReportScheduleSchema type, with the recurrence in schedule, the email to send in email (recipients, sending account, body and report attachment) and an optional follow-up task in followUp. Validated on write, including that the sending email account is available. """ settings: ReportScheduleSchemaParams! """Identifier of the ReportEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Settings of a scheduled report: when it runs, the email it sends and an optional follow-up task. """ input ReportScheduleSchemaParams { """Recurrence defining when the report is generated and emailed.""" schedule: ReportScheduleParams! """ Email delivered on each run: recipients, sending account, content and report attachment options. """ email: ScheduledReportEmailParams! """Optional follow-up task created each time the report email is sent.""" followUp: EmailFollowUpTaskParams """ IANA timezone name used to interpret the schedule times (e.g. "Europe/Bratislava"). """ timezone: String """ When true, the scheduled email is not sent on runs where the report contains no data. """ skipEmpty: Boolean! = false """When true, scheduled runs that fall on a weekend are skipped.""" workingDaysOnly: Boolean = false } """ When a scheduled report runs: once at a given date and time, or repeatedly at a time of day on chosen days. """ input ReportScheduleParams { """ Date and time the schedule runs once. Set for a one-time schedule; left empty for recurring schedules that use the time-of-day and day fields instead. """ date: DateTime """ Time of day a recurring schedule runs, in minutes after midnight (0 to 1439). """ timeOfDay: Int """Weekdays a weekly schedule runs on, from 1 (Monday) to 7 (Sunday).""" dayOfWeek: [Int!] """Days of the month a monthly schedule runs on, from 1 to 31.""" dayOfMonth: [Int!] } """ Email that delivers a scheduled report: recipients, sending account, content and the attached report file. """ input ScheduledReportEmailParams { """ Primary recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ recipients: [SendEmailRecipientParams!]! """ Carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ cc: [SendEmailRecipientParams!]! """ Blind carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record. """ bcc: [SendEmailRecipientParams!]! """ Subject line of the email. May contain personalization tags resolved from the triggered record. """ subject: String! """ HTML body of the email. May contain personalization tags resolved from the triggered record. """ body: String! """ Email template to use for the message. When set, the template supplies the subject and body. """ emailTemplateId: UUID """Stored files attached to the email.""" attachments: [UUID!]! """Signature appended to the email body.""" signature: String """ When true, the sent report email is linked to its recipient records (accounts/contacts) so it appears in their activity feed. """ linkRecipients: Boolean = true """ Email account used to send the report, described as a `SendEmailService` (personal, company, or client personal account). """ service: SendEmailServiceParams! """ Legacy sending-provider selector (O365, Google, or SendGrid) kept for report settings created before per-account sending was introduced. Prefer `service`. """ personalAccount: EmailServiceTypeEnum """ Settings for the report file attached to the email (format and compression). When omitted, the email must instead include the report download link in its subject or body. """ reportAttachment: ScheduledReportEmailAttachmentParams } """ Email account an email is sent from: the sender's own account, a shared company account or, for a mass email, a client personal email account. """ input SendEmailServiceParams { """ Identifier of the sender's own connected email account to send from. Exactly one of the account fields may be set. """ personalAccountId: UUID """ Identifier of a shared company email account to send from. Exactly one of the account fields may be set. """ companyAccountId: UUID """ Identifier of a client personal email account to send from. Valid only for mass email. Exactly one of the account fields may be set. """ clientPersonalEmailAccountId: UUID } """ Report file attached to a scheduled report email: its format, and whether it is zipped and password-protected. """ input ScheduledReportEmailAttachmentParams { """ Render the attached report as a CSV file with these options. Exactly one of the format fields may be set. """ formatCsv: CsvOptionsParams """ Render the attached report as an XLSX file with these options. Exactly one of the format fields may be set. """ formatXlsx: XlsxOptionsParams """ When true, attach the report as HTML. Exactly one of the format fields may be set. """ formatHtml: Boolean = false """ Render the attached report as a PDF with these options. Exactly one of the format fields may be set. """ formatPdf: PdfOptionsParams """ When true, the report attachment is delivered as a compressed ZIP archive. """ compress: Boolean = false """ Password protecting the compressed attachment. Can only be set when `compress` is enabled. """ password: String """ True when the stored `password` value is already encrypted rather than plain text. """ isPasswordEncrypted: Boolean = false } """Options of a scheduled report attached to its email as a CSV file.""" input CsvOptionsParams { """ When true, monetary values are also rendered in each record's foreign currency alongside the base-currency amounts. """ includeForeignCurrency: Boolean = false """ Character separating fields in the generated CSV: comma, semicolon, tab or colon. """ delimiter: CsvDelimiter """ Character used to quote field values that contain the delimiter: double quotation mark or apostrophe. """ quotechar: CsvQuotechar """Character encoding of the generated CSV file (e.g. "UTF-8").""" encoding: String = "UTF-8" } """ Options of a scheduled report attached to its email as an Excel (XLSX) file. """ input XlsxOptionsParams { """ When true, monetary values are also rendered in each record's foreign currency alongside the base-currency amounts. """ includeForeignCurrency: Boolean = false """ Level of detail of the generated XLSX export: a "simplified" layout or the "full" report. """ type: ReportXlsxType } """Options of a scheduled report attached to its email as a PDF file.""" input PdfOptionsParams { """Width of the PDF page, in inches.""" pageWidth: Float! """Height of the PDF page, in inches.""" pageHeight: Float! """ When true, the PDF is laid out in landscape orientation; otherwise portrait. """ landscape: Boolean! """ Scaling factor applied when rendering the report into the PDF, where 1.0 is full size. """ scale: Float! """When true, page numbers are printed on the generated PDF.""" pageNumbers: Boolean! """ Which parts of the report to include in the PDF: All content, only Charts, or only the Table. """ content: ReportContent! } """Follow-up task created each time a scheduled report email is sent.""" input EmailFollowUpTaskParams { """ Activity type assigned to the follow-up task created when the report email is sent. """ taskTypeId: ID! """ Number of business days after the report email is sent that the follow-up task is due (0 = the sending day). Either this or `dueDate` must be set, but not both. """ dueDateOffset: Int """ Explicit due date for the follow-up task. Either this or `dueDateOffset` must be set, but not both. """ dueDate: Date } """Result of the removeScheduleReport mutation.""" type RemoveScheduleReportPayload { """The report.""" result: ReportEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the removeScheduleReport mutation.""" input RemoveScheduleReportInput { """Identifier of the ReportEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createReportSchedule mutation.""" type CreateReportSchedulePayload { """The created record.""" reportSchedule: ReportScheduleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateReportSchedule mutation.""" type UpdateReportSchedulePayload { """The updated record.""" reportSchedule: ReportScheduleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a ReportSchedule record and the field values to change.""" input UpdateReportScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the owning user.""" ownerId: ID """Id of the scheduled report.""" reportId: ID """ Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document. This payload conforms to the `ReportScheduleSchema` JSON Schema: GET /api/v100/rest/schemas/ReportScheduleSchema.json on your region's API host """ settings: ReportScheduleSchemaJSONString """Revision when entity was lastly changed.""" revision: Int """Files attached to scheduled emails sent for this report.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the bulkUpdateReportSchedule mutation.""" type BulkUpdateReportSchedulePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a ReportSchedule record to create, or to update when its id is set. """ input CreateOrUpdateReportScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the owning user.""" ownerId: ID """Id of the scheduled report.""" reportId: ID """ Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document. This payload conforms to the `ReportScheduleSchema` JSON Schema: GET /api/v100/rest/schemas/ReportScheduleSchema.json on your region's API host """ settings: ReportScheduleSchemaJSONString """Revision when entity was lastly changed.""" revision: Int """Files attached to scheduled emails sent for this report.""" documents: [CreateCloudObjectRelationNoBackrefInput!] } """Id of the ReportSchedule record to delete.""" input DeleteReportScheduleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteReportSchedule mutation.""" type DeleteReportSchedulePayload { """The deleted record.""" reportSchedule: ReportScheduleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createSalesRole mutation.""" type CreateSalesRolePayload { """The created record.""" salesRole: SalesRoleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new SalesRole record.""" input CreateSalesRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ colorCode: Int! """Name of the entity and its default text representation.""" name: String! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateSalesRole mutation.""" type UpdateSalesRolePayload { """The updated record.""" salesRole: SalesRoleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a SalesRole record and the field values to change.""" input UpdateSalesRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ colorCode: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateSalesRole mutation.""" type BulkUpdateSalesRolePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a SalesRole record to create, or to update when its id is set. """ input CreateOrUpdateSalesRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ colorCode: Int """Name of the entity and its default text representation.""" name: String """Revision when entity was lastly changed.""" revision: Int } """Id of the SalesRole record to delete.""" input DeleteSalesRoleInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteSalesRole mutation.""" type DeleteSalesRolePayload { """The deleted record.""" salesRole: SalesRoleEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createSalesUnit mutation.""" type CreateSalesUnitPayload { """The created record.""" salesUnit: SalesUnitEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new SalesUnit record.""" input CreateSalesUnitInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture (logo) of the sales unit.""" picture: CreateCloudObjectInput """Name of the entity and its default text representation.""" name: String! """Id of the parent unit, or empty for the root unit.""" parentId: ID """Id of the picture cloud object.""" pictureId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateSalesUnit mutation.""" type UpdateSalesUnitPayload { """The updated record.""" salesUnit: SalesUnitEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a SalesUnit record and the field values to change.""" input UpdateSalesUnitInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture (logo) of the sales unit.""" picture: CreateCloudObjectInput """Name of the entity and its default text representation.""" name: String """Id of the parent unit, or empty for the root unit.""" parentId: ID """Id of the picture cloud object.""" pictureId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateSalesUnit mutation.""" type BulkUpdateSalesUnitPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a SalesUnit record to create, or to update when its id is set. """ input CreateOrUpdateSalesUnitInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Profile picture (logo) of the sales unit.""" picture: CreateCloudObjectInput """Name of the entity and its default text representation.""" name: String """Id of the parent unit, or empty for the root unit.""" parentId: ID """Id of the picture cloud object.""" pictureId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the SalesUnit record to delete.""" input DeleteSalesUnitInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteSalesUnit mutation.""" type DeleteSalesUnitPayload { """The deleted record.""" salesUnit: SalesUnitEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createSolution mutation.""" type CreateSolutionPayload { """The created record.""" solution: SolutionEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Solution record.""" input CreateSolutionInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of the solution.""" description: String """Name of the entity and its default text representation.""" name: String! """Id of the owning user.""" ownerId: ID! """ Canvas of the solution as a JSON object conforming to the SolutionSchema type, with nodes, edges and groups. Validated on write; an invalid canvas is rejected. Full structure: https://developers.coevera.com/reference/graphql/types/s/#SolutionSchema """ settings: SolutionSchemaJSONString """Template this solution was created from, if any.""" solutionTemplateId: ID """Tags attached to the solution for organisation/filtering.""" tags: [CreateTagRelationNoSolutionBackrefInput!] } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoSolutionBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateSolution mutation.""" type UpdateSolutionPayload { """The updated record.""" solution: SolutionEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Solution record and the field values to change.""" input UpdateSolutionInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of the solution.""" description: String """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Canvas of the solution as a JSON object conforming to the SolutionSchema type, with nodes, edges and groups. Validated on write; an invalid canvas is rejected. Full structure: https://developers.coevera.com/reference/graphql/types/s/#SolutionSchema """ settings: SolutionSchemaJSONString """Template this solution was created from, if any.""" solutionTemplateId: ID """Tags attached to the solution for organisation/filtering.""" tags: [CreateTagRelationNoSolutionBackrefInput!] } """Result of the bulkUpdateSolution mutation.""" type BulkUpdateSolutionPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Solution record to create, or to update when its id is set. """ input CreateOrUpdateSolutionInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of the solution.""" description: String """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ Canvas of the solution as a JSON object conforming to the SolutionSchema type, with nodes, edges and groups. Validated on write; an invalid canvas is rejected. Full structure: https://developers.coevera.com/reference/graphql/types/s/#SolutionSchema """ settings: SolutionSchemaJSONString """Template this solution was created from, if any.""" solutionTemplateId: ID """Tags attached to the solution for organisation/filtering.""" tags: [CreateTagRelationNoSolutionBackrefInput!] } """Id of the Solution record to delete.""" input DeleteSolutionInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteSolution mutation.""" type DeleteSolutionPayload { """The deleted record.""" solution: SolutionEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createSolutionTemplate mutation.""" type CreateSolutionTemplatePayload { """The created record.""" solutionTemplate: SolutionTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new SolutionTemplate record.""" input CreateSolutionTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template sets up.""" description: String """Name of the entity and its default text representation.""" name: String! """URL of the template preview image shown in the template gallery.""" previewImageUrl: String """ Full template definition: the blueprint canvas (placeholder record ids), per-node creation blueprints and admin prerequisites. Instantiated into real records on create-from-template; clients only ever read the derived SolutionTemplateSchema projection. Full structure: https://developers.coevera.com/reference/graphql/types/s/#SolutionTemplateSchema """ settings: JSONString! } """Result of the updateSolutionTemplate mutation.""" type UpdateSolutionTemplatePayload { """The updated record.""" solutionTemplate: SolutionTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a SolutionTemplate record and the field values to change.""" input UpdateSolutionTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template sets up.""" description: String """Name of the entity and its default text representation.""" name: String """URL of the template preview image shown in the template gallery.""" previewImageUrl: String """ Full template definition: the blueprint canvas (placeholder record ids), per-node creation blueprints and admin prerequisites. Instantiated into real records on create-from-template; clients only ever read the derived SolutionTemplateSchema projection. Full structure: https://developers.coevera.com/reference/graphql/types/s/#SolutionTemplateSchema """ settings: JSONString } """Result of the bulkUpdateSolutionTemplate mutation.""" type BulkUpdateSolutionTemplatePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a SolutionTemplate record to create, or to update when its id is set. """ input CreateOrUpdateSolutionTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description of what the template sets up.""" description: String """Name of the entity and its default text representation.""" name: String """URL of the template preview image shown in the template gallery.""" previewImageUrl: String """ Full template definition: the blueprint canvas (placeholder record ids), per-node creation blueprints and admin prerequisites. Instantiated into real records on create-from-template; clients only ever read the derived SolutionTemplateSchema projection. Full structure: https://developers.coevera.com/reference/graphql/types/s/#SolutionTemplateSchema """ settings: JSONString } """Id of the SolutionTemplate record to delete.""" input DeleteSolutionTemplateInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteSolutionTemplate mutation.""" type DeleteSolutionTemplatePayload { """The deleted record.""" solutionTemplate: SolutionTemplateEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createStep mutation.""" type CreateStepPayload { """The created record.""" step: StepEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Step record.""" input CreateStepInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String! """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """Id of the opportunity pipeline.""" pipelineId: ID """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateStepChecklistNoStepBackrefInput!] } """Result of the updateStep mutation.""" type UpdateStepPayload { """The updated record.""" step: StepEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Step record and the field values to change.""" input UpdateStepInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateOrUpdateStepChecklistNoStepBackrefInput!] } """Result of the bulkUpdateStep mutation.""" type BulkUpdateStepPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Step record to create, or to update when its id is set. """ input CreateOrUpdateStepInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Free-text description shown in the step UI.""" description: String """ When true, the record form is read-only while a record is in this step. """ hasReadonlyForm: Boolean """ When true, transitioning a record into this step bumps its version counter. """ hasVersionIncrement: Boolean """ Id of the lead process this step belongs to, or empty when the step is not part of a lead process. """ leadProcessId: ID """Name of the entity and its default text representation.""" name: String """ Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. """ percent: Int """Id of the opportunity pipeline.""" pipelineId: ID """ Id of the quote process this step belongs to, or empty when the step is not part of a quote process. """ quoteProcessId: ID """ Position of the step within its pipeline or process; lower values appear first. """ sortOrder: Int """ Expected number of days a record should spend in this step. Used to flag overdue records. """ timeframe: Int """Revision when entity was lastly changed.""" revision: Int """ Files attached to the step (e.g. step-specific documentation or templates). """ documents: [CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!] """ Checklist items the user must complete before moving a record out of this step. """ stepChecklists: [CreateOrUpdateStepChecklistNoStepBackrefInput!] } """Id of the Step record to delete.""" input DeleteStepInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the createStepChecklist mutation.""" type CreateStepChecklistPayload { """The created record.""" stepChecklist: StepChecklistEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new StepChecklist record.""" input CreateStepChecklistInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplate: CreateCloudObjectTemplateInput """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: ID """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: StepChecklistDocumentFormatEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: ID """Free-text description shown alongside the checklist item.""" description: String """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: ID """Id of the related field.""" fieldId: ID """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: StepChecklistTypeEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: StepChecklistValidationEnum """Display label of the checklist item.""" label: String """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: Boolean """Id of the related process.""" processId: ID """Id of the recipient field.""" sendEmailFieldId: ID """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: ID """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: ID """Id of the pipeline or process step this checklist item belongs to.""" stepId: ID! """ Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. This payload conforms to the `StepChecklistVisibilityFilter` JSON Schema: GET /api/v100/rest/schemas/StepChecklistVisibilityFilter.json on your region's API host """ visibilityCondition: StepChecklistVisibilityFilterJSONString! """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: StepChecklistVisibilityEnum """Revision when entity was lastly changed.""" revision: Int """ Sales roles the checklist item is shown to. Empty means the item is shown to all roles. """ salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!] } """Result of the updateStepChecklist mutation.""" type UpdateStepChecklistPayload { """The updated record.""" stepChecklist: StepChecklistEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a StepChecklist record and the field values to change.""" input UpdateStepChecklistInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplate: CreateCloudObjectTemplateInput """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: ID """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: StepChecklistDocumentFormatEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: ID """Free-text description shown alongside the checklist item.""" description: String """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: ID """Id of the related field.""" fieldId: ID """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: StepChecklistTypeEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: StepChecklistValidationEnum """Display label of the checklist item.""" label: String """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: Boolean """Id of the related process.""" processId: ID """Id of the recipient field.""" sendEmailFieldId: ID """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: ID """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: ID """Id of the pipeline or process step this checklist item belongs to.""" stepId: ID """ Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. This payload conforms to the `StepChecklistVisibilityFilter` JSON Schema: GET /api/v100/rest/schemas/StepChecklistVisibilityFilter.json on your region's API host """ visibilityCondition: StepChecklistVisibilityFilterJSONString """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: StepChecklistVisibilityEnum """Revision when entity was lastly changed.""" revision: Int """ Sales roles the checklist item is shown to. Empty means the item is shown to all roles. """ salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!] } """Result of the bulkUpdateStepChecklist mutation.""" type BulkUpdateStepChecklistPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a StepChecklist record to create, or to update when its id is set. """ input CreateOrUpdateStepChecklistInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplate: CreateCloudObjectTemplateInput """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: ID """ File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. """ cloudObjectFormat: StepChecklistDocumentFormatEnum """ Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. """ cloudObjectTemplateId: ID """Free-text description shown alongside the checklist item.""" description: String """ Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. """ emailSequenceId: ID """Id of the related field.""" fieldId: ID """ Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. """ itemType: StepChecklistTypeEnum """ Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. """ itemValidation: StepChecklistValidationEnum """Display label of the checklist item.""" label: String """ When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. """ labelUseLang: Boolean """Id of the related process.""" processId: ID """Id of the recipient field.""" sendEmailFieldId: ID """ Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. """ sendEmailLookupFieldId: ID """ Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. """ sendEmailTemplateId: ID """Id of the pipeline or process step this checklist item belongs to.""" stepId: ID """ Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. This payload conforms to the `StepChecklistVisibilityFilter` JSON Schema: GET /api/v100/rest/schemas/StepChecklistVisibilityFilter.json on your region's API host """ visibilityCondition: StepChecklistVisibilityFilterJSONString """ Whether the item is always shown on the record or only when the record matches visibilityCondition. """ visibilityType: StepChecklistVisibilityEnum """Revision when entity was lastly changed.""" revision: Int """ Sales roles the checklist item is shown to. Empty means the item is shown to all roles. """ salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!] } """Id of the StepChecklist record to delete.""" input DeleteStepChecklistInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. """ activityTypeId: ID } """Result of the deleteStepChecklist mutation.""" type DeleteStepChecklistPayload { """The deleted record.""" stepChecklist: StepChecklistEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createStepChecklistSalesRoleRelation mutation.""" type CreateStepChecklistSalesRoleRelationPayload { """The created record.""" stepChecklistSalesRoleRelation: StepChecklistSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new StepChecklistSalesRoleRelation record.""" input CreateStepChecklistSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales role that sees the checklist item.""" salesRoleId: ID! """Id of the checklist item.""" stepChecklistId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateStepChecklistSalesRoleRelation mutation.""" type UpdateStepChecklistSalesRoleRelationPayload { """The updated record.""" stepChecklistSalesRoleRelation: StepChecklistSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a StepChecklistSalesRoleRelation record and the field values to change. """ input UpdateStepChecklistSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales role that sees the checklist item.""" salesRoleId: ID """Id of the checklist item.""" stepChecklistId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateStepChecklistSalesRoleRelation mutation.""" type BulkUpdateStepChecklistSalesRoleRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a StepChecklistSalesRoleRelation record to create, or to update when its id is set. """ input CreateOrUpdateStepChecklistSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sales role that sees the checklist item.""" salesRoleId: ID """Id of the checklist item.""" stepChecklistId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the StepChecklistSalesRoleRelation record to delete.""" input DeleteStepChecklistSalesRoleRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteStepChecklistSalesRoleRelation mutation.""" type DeleteStepChecklistSalesRoleRelationPayload { """The deleted record.""" stepChecklistSalesRoleRelation: StepChecklistSalesRoleRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTag mutation.""" type CreateTagPayload { """The created record.""" tag: TagEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Tag record.""" input CreateTagInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction. """ allowedEntityTypeIds: JSONString """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int! """Id of the creating user.""" creatorId: ID """ For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags. """ entityApiName: String """ When false, the tag is hidden in pickers and cannot be assigned to new records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: String! """ Bit flags of the entities the tag can be attached to, added together: Contact 1, Account 2, Opportunity 4, Lead 8, Project 16, Email 32, Process 64, Appointment 128, Task 256, Quote 512, CustomEntity 1024, Solution 2048. """ supportedEntities: Int """ When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTag mutation.""" type UpdateTagPayload { """The updated record.""" tag: TagEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Tag record and the field values to change.""" input UpdateTagInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction. """ allowedEntityTypeIds: JSONString """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int """Id of the creating user.""" creatorId: ID """ For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags. """ entityApiName: String """ When false, the tag is hidden in pickers and cannot be assigned to new records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: String """ When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTag mutation.""" type BulkUpdateTagPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Tag record to create, or to update when its id is set. """ input CreateOrUpdateTagInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction. """ allowedEntityTypeIds: JSONString """ Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue. """ color: Int """Id of the creating user.""" creatorId: ID """ For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags. """ entityApiName: String """ When false, the tag is hidden in pickers and cannot be assigned to new records. """ isEnabled: Boolean """Name of the entity and its default text representation.""" name: String """ Bit flags of the entities the tag can be attached to, added together: Contact 1, Account 2, Opportunity 4, Lead 8, Project 16, Email 32, Process 64, Appointment 128, Task 256, Quote 512, CustomEntity 1024, Solution 2048. """ supportedEntities: Int """ When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown. """ useLang: Boolean """Revision when entity was lastly changed.""" revision: Int } """Id of the Tag record to delete.""" input DeleteTagInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTag mutation.""" type DeleteTagPayload { """The deleted record.""" tag: TagEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTagRelation mutation.""" type CreateTagRelationPayload { """The created record.""" tagRelation: TagRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TagRelation record.""" input CreateTagRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTagRelation mutation.""" type UpdateTagRelationPayload { """The updated record.""" tagRelation: TagRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a TagRelation record and the field values to change.""" input UpdateTagRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTagRelation mutation.""" type BulkUpdateTagRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a TagRelation record to create, or to update when its id is set. """ input CreateOrUpdateTagRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID """Id of the linked task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the TagRelation record to delete.""" input DeleteTagRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTagRelation mutation.""" type DeleteTagRelationPayload { """The deleted record.""" tagRelation: TagRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTarget mutation.""" type CreateTargetPayload { """The created record.""" target: TargetEntity } """Field values of a new Target record.""" input CreateTargetInput { """Name of the target.""" name: String! """Free-text description shown alongside the target.""" description: String """ Users the target is set on: the assignee of a User target, or the members of a GroupFromUser target, each of whom gets a user target of their own. """ targetClientIds: [UUID] """User targets a GroupFromExisting target combines.""" existingTargetsIds: [UUID] """ Sales pipeline (revenue targets) or lead process (lead targets) whose records count toward the target. """ pipelineLeadProcessId: UUID """Currency the target value is expressed in.""" currencyId: UUID! """ Field conditions selecting which records count toward the target. Required for User and GroupFromUser targets unless fromSimulatedTargetId is set. The main box entity must be LeadOppty for Revenue and LeadQualified targets, and Lead (or LeadOppty) for LeadCreated targets; any other entity is rejected with ERROR_PARAMETER_INVALID. """ filter: FieldFilterParams """ Period the target applies to: a calendar or financial year, or one quarter or month of it. """ period: TargetsPeriodParams! """ User who owns a new target; defaults to the calling user. Not changed by updateTarget. """ ownerId: UUID = null """ When true, the target is created active. Only a GroupFromExisting target can be created active; other targets start as drafts. """ isActive: Boolean! """ Kind of target: User, GroupFromUser (one user target per user in targetClientIds), GroupFromExisting (combines existingTargetsIds) or Simulated. """ targetType: TargetTypeEnum! """ What the target measures: revenue from won opportunities, or the number of leads created or qualified. """ calculationType: TargetCalculationTypeEnum! """Simulated target whose indicators the new User target takes over.""" fromSimulatedTargetId: UUID """ Expected results the Simulated target is built from; required for Simulated targets. """ simulatedIndicators: SimulatedTargetIndicatorsParams = null """ Target value of a User target, overriding the value computed from the indicators. """ targetValue: Float """ Target value of each user of a GroupFromUser target, in the order of targetClientIds. """ targetClientTargetValues: [Float] } """ Period of a sales target: a year, quarter or month of the calendar or financial year. """ input TargetsPeriodParams { """ Whether the period follows the CalendarYear (Jan 1) or the company FinancialYear start. """ type: TargetsPeriodTypeEnum! """Calendar or financial year the target applies to.""" year: Int! """Granularity of the period within the year — Year, Quarter or Month.""" fragmentType: TargetsPeriodFragmentTypeEnum! """ Quarter (1-4, counted from the start of the year) or calendar month (1-12, January = 1) the period covers; null when fragmentType is Year. """ fragmentIndex: Int } """ Expected results of a target derived from its indicators: leads created, qualified and closed, and opportunities closed, won and their value. """ input SimulatedTargetIndicatorsParams { """ Target value: the won amount for revenue targets, or the number of leads to create or qualify for lead targets. """ target: Float! """Expected number of leads closed (qualified or lost) in the period.""" leadClosedCount: Int """Expected number of leads created in the period.""" leadCreatedCount: Int """Expected number of leads qualified in the period.""" leadQualifiedCount: Int """Expected number of opportunities closed (won or lost) in the period.""" opportunityClosedCount: Int """Expected number of won opportunities in the period.""" opportunityWonCount: Int """ Expected value of the won opportunities in the period, in the target currency. """ opportunityWonAmount: Float """Average rate at which opportunity value is won over time.""" opportunityAverageVelocity: Float } """Result of the updateTarget mutation.""" type UpdateTargetPayload { """The updated record.""" target: TargetEntity } """Id of a Target record and the field values to change.""" input UpdateTargetInput { """Name of the target.""" name: String! """Free-text description shown alongside the target.""" description: String """ Users the target is set on: the assignee of a User target, or the members of a GroupFromUser target, each of whom gets a user target of their own. """ targetClientIds: [UUID] """User targets a GroupFromExisting target combines.""" existingTargetsIds: [UUID] """ Sales pipeline (revenue targets) or lead process (lead targets) whose records count toward the target. """ pipelineLeadProcessId: UUID """Currency the target value is expressed in.""" currencyId: UUID! """ Field conditions selecting which records count toward the target. Required for User and GroupFromUser targets unless fromSimulatedTargetId is set. The main box entity must be LeadOppty for Revenue and LeadQualified targets, and Lead (or LeadOppty) for LeadCreated targets; any other entity is rejected with ERROR_PARAMETER_INVALID. """ filter: FieldFilterParams """ Period the target applies to: a calendar or financial year, or one quarter or month of it. """ period: TargetsPeriodParams! """ User who owns a new target; defaults to the calling user. Not changed by updateTarget. """ ownerId: UUID = null """Id of the target to update.""" id: UUID! } """Result of the bulkUpdateTarget mutation.""" type BulkUpdateTargetPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Target record to create, or to update when its id is set. """ input CreateOrUpdateTargetInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ What the target measures: revenue from opportunities won, or the number of leads qualified or created in the target period. """ calculationType: TargetCalculationTypeEnum """Id of the target currency.""" currencyId: ID """Free-text description shown alongside the target.""" description: String """ When true, the target is currently being tracked; when false, the target is a draft or has been deactivated. """ isActive: Boolean """Name of the entity and its default text representation.""" name: String """Id of the owning user.""" ownerId: ID """ First date of the active target period. Set when isActive is true; recomputed from settings.period when activated. """ periodFrom: Date """Last date of the active target period.""" periodTo: Date """Id of the assignee user.""" targetClientId: ID """ Kind of target: a User target for targetClient, a group target that is split into or combines user targets, or a Simulated what-if target. """ type: TargetTypeEnum """Revision when entity was lastly changed.""" revision: Int """User-level child targets that aggregate into this group target.""" childTargets: [CreateTargetRelationNoGroupTargetBackrefInput!] } """ Field values of a new TargetRelation record, created together with the record it belongs to. """ input CreateTargetRelationNoGroupTargetBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user target that rolls up into the group target.""" userTargetId: ID! """Revision when entity was lastly changed.""" revision: Int } """Id of the Target record to delete.""" input DeleteTargetInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTarget mutation.""" type DeleteTargetPayload { """The deleted record.""" target: TargetEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateDetailSettingsTarget mutation.""" type UpdateDetailSettingsTargetPayload { """The updated targets.""" result: [TargetEntity!]! } """Parameters of the updateDetailSettingsTarget mutation.""" input UpdateTargetSettingsInput { """Id of the target to update.""" id: UUID! """When true, lead indicators are included in the target calculation.""" leadsEnabled: Boolean! """ When true, working-time indicators (working hours, vacation, holidays, sick days) are included in the target calculation. """ workingTimeEnabled: Boolean! """ When true, the target value is fixed and not recomputed from the indicators. """ targetValueLocked: Boolean! """Granularity at which target progress is charted.""" chartGranularity: TargetsChartGranularityEnum! """Indicator values computed from historical data, used as defaults.""" calculatedIndicators: TargetsIndicatorsParams! """ User-overridden indicator values; each set value takes precedence over the corresponding calculated indicator. """ customIndicators: TargetsIndicatorsParams! } """ Sales performance indicators of a target, such as lead qualification rate, average deal size, win rate and length of the sales cycle. """ input TargetsIndicatorsParams { """Target value to be reached over the period.""" target: Float """Share of closed leads that were qualified, as a ratio.""" leadQualificationRate: Float """Average number of days it takes for a lead to be qualified.""" leadSalesTimeToQualify: Int """Average number of days it takes for a lead to be lost.""" leadSalesTimeToLose: Int """Number of leads closed (qualified or lost) over the period.""" leadClosedCount: Int """Average monetary value of a won opportunity.""" opportunityAverageSize: Float """Average rate at which opportunity value is won over time.""" opportunityAverageVelocity: Float """Share of closed opportunities that were won, as a ratio.""" opportunityWinRate: Float """Average number of days it takes for an opportunity to be won.""" opportunitySalesTimeToWin: Int """Average number of days it takes for an opportunity to be lost.""" opportunitySalesTimeToLose: Int """Number of opportunities closed (won or lost) over the period.""" opportunityClosedCount: Int """Average time, in minutes, spent engaging a lead.""" leadAverageEngagementTime: Int """Average time, in minutes, spent engaging an opportunity.""" opportunityAverageEngagementTime: Int """Number of working hours available per week.""" workingHoursPerWeek: Int """ Number of weekly working hours not spent selling (admin, meetings, etc.). """ nonSellingHoursPerWeek: Int """Number of vacation days per year.""" vacationDaysPerYear: Int """Number of public holidays per year.""" holidaysPerYear: Int """Expected number of sick days per year.""" sickDaysPerYear: Int """ Average number of engagements with a lead before it is qualified or lost. """ leadAverageEngagementsBeforeQualifyLost: Float """Average number of engagements with a lead before it is qualified.""" leadAverageEngagementsBeforeQualify: Float """Average number of engagements with a lead before it is lost.""" leadAverageEngagementsBeforeLost: Float """ Average number of engagements with an opportunity before it is won or lost. """ opptyAverageEngagementsBeforeWonLost: Float """Average number of engagements with an opportunity before it is won.""" opptyAverageEngagementsBeforeWon: Float """Average number of engagements with an opportunity before it is lost.""" opptyAverageEngagementsBeforeLost: Float """Number of working days target user worked in company.""" targetUserWorkingDaysTotal: Int """Number of years user has worked in company""" targetUserYearsInWork: Int } """Result of the activateTarget mutation.""" type ActivateTargetPayload { """The activated target.""" target: TargetEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the activateTarget mutation.""" input ActivateTargetInput { """Target to activate.""" id: UUID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkActivateUserTarget mutation.""" type BulkActivateUserTargetPayload { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkActivateUserTarget mutation.""" input BulkActivateUserTargetInput { """Targets to activate, in addition to those taken from sessionId.""" includedIds: [ID!]! """Targets to leave out of the selection.""" excludedIds: [ID!]! """ Id of an open list view whose records are added to the selection. Integrations can leave it empty. """ sessionId: String """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the finishTarget mutation.""" type FinishTargetPayload { """The finished target.""" target: TargetEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the finishTarget mutation.""" input FinishTargetInput { """Target to finish.""" id: UUID! """ For a group target, when true, also finishes its active user targets that are not finished yet. """ applyToChildren: Boolean! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkFinishUserTarget mutation.""" type BulkFinishUserTargetPayload { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkFinishUserTarget mutation.""" input BulkFinishUserTargetInput { """Targets to finish, in addition to those taken from sessionId.""" includedIds: [ID!]! """Targets to leave out of the selection.""" excludedIds: [ID!]! """ Id of an open list view whose records are added to the selection. Integrations can leave it empty. """ sessionId: String """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the copyTarget mutation.""" type CopyTargetPayload { """The new draft target.""" target: TargetEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the copyTarget mutation.""" input CopyTargetInput { """Target to copy.""" id: UUID! """Name of the new target.""" name: String! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the removeTarget mutation.""" type RemoveTargetPayload { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the removeTarget mutation.""" input RemoveTargetInput { """Group target to remove the user target from.""" parentTargetId: UUID! """User target to remove from the group.""" childTargetId: UUID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the bulkRemoveTarget mutation.""" type BulkRemoveTargetPayload { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the bulkRemoveTarget mutation.""" input BulkRemoveTargetInput { """ Pairs of a group target (parentTargetId) and a user target to remove from it (childTargetId). """ groupChildIds: [GroupChildIdParams!]! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Pair of a group target and one of its user targets.""" input GroupChildIdParams { """Group target the user target belongs to.""" parentTargetId: UUID! """User target to remove from the group.""" childTargetId: UUID! } """Result of the createTargetRelation mutation.""" type CreateTargetRelationPayload { """The created record.""" targetRelation: TargetRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TargetRelation record.""" input CreateTargetRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the parent group target that aggregates the user target.""" groupTargetId: ID! """Id of the user target that rolls up into the group target.""" userTargetId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTargetRelation mutation.""" type UpdateTargetRelationPayload { """The updated record.""" targetRelation: TargetRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a TargetRelation record and the field values to change.""" input UpdateTargetRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the parent group target that aggregates the user target.""" groupTargetId: ID """Id of the user target that rolls up into the group target.""" userTargetId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTargetRelation mutation.""" type BulkUpdateTargetRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a TargetRelation record to create, or to update when its id is set. """ input CreateOrUpdateTargetRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the parent group target that aggregates the user target.""" groupTargetId: ID """Id of the user target that rolls up into the group target.""" userTargetId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the TargetRelation record to delete.""" input DeleteTargetRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTargetRelation mutation.""" type DeleteTargetRelationPayload { """The deleted record.""" targetRelation: TargetRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the changeOwnershipTask mutation.""" type ChangeOwnershipTaskPayload { """The task with its new owner.""" result: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the changeOwnershipTask mutation.""" input ChangeOwnershipTaskInput { """User who becomes the new owner of the task.""" ownerId: ID! """Sales unit the task is assigned to.""" unitId: ID! """ When true, the previous owner (if still an active user) stays on the task as a shared user with the Editor role, and a Private sharing mode is switched to Standard. """ keepOwnerAsEditor: Boolean! """Identifier of the TaskEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the releaseOwnershipTask mutation.""" type ReleaseOwnershipTaskPayload { """The released task.""" result: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the releaseOwnershipTask mutation.""" input ReleaseOwnershipTaskInput { """Identifier of the TaskEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the manageSharingTask mutation.""" type ManageSharingTaskPayload { """The record with its updated sharing.""" result: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the manageSharingTask mutation.""" input ManageSharingTaskInput { """Sharing mode of the record: Standard, Private, AllView or AllEdit.""" shareMode: ShareModeEnum! """ Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users. """ sharingClients: [CreateTaskSharingClientRelationNoTaskBackrefInput!] """ Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units. """ sharingUnits: [CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!] """Identifier of the TaskEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Field values of a new TaskSharingClientRelation record, created together with the record it belongs to. """ input CreateTaskSharingClientRelationNoTaskBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TaskSharingSalesUnitRelation record, created together with the record it belongs to. """ input CreateTaskSharingSalesUnitRelationNoTaskBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the restoreTask mutation.""" type RestoreTaskPayload { """The restored record.""" result: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the restoreTask mutation.""" input RestoreTaskInput { """Identifier of the TaskEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the setReminderTask mutation.""" type SetReminderTaskPayload { """The task with the updated reminder.""" result: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the setReminderTask mutation.""" input SetReminderTaskInput { """ When the reminder fires; also used as the new time when snoozing. When a first reminder is created without a date and without the Scheduled status, it defaults to today at the user's default task reminder time. """ setDate: DateTime """ State of the reminder: Scheduled, Snoozed or Dismissed. Omit to keep the current state. """ status: ReminderStatusEnum """Identifier of the TaskEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the removeReminderTask mutation.""" type RemoveReminderTaskPayload { """The task with the dismissed reminder.""" result: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the removeReminderTask mutation.""" input RemoveReminderTaskInput { """Identifier of the TaskEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the setTaskStatus mutation.""" type SetTaskStatusPayload { """The updated task.""" result: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the setTaskStatus mutation.""" input SetTaskStatusInput { """New status of the task.""" newStatus: TaskStatusEnum! """Identifier of the TaskEntity to perform the action on.""" id: ID! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTask mutation.""" type CreateTaskPayload { """The created record.""" task: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Task record.""" input CreateTaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the task type.""" activityTypeId: ID """ Duration of the recorded call. Set automatically when the task is linked to a call log. """ callDuration: Int """Id of the linked call record.""" callId: ID """ Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). """ callOutcomeId: ID """Id of the currency exchange rate list applied to this task.""" currencyExchangeRatesListId: ID """Free-form description of what the task entails.""" description: String """Date by which the task is expected to be completed.""" dueDate: Date """ Estimated duration of the task. Stored as a duration value (days/hours/minutes). """ duration: Float """Id of the task owner.""" ownerId: ID """Priority level of the task: Low, Medium or High.""" priority: PriorityEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when work on the task is scheduled to begin.""" startDate: Date """ Current status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done. """ status: TaskStatusEnum """Short summary line shown in lists and notifications.""" subject: String! """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!] """ Users that have been granted shared access to this task. Editable only when shareMode allows user sharing. """ sharingClients: [CreateTaskSharingClientRelationNoTaskBackrefInput!] """Accounts this task is linked to.""" accountRelations: [CreateActivityRelationNoActivityBackrefInput!] """Contacts this task is linked to.""" contactRelations: [CreateActivityRelationNoActivityBackrefInput!] """Leads this task is linked to.""" leadRelations: [CreateActivityRelationNoActivityBackrefInput!] """Opportunities this task is linked to.""" opportunityRelations: [CreateActivityRelationNoActivityBackrefInput!] """Projects this task is linked to, including the per-objective ordering.""" projectRelations: [CreateActivityRelationNoActivityBackrefInput!] """Quotes this task is linked to.""" quoteRelations: [CreateActivityRelationNoActivityBackrefInput!] """Custom entity records this task is linked to.""" customEntityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. """ reminder: CreateTaskReminderNoTaskBackrefInput """ Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. """ taskRecurrence: CreateTaskRecurrenceNoTaskBackrefInput """Documents linked to this task.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this task.""" comments: [CreateActivityCommentNoActivityBackrefInput!] """Tag labels applied to this task.""" tags: [CreateTagRelationNoTaskBackrefInput!] """ Identifier (SID) of a phone call made through Coevera calling, to attach that call to the task; null detaches the call. Write-only. """ callSid: String } """ Field values of a new TaskReminder record, created together with the record it belongs to. """ input CreateTaskReminderNoTaskBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user who set the reminder.""" ownerId: ID! """Timestamp when the reminder should fire.""" setDate: DateTime! """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TaskRecurrence record, created together with the record it belongs to. """ input CreateTaskRecurrenceNoTaskBackrefInput { """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date! """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """ Field values of a new TagRelation record, created together with the record it belongs to. """ input CreateTagRelationNoTaskBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked appointment.""" appointmentId: ID """Id of the linked contact.""" contactId: ID """Id of the linked custom entity record.""" customEntityId: ID """Id of the linked email.""" emailId: ID """Id of the linked lead.""" leadId: ID """Id of the linked opportunity.""" opptyId: ID """Id of the linked sales process.""" processId: ID """Id of the linked project.""" projectId: ID """Id of the linked quote.""" quoteId: ID """Id of the linked solution.""" solutionId: ID """Id of the tag attached to the record.""" tagId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTask mutation.""" type UpdateTaskPayload { """The updated record.""" task: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Task record and the field values to change.""" input UpdateTaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the task type.""" activityTypeId: ID """ Duration of the recorded call. Set automatically when the task is linked to a call log. """ callDuration: Int """Id of the linked call record.""" callId: ID """ Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). """ callOutcomeId: ID """Id of the currency exchange rate list applied to this task.""" currencyExchangeRatesListId: ID """Free-form description of what the task entails.""" description: String """Date by which the task is expected to be completed.""" dueDate: Date """ Estimated duration of the task. Stored as a duration value (days/hours/minutes). """ duration: Float """Id of the task owner.""" ownerId: ID """Priority level of the task: Low, Medium or High.""" priority: PriorityEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when work on the task is scheduled to begin.""" startDate: Date """ Current status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done. """ status: TaskStatusEnum """Short summary line shown in lists and notifications.""" subject: String """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!] """ Users that have been granted shared access to this task. Editable only when shareMode allows user sharing. """ sharingClients: [CreateTaskSharingClientRelationNoTaskBackrefInput!] """Accounts this task is linked to.""" accountRelations: [CreateActivityRelationNoActivityBackrefInput!] """Contacts this task is linked to.""" contactRelations: [CreateActivityRelationNoActivityBackrefInput!] """Leads this task is linked to.""" leadRelations: [CreateActivityRelationNoActivityBackrefInput!] """Opportunities this task is linked to.""" opportunityRelations: [CreateActivityRelationNoActivityBackrefInput!] """Projects this task is linked to, including the per-objective ordering.""" projectRelations: [CreateActivityRelationNoActivityBackrefInput!] """Quotes this task is linked to.""" quoteRelations: [CreateActivityRelationNoActivityBackrefInput!] """Custom entity records this task is linked to.""" customEntityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. """ taskRecurrence: UpdateTaskRecurrenceNoTaskBackrefInput """Documents linked to this task.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this task.""" comments: [CreateActivityCommentNoActivityBackrefInput!] """Tag labels applied to this task.""" tags: [CreateTagRelationNoTaskBackrefInput!] """ Identifier (SID) of a phone call made through Coevera calling, to attach that call to the task; null detaches the call. Write-only. """ callSid: String } """ Id of a TaskRecurrence record and the field values to change, updated together with the record it belongs to. """ input UpdateTaskRecurrenceNoTaskBackrefInput { """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTask mutation.""" type BulkUpdateTaskPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Task record to create, or to update when its id is set. """ input CreateOrUpdateTaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """ Id of the linked Media record holding the activity's call recording / transcription, when available. """ mediaTranscriptionId: UUID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the task type.""" activityTypeId: ID """ Duration of the recorded call. Set automatically when the task is linked to a call log. """ callDuration: Int """Id of the linked call record.""" callId: ID """ Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). """ callOutcomeId: ID """Id of the currency exchange rate list applied to this task.""" currencyExchangeRatesListId: ID """Free-form description of what the task entails.""" description: String """Date by which the task is expected to be completed.""" dueDate: Date """ Estimated duration of the task. Stored as a duration value (days/hours/minutes). """ duration: Float """Id of the task owner.""" ownerId: ID """Priority level of the task: Low, Medium or High.""" priority: PriorityEnum """ Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). """ shareMode: ShareModeEnum """Date when work on the task is scheduled to begin.""" startDate: Date """ Current status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done. """ status: TaskStatusEnum """Short summary line shown in lists and notifications.""" subject: String """Id of the sales unit.""" unitId: ID """ Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field. """ customFields: JSONString """Revision when entity was lastly changed.""" revision: Int """ Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing. """ sharingUnits: [CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!] """ Users that have been granted shared access to this task. Editable only when shareMode allows user sharing. """ sharingClients: [CreateTaskSharingClientRelationNoTaskBackrefInput!] """Accounts this task is linked to.""" accountRelations: [CreateActivityRelationNoActivityBackrefInput!] """Contacts this task is linked to.""" contactRelations: [CreateActivityRelationNoActivityBackrefInput!] """Leads this task is linked to.""" leadRelations: [CreateActivityRelationNoActivityBackrefInput!] """Opportunities this task is linked to.""" opportunityRelations: [CreateActivityRelationNoActivityBackrefInput!] """Projects this task is linked to, including the per-objective ordering.""" projectRelations: [CreateActivityRelationNoActivityBackrefInput!] """Quotes this task is linked to.""" quoteRelations: [CreateActivityRelationNoActivityBackrefInput!] """Custom entity records this task is linked to.""" customEntityRelations: [CreateActivityRelationNoActivityBackrefInput!] """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ exchangeEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ gapiEntityId: String """ External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. """ o365EntityId: String """ Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. """ reminder: UpdateTaskReminderNoTaskBackrefInput """ Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. """ taskRecurrence: UpdateTaskRecurrenceNoTaskBackrefInput """Documents linked to this task.""" documents: [CreateCloudObjectRelationNoBackrefInput!] """Comments authored on this task.""" comments: [CreateActivityCommentNoActivityBackrefInput!] """Tag labels applied to this task.""" tags: [CreateTagRelationNoTaskBackrefInput!] """ Identifier (SID) of a phone call made through Coevera calling, to attach that call to the task; null detaches the call. Write-only. """ callSid: String } """ Id of a TaskReminder record and the field values to change, updated together with the record it belongs to. """ input UpdateTaskReminderNoTaskBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user who set the reminder.""" ownerId: ID """Timestamp when the reminder should fire.""" setDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the Task record to delete.""" input DeleteTaskInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTask mutation.""" type DeleteTaskPayload { """The deleted record.""" task: TaskEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the convertTask mutation.""" type ConvertTaskPayload { """The created record.""" task: TaskEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTaskRecurrence mutation.""" type CreateTaskRecurrencePayload { """The created record.""" taskRecurrence: TaskRecurrenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TaskRecurrence record.""" input CreateTaskRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date! """Id of the parent task.""" taskId: ID! """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTaskRecurrence mutation.""" type UpdateTaskRecurrencePayload { """The updated record.""" taskRecurrence: TaskRecurrenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a TaskRecurrence record and the field values to change.""" input UpdateTaskRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date """Id of the parent task.""" taskId: ID """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTaskRecurrence mutation.""" type BulkUpdateTaskRecurrencePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a TaskRecurrence record to create, or to update when its id is set. """ input CreateOrUpdateTaskRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """ Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply """ applyRecurrence: Boolean """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative. """ day: DateDayEnum "\nBit Flag field, with limited combination of integer values.\n\nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute." dayOfWeek: Int """ Date information. The last date when no more other items should be created. """ endDate: Date """ Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative. """ month: DateMonthEnum """ The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. """ occurEvery: Int """ Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. """ occurrencesCount: Int """ Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. """ startDate: Date """Id of the parent task.""" taskId: ID """ Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears). """ type: RecurrenceTypeEnum """ Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute. """ week: DateWeekEnum """Revision when entity was lastly changed.""" revision: Int } """Id of the TaskRecurrence record to delete.""" input DeleteTaskRecurrenceInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTaskRecurrence mutation.""" type DeleteTaskRecurrencePayload { """The deleted record.""" taskRecurrence: TaskRecurrenceEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTaskReminder mutation.""" type CreateTaskReminderPayload { """The created record.""" taskReminder: TaskReminderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TaskReminder record.""" input CreateTaskReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user who set the reminder.""" ownerId: ID! """Timestamp when the reminder should fire.""" setDate: DateTime! """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Id of the task this reminder belongs to.""" taskId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTaskReminder mutation.""" type UpdateTaskReminderPayload { """The updated record.""" taskReminder: TaskReminderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a TaskReminder record and the field values to change.""" input UpdateTaskReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user who set the reminder.""" ownerId: ID """Timestamp when the reminder should fire.""" setDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Id of the task this reminder belongs to.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTaskReminder mutation.""" type BulkUpdateTaskReminderPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a TaskReminder record to create, or to update when its id is set. """ input CreateOrUpdateTaskReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user who set the reminder.""" ownerId: ID """Timestamp when the reminder should fire.""" setDate: DateTime """ Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed. """ status: ReminderStatusEnum """Id of the task this reminder belongs to.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the TaskReminder record to delete.""" input DeleteTaskReminderInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTaskReminder mutation.""" type DeleteTaskReminderPayload { """The deleted record.""" taskReminder: TaskReminderEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTaskSharingClientRelation mutation.""" type CreateTaskSharingClientRelationPayload { """The created record.""" taskSharingClientRelation: TaskSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TaskSharingClientRelation record.""" input CreateTaskSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID! """ Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTaskSharingClientRelation mutation.""" type UpdateTaskSharingClientRelationPayload { """The updated record.""" taskSharingClientRelation: TaskSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a TaskSharingClientRelation record and the field values to change. """ input UpdateTaskSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """ Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTaskSharingClientRelation mutation.""" type BulkUpdateTaskSharingClientRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a TaskSharingClientRelation record to create, or to update when its id is set. """ input CreateOrUpdateTaskSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the user.""" clientId: ID """ Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the TaskSharingClientRelation record to delete.""" input DeleteTaskSharingClientRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTaskSharingClientRelation mutation.""" type DeleteTaskSharingClientRelationPayload { """The deleted record.""" taskSharingClientRelation: TaskSharingClientRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTaskSharingSalesUnitRelation mutation.""" type CreateTaskSharingSalesUnitRelationPayload { """The created record.""" taskSharingSalesUnitRelation: TaskSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TaskSharingSalesUnitRelation record.""" input CreateTaskSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID! """Id of the sales unit.""" unitId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTaskSharingSalesUnitRelation mutation.""" type UpdateTaskSharingSalesUnitRelationPayload { """The updated record.""" taskSharingSalesUnitRelation: TaskSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a TaskSharingSalesUnitRelation record and the field values to change. """ input UpdateTaskSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTaskSharingSalesUnitRelation mutation.""" type BulkUpdateTaskSharingSalesUnitRelationPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a TaskSharingSalesUnitRelation record to create, or to update when its id is set. """ input CreateOrUpdateTaskSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Access the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it. """ role: SharingRoleEnum """Id of the shared task.""" taskId: ID """Id of the sales unit.""" unitId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the TaskSharingSalesUnitRelation record to delete.""" input DeleteTaskSharingSalesUnitRelationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteTaskSharingSalesUnitRelation mutation.""" type DeleteTaskSharingSalesUnitRelationPayload { """The deleted record.""" taskSharingSalesUnitRelation: TaskSharingSalesUnitRelationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createTextMessage mutation.""" type CreateTextMessagePayload { """The created record.""" textMessage: TextMessageEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the updateTextMessage mutation.""" type UpdateTextMessagePayload { """The updated record.""" textMessage: TextMessageEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a TextMessage record and the field values to change.""" input UpdateTextMessageInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: ID """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: String """Timestamp the message was sent.""" datetimeSent: DateTime """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnum """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: String """ Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. """ score: Int """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnum """ Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. """ textMessageConversationId: ID """Revision when entity was lastly changed.""" revision: Int """Files attached to the message (e.g. MMS attachments).""" attachments: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the createTextMessageConversation mutation.""" type CreateTextMessageConversationPayload { """The created record.""" textMessageConversation: TextMessageConversationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TextMessageConversation record.""" input CreateTextMessageConversationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sender phone.""" phoneId: ID! """Id of the matched account.""" recipientAccountId: ID """Id of the matched contact.""" recipientContactId: ID """ External phone number of the conversation recipient. Cannot be changed once the conversation has started. """ recipientPhoneNumber: String """Revision when entity was lastly changed.""" revision: Int """Messages exchanged in the conversation, ordered by send time.""" messages: [CreateTextMessageNoTextMessageConversationBackrefInput!] """Accounts linked to this conversation.""" accountRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Contacts linked to this conversation.""" contactRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Projects linked to this conversation.""" projectRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Leads linked to this conversation.""" leadRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Opportunities linked to this conversation.""" opportunityRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Quotes linked to this conversation.""" quoteRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] } """ Field values of a new TextMessage record, created together with the record it belongs to. """ input CreateTextMessageNoTextMessageConversationBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: ID """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: String! """Timestamp the message was sent.""" datetimeSent: DateTime """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnum! """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: String """ Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. """ score: Int """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnum """Revision when entity was lastly changed.""" revision: Int """Files attached to the message (e.g. MMS attachments).""" attachments: [CreateCloudObjectRelationNoBackrefInput!] } """ Field values of a new TextMessageConversationRelations record, created together with the record it belongs to. """ input CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput { """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project, or empty when not linked.""" projectId: ID """Id of the linked quote, or empty when not linked.""" quoteId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTextMessageConversation mutation.""" type UpdateTextMessageConversationPayload { """The updated record.""" textMessageConversation: TextMessageConversationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a TextMessageConversation record and the field values to change.""" input UpdateTextMessageConversationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the sender phone.""" phoneId: ID """Id of the matched account.""" recipientAccountId: ID """Id of the matched contact.""" recipientContactId: ID """ External phone number of the conversation recipient. Cannot be changed once the conversation has started. """ recipientPhoneNumber: String """Revision when entity was lastly changed.""" revision: Int """Messages exchanged in the conversation, ordered by send time.""" messages: [CreateOrUpdateTextMessageNoTextMessageConversationBackrefInput!] """Accounts linked to this conversation.""" accountRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Contacts linked to this conversation.""" contactRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Projects linked to this conversation.""" projectRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Leads linked to this conversation.""" leadRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Opportunities linked to this conversation.""" opportunityRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] """Quotes linked to this conversation.""" quoteRelations: [CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput!] } """ Field values of a TextMessage record to create, or to update when its id is set, together with the record it belongs to. """ input CreateOrUpdateTextMessageNoTextMessageConversationBackrefInput { """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the AI assistant chat conversation this message belongs to, when applicable. """ chatConversationId: ID """ Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). """ content: String """Timestamp the message was sent.""" datetimeSent: DateTime """Direction of the message (Incoming, Outgoing).""" direction: EmailDirectionEnum """ External message identifier from the SMS provider (e.g. Twilio Message SID). """ messageSid: String """ Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. """ score: Int """ Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. """ status: TextMessageStatusEnum """Revision when entity was lastly changed.""" revision: Int """Files attached to the message (e.g. MMS attachments).""" attachments: [CreateCloudObjectRelationNoBackrefInput!] } """Result of the createTextMessageConversationRelations mutation.""" type CreateTextMessageConversationRelationsPayload { """The created record.""" textMessageConversationRelations: TextMessageConversationRelationsEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new TextMessageConversationRelations record.""" input CreateTextMessageConversationRelationsInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project, or empty when not linked.""" projectId: ID """Id of the linked quote, or empty when not linked.""" quoteId: ID """Id of the text message conversation this link belongs to.""" textMessageConversationId: ID! """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTextMessageConversationRelations mutation.""" type UpdateTextMessageConversationRelationsPayload { """The updated record.""" textMessageConversationRelations: TextMessageConversationRelationsEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """ Id of a TextMessageConversationRelations record and the field values to change. """ input UpdateTextMessageConversationRelationsInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project, or empty when not linked.""" projectId: ID """Id of the linked quote, or empty when not linked.""" quoteId: ID """Id of the text message conversation this link belongs to.""" textMessageConversationId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateTextMessageConversationRelations mutation.""" type BulkUpdateTextMessageConversationRelationsPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a TextMessageConversationRelations record to create, or to update when its id is set. """ input CreateOrUpdateTextMessageConversationRelationsInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """Id of the linked account.""" accountId: ID """Id of the linked contact.""" contactId: ID """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: ID """Id of the linked project, or empty when not linked.""" projectId: ID """Id of the linked quote, or empty when not linked.""" quoteId: ID """Id of the text message conversation this link belongs to.""" textMessageConversationId: ID """Revision when entity was lastly changed.""" revision: Int } """Id of the TextMessageConversationRelations record to delete.""" input DeleteTextMessageConversationRelationsInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """ Id of the lead or opportunity the conversation is linked to, or empty when not linked. """ leadOpptyId: ID } """Result of the deleteTextMessageConversationRelations mutation.""" type DeleteTextMessageConversationRelationsPayload { """The deleted record.""" textMessageConversationRelations: TextMessageConversationRelationsEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the deleteTranslation mutation.""" type DeleteTranslationPayload { """The deleted record.""" translation: TranslationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the deleteTranslation mutation.""" input DeleteDraftTranslationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID } """Result of the createTranslation mutation.""" type CreateTranslationPayload { """The created record.""" translation: TranslationEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the createTranslation mutation.""" input CreateDraftTranslationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ accountTypeId: ID """ Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ appointmentTypeId: ID """ Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ contactTypeId: ID """Id of the translated data option.""" dataId: ID """Translated text in German.""" deDe: String """Translated text in US English.""" enUs: String """Translated text in Spanish.""" esEs: String """Id of the translated field.""" fieldId: ID """ Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription. """ formType: FormTypeEnum """ Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription). """ labelType: TranslationLabelTypeEnum! """ Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ leadTypeId: ID """Id of the opportunity product relation type.""" opptyProductRelationTypeId: ID """Id of the opportunity type.""" opptyTypeId: ID """ Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ productTypeId: ID """ Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ projectTypeId: ID """Translated text in Brazilian Portuguese.""" ptBr: String """ Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ taskTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the updateTranslation mutation.""" type UpdateTranslationPayload { """The updated record.""" translation: TranslationEntity! """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Parameters of the updateTranslation mutation.""" input UpdateDraftTranslationInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Specifies if the entity is considered deleted.""" isDeleted: Boolean """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ accountTypeId: ID """ Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ appointmentTypeId: ID """ Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ contactTypeId: ID """Id of the translated data option.""" dataId: ID """Translated text in German.""" deDe: String """Translated text in US English.""" enUs: String """Translated text in Spanish.""" esEs: String """Id of the translated field.""" fieldId: ID """ Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription. """ formType: FormTypeEnum """ Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription). """ labelType: TranslationLabelTypeEnum """ Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ leadTypeId: ID """Id of the opportunity product relation type.""" opptyProductRelationTypeId: ID """Id of the opportunity type.""" opptyTypeId: ID """ Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ productTypeId: ID """ Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ projectTypeId: ID """Translated text in Brazilian Portuguese.""" ptBr: String """ Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription. """ taskTypeId: ID """Revision when entity was lastly changed.""" revision: Int } """Result of the createUnsubscribedPhone mutation.""" type CreateUnsubscribedPhonePayload { """The created record.""" unsubscribedPhone: UnsubscribedPhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new UnsubscribedPhone record.""" input CreateUnsubscribedPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Phone number that has unsubscribed from receiving SMS messages, in E.164 format. """ phone: String """Revision when entity was lastly changed.""" revision: Int } """Result of the updateUnsubscribedPhone mutation.""" type UpdateUnsubscribedPhonePayload { """The updated record.""" unsubscribedPhone: UnsubscribedPhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of an UnsubscribedPhone record and the field values to change.""" input UpdateUnsubscribedPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Phone number that has unsubscribed from receiving SMS messages, in E.164 format. """ phone: String """Revision when entity was lastly changed.""" revision: Int } """Result of the bulkUpdateUnsubscribedPhone mutation.""" type BulkUpdateUnsubscribedPhonePayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of an UnsubscribedPhone record to create, or to update when its id is set. """ input CreateOrUpdateUnsubscribedPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Phone number that has unsubscribed from receiving SMS messages, in E.164 format. """ phone: String """Revision when entity was lastly changed.""" revision: Int } """Id of the UnsubscribedPhone record to delete.""" input DeleteUnsubscribedPhoneInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteUnsubscribedPhone mutation.""" type DeleteUnsubscribedPhonePayload { """The deleted record.""" unsubscribedPhone: UnsubscribedPhoneEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createWebhook mutation.""" type CreateWebhookPayload { """The created record.""" webhook: WebhookEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new Webhook record.""" input CreateWebhookInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ If True, remote side ssl certificate will not be validated when delivering notifications. """ insecureSsl: Boolean! "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttps://developers.coevera.com/reference/rest/\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n \"entity\": {\n \"Contact\": {\n \"expand\": [\n \"primary_account\",\n \"primary_contact\",\n \"task_relations.task\"\n ],\n \"load-only\": [\n \"id\",\n \"primary_account\",\n \"primary_contact.first_name\",\n \"task_relations.task\"\n ],\n \"filter\": {\n \"email1\": [\"test@example.com\", \"test@example.net\"],\n \"email2\": \"test@example.com\"\n },\n \"filter-op\": {\"email1\": \"eq\"}, # optional, default operator is eq\n \"on-field-change\": [\"email1\"]\n },\n \"Account\": {\n \"filter\": {\n \"owner_id\": [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n }\n }\n },\n \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}\n" options: JSONString """ Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. """ signature: ID """Target URL that webhook event payloads are POSTed to.""" url: String! """ Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space. """ events: [EventEnum!]! } """Result of the updateWebhook mutation.""" type UpdateWebhookPayload { """The updated record.""" webhook: WebhookEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a Webhook record and the field values to change.""" input UpdateWebhookInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ If True, remote side ssl certificate will not be validated when delivering notifications. """ insecureSsl: Boolean "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttps://developers.coevera.com/reference/rest/\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n \"entity\": {\n \"Contact\": {\n \"expand\": [\n \"primary_account\",\n \"primary_contact\",\n \"task_relations.task\"\n ],\n \"load-only\": [\n \"id\",\n \"primary_account\",\n \"primary_contact.first_name\",\n \"task_relations.task\"\n ],\n \"filter\": {\n \"email1\": [\"test@example.com\", \"test@example.net\"],\n \"email2\": \"test@example.com\"\n },\n \"filter-op\": {\"email1\": \"eq\"}, # optional, default operator is eq\n \"on-field-change\": [\"email1\"]\n },\n \"Account\": {\n \"filter\": {\n \"owner_id\": [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n }\n }\n },\n \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}\n" options: JSONString """ Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. """ signature: ID """Target URL that webhook event payloads are POSTed to.""" url: String """ Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space. """ events: [EventEnum!] } """Result of the bulkUpdateWebhook mutation.""" type BulkUpdateWebhookPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a Webhook record to create, or to update when its id is set. """ input CreateOrUpdateWebhookInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ If True, remote side ssl certificate will not be validated when delivering notifications. """ insecureSsl: Boolean "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttps://developers.coevera.com/reference/rest/\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n \"entity\": {\n \"Contact\": {\n \"expand\": [\n \"primary_account\",\n \"primary_contact\",\n \"task_relations.task\"\n ],\n \"load-only\": [\n \"id\",\n \"primary_account\",\n \"primary_contact.first_name\",\n \"task_relations.task\"\n ],\n \"filter\": {\n \"email1\": [\"test@example.com\", \"test@example.net\"],\n \"email2\": \"test@example.com\"\n },\n \"filter-op\": {\"email1\": \"eq\"}, # optional, default operator is eq\n \"on-field-change\": [\"email1\"]\n },\n \"Account\": {\n \"filter\": {\n \"owner_id\": [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n }\n }\n },\n \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}\n" options: JSONString """ Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in "WebHook-Signature" header. """ signature: ID """Target URL that webhook event payloads are POSTed to.""" url: String """ Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space. """ events: [EventEnum!] } """Id of the Webhook record to delete.""" input DeleteWebhookInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteWebhook mutation.""" type DeleteWebhookPayload { """The deleted record.""" webhook: WebhookEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Result of the createWebhookEvent mutation.""" type CreateWebhookEventPayload { """The created record.""" webhookEvent: WebhookEventEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Field values of a new WebhookEvent record.""" input CreateWebhookEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space. """ event: EventEnum! """Id of the parent webhook.""" webhookId: ID! } """Result of the updateWebhookEvent mutation.""" type UpdateWebhookEventPayload { """The updated record.""" webhookEvent: WebhookEventEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String } """Id of a WebhookEvent record and the field values to change.""" input UpdateWebhookEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space. """ event: EventEnum """Id of the parent webhook.""" webhookId: ID } """Result of the bulkUpdateWebhookEvent mutation.""" type BulkUpdateWebhookEventPayload { """ Ids of the created, updated and deleted records, and the items that failed. """ result: BulkUpdateResults! } """ Field values of a WebhookEvent record to create, or to update when its id is set. """ input CreateOrUpdateWebhookEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID """Last modification time.""" modified: DateTime """Creation time.""" created: DateTime """ Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space. """ event: EventEnum """Id of the parent webhook.""" webhookId: ID } """Id of the WebhookEvent record to delete.""" input DeleteWebhookEventInput { """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String """Unique identifier of entity.""" id: ID! } """Result of the deleteWebhookEvent mutation.""" type DeleteWebhookEventPayload { """The deleted record.""" webhookEvent: WebhookEventEntity """ Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). """ clientMutationId: String }