GraphQL RepositoriesopptyRevenueSchedule

`entities.opptyRevenueSchedule`

Read oppty revenue schedule records with the opptyRevenueSchedule repository, and change them with the oppty revenue schedule mutations. Same records as the REST OpptyRevenueSchedules entity.

Example: first three oppty revenue schedule recordsGraphQLcURL

query FirstOpptyRevenueSchedules {
  entities {
    opptyRevenueSchedule {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

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 FirstOpptyRevenueSchedules { entities { opptyRevenueSchedule { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { opptyRevenueSchedule { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	OpptyRevenueScheduleEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[OpptyRevenueScheduleEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: OpptyRevenueScheduleFilterInput, orderBy: [OpptyRevenueScheduleOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[OpptyRevenueScheduleEntity!]!
QUERY	`getByCriteria`(filter: OpptyRevenueScheduleFilterInput, orderBy: [OpptyRevenueScheduleOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	OpptyRevenueScheduleEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

OpptyRevenueScheduleEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Revenue schedule that splits the value of an opportunity into periods.

Field	Type	Description
`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. Must match with Opportunity id.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`cancelationDate`	Date	Date when the revenue schedule was cancelled. Empty for active schedules.
`periodCount`	Int	Number of periods the opportunity value is split into.
`periodType`	RevenueSchedulePeriodTypeEnum	Length of each period (e.g. Monthly, Quarterly, Yearly).
`startDate`	Date	Date when revenue recognition for the opportunity begins.
`revision`	Int	Revision when entity was lastly changed.
`periods`	OpptyRevenueSchedulePeriodEntityConnection (7 args)	Periods produced by this revenue schedule, ordered by date.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

OpptyRevenueScheduleEntityConnection object pageInfo: PageInfo!, edges: [OpptyRevenueScheduleEntityEdge]!, totalCount: Int

Paginated list of OpptyRevenueSchedule records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[OpptyRevenueScheduleEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

OpptyRevenueScheduleEntityEdge object node: OpptyRevenueScheduleEntity, cursor: String!

A Relay edge containing a OpptyRevenueScheduleEntity and its cursor.

Field	Type	Description
`node`	OpptyRevenueScheduleEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

OpptyRevenueScheduleFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for OpptyRevenueSchedule records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[OpptyRevenueScheduleFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[OpptyRevenueScheduleFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	OpptyRevenueScheduleFilterInput	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. Must match with Opportunity id.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`periodCount`	EntityFilterNumberField	Number of periods the opportunity value is split into.
`periodType`	RevenueSchedulePeriodTypeEnumFilterInput	Length of each period (e.g. Monthly, Quarterly, Yearly).
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`periods`	OpptyRevenueSchedulePeriodFilterInput	Periods produced by this revenue schedule, ordered by date. Matches records where a related record meets these conditions.

OpptyRevenueScheduleOrderByInput input Asc or Desc per field

Sorting of OpptyRevenueSchedule records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity. Must match with Opportunity id.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`cancelationDate`	OrderByEnum	Date when the revenue schedule was cancelled. Empty for active schedules.
`periodCount`	OrderByEnum	Number of periods the opportunity value is split into.
`startDate`	OrderByEnum	Date when revenue recognition for the opportunity begins.
`revision`	OrderByEnum	Revision when entity was lastly changed.