--- title: entities.opptyRecurrence description: Read oppty recurrence records with the opptyRecurrence repository, and change them with the oppty recurrence mutations. Same records as the REST OpptyRecurrences entity. canonical: https://developers.coevera.com/reference/graphql/oppty-recurrence/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.opptyRecurrence Read oppty recurrence records with the opptyRecurrence repository, and change them with the oppty recurrence mutations. Same records as the REST OpptyRecurrences entity. REST: [OpptyRecurrences](https://developers.coevera.com/reference/rest/oppty-recurrences.md). ## Queries - `getById(entityId: ID!): OpptyRecurrenceEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [OpptyRecurrenceEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. - `getAll(limit: Int, offset: Int, filter: OpptyRecurrenceFilterInput, orderBy: [OpptyRecurrenceOrderByInput!], includeDeleted: Boolean): [OpptyRecurrenceEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: OpptyRecurrenceFilterInput, orderBy: [OpptyRecurrenceOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): OpptyRecurrenceEntityConnection` Returns the records that match the filter as a cursor-paginated connection. - `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. ## Mutations - `createOpptyRecurrence(input: CreateOpptyRecurrenceInput!, validationLevel: [ValidationLevel!]): CreateOpptyRecurrencePayload` Create one record. - `updateOpptyRecurrence(input: UpdateOpptyRecurrenceInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateOpptyRecurrencePayload` Update fields. - `bulkUpdateOpptyRecurrence(input: [CreateOrUpdateOpptyRecurrenceInput!]!, deleteInput: [DeleteOpptyRecurrenceInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateOpptyRecurrencePayload` Create or update many; per-item results. - `deleteOpptyRecurrence(input: DeleteOpptyRecurrenceInput!): DeleteOpptyRecurrencePayload` Soft-delete. ## Types ### OpptyRecurrenceEntity (object) Recurrence rule that creates new copies of an opportunity on a schedule, e.g. for repeat deals once it is won or lost. - `isDeleteProtected: 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. - `id: ID!` Unique identifier of entity. - `isDeleted: Boolean` Specifies if the entity is considered deleted. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `oppty: OpportunityEntity` Opportunity this recurrence belongs to. Each recurrence is bound to exactly one opportunity. - `step: StepEntity` Pipeline step that newly generated opportunities are placed in. - `condition: Int` Bit Flag field, with limited combination of integer values. - `day: DateDayEnum` 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. - `dayOfWeek: Int` Bit Flag field, with limited combination of integer values. - `endDate: Date` Date information. The last date when no more other items should be created. - `month: DateMonthEnum` 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. - `occurEvery: Int` The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. - `occurrencesCount: 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. - `opptyId: ID!` Id of the parent opportunity. - `startDate: Date!` Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. - `stepId: ID!` Id of the pipeline step the opportunities created by the recurrence start in. - `type: RecurrenceTypeEnum` Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). - `week: DateWeekEnum` 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. - `revision: Int` Revision when entity was lastly changed. - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. ### OpptyRecurrenceEntityConnection (object) Paginated list of OpptyRecurrence records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [OpptyRecurrenceEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### OpptyRecurrenceEntityEdge (object) A Relay edge containing a `OpptyRecurrenceEntity` and its cursor. - `node: OpptyRecurrenceEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### OpptyRecurrenceFilterInput (input) Filter conditions for OpptyRecurrence records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [OpptyRecurrenceFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [OpptyRecurrenceFilterInput!]` Matches records that meet all of the listed filters. - `NOT: OpptyRecurrenceFilterInput` Matches records that do not meet this filter. - `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity. - `id: EntityFilterStringField` Unique identifier of entity. - `isDeleted: Boolean` Specifies if the entity is considered deleted. - `modified: EntityFilterDateTimeField` Last modification time. - `created: EntityFilterDateTimeField` Creation time. - `condition: RecurrenceConditionEnumFilterInput` Bit Flag field, with limited combination of integer values. - `day: DateDayEnumFilterInput` 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. - `dayOfWeek: DateDayOfWeekEnumFilterInput` Bit Flag field, with limited combination of integer values. - `month: DateMonthEnumFilterInput` 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. - `occurEvery: EntityFilterNumberField` The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. - `occurrencesCount: 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. - `opptyId: EntityFilterStringField` Id of the parent opportunity. - `stepId: EntityFilterStringField` Id of the pipeline step the opportunities created by the recurrence start in. - `type: RecurrenceTypeEnumFilterInput` Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). - `week: DateWeekEnumFilterInput` 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. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `oppty: OpportunityFilterInput` Opportunity this recurrence belongs to. Each recurrence is bound to exactly one opportunity. Matches records where a related record meets these conditions. - `step: StepFilterInput` Pipeline step that newly generated opportunities are placed in. Matches records where a related record meets these conditions. ### OpptyRecurrenceOrderByInput (input) Sorting of OpptyRecurrence records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. - `id: OrderByEnum` Unique identifier of entity. - `isDeleted: OrderByEnum` Specifies if the entity is considered deleted. - `modified: OrderByEnum` Last modification time. - `created: OrderByEnum` Creation time. - `oppty: [OpportunityOrderByNestedInput!]` 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. - `step: [StepOrderByNestedInput!]` Pipeline step that newly generated opportunities are placed in. Sorts by fields of the related record, listed in order of priority. - `condition: OrderByEnum` Bit Flag field, with limited combination of integer values. - `day: 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. - `dayOfWeek: OrderByEnum` Bit Flag field, with limited combination of integer values. - `endDate: OrderByEnum` Date information. The last date when no more other items should be created. - `month: 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. - `occurEvery: OrderByEnum` The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. - `occurrencesCount: 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. - `opptyId: OrderByEnum` Id of the parent opportunity. - `startDate: OrderByEnum` Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. - `stepId: OrderByEnum` Id of the pipeline step the opportunities created by the recurrence start in. - `type: OrderByEnum` Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). - `week: 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. - `revision: OrderByEnum` Revision when entity was lastly changed. ### RecurrenceConditionEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [RecurrenceConditionEnum!]` Matches any of the listed values. - `NOT: RecurrenceConditionEnumFilterInput` Matches values that do not meet this condition. ### CreateOpptyRecurrenceInput (input) Field values of a new OpptyRecurrence record. - `clientMutationId: 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). - `applyRecurrence: Boolean` 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 - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `condition: Int` Bit Flag field, with limited combination of integer values. - `day: DateDayEnum` 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. - `dayOfWeek: Int` Bit Flag field, with limited combination of integer values. - `endDate: Date` Date information. The last date when no more other items should be created. - `month: DateMonthEnum` 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. - `occurEvery: Int` The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. - `occurrencesCount: 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. - `opptyId: ID!` Id of the parent opportunity. - `startDate: Date!` Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. - `stepId: ID!` Id of the pipeline step the opportunities created by the recurrence start in. - `type: RecurrenceTypeEnum` Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). - `week: DateWeekEnum` 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. - `revision: Int` Revision when entity was lastly changed. ### CreateOrUpdateOpptyRecurrenceInput (input) Field values of an OpptyRecurrence record to create, or to update when its id is set. - `clientMutationId: 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). - `applyRecurrence: Boolean` 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 - `id: ID` Unique identifier of entity. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `condition: Int` Bit Flag field, with limited combination of integer values. - `day: DateDayEnum` 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. - `dayOfWeek: Int` Bit Flag field, with limited combination of integer values. - `endDate: Date` Date information. The last date when no more other items should be created. - `month: DateMonthEnum` 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. - `occurEvery: Int` The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. - `occurrencesCount: 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. - `opptyId: ID` Id of the parent opportunity. - `startDate: Date` Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. - `stepId: ID` Id of the pipeline step the opportunities created by the recurrence start in. - `type: RecurrenceTypeEnum` Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). - `week: DateWeekEnum` 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. - `revision: Int` Revision when entity was lastly changed. ### DeleteOpptyRecurrenceInput (input) Id of the OpptyRecurrence record to delete. - `clientMutationId: 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). - `id: ID!` Unique identifier of entity. ### UpdateOpptyRecurrenceInput (input) Id of an OpptyRecurrence record and the field values to change. - `clientMutationId: 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). - `applyRecurrence: Boolean` 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 - `id: ID!` Unique identifier of entity. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `condition: Int` Bit Flag field, with limited combination of integer values. - `day: DateDayEnum` 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. - `dayOfWeek: Int` Bit Flag field, with limited combination of integer values. - `endDate: Date` Date information. The last date when no more other items should be created. - `month: DateMonthEnum` 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. - `occurEvery: Int` The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. - `occurrencesCount: 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. - `opptyId: ID` Id of the parent opportunity. - `startDate: Date` Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. - `stepId: ID` Id of the pipeline step the opportunities created by the recurrence start in. - `type: RecurrenceTypeEnum` Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative). - `week: DateWeekEnum` 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. - `revision: Int` Revision when entity was lastly changed. ### BulkUpdateOpptyRecurrencePayload (object) Result of the bulkUpdateOpptyRecurrence mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateOpptyRecurrencePayload (object) Result of the createOpptyRecurrence mutation. - `opptyRecurrence: OpptyRecurrenceEntity` The created record. - `clientMutationId: 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). ### DeleteOpptyRecurrencePayload (object) Result of the deleteOpptyRecurrence mutation. - `opptyRecurrence: OpptyRecurrenceEntity` The deleted record. - `clientMutationId: 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). ### UpdateOpptyRecurrencePayload (object) Result of the updateOpptyRecurrence mutation. - `opptyRecurrence: OpptyRecurrenceEntity` The updated record. - `clientMutationId: 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). ### RecurrenceConditionEnum (enum) Opportunity outcomes that trigger creation of the next opportunity in a recurring series; values can be combined. - `Won` The next opportunity is created when the current one is won. - `Lost` The next opportunity is created when the current one is lost. Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file. ## Example ```graphql query FirstOpptyRecurrences { entities { opptyRecurrence { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } } ``` ```bash curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \ --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \ --header 'Content-Type: application/json' \ --data '{"query":"query FirstOpptyRecurrences { entities { opptyRecurrence { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```