GraphQL RepositoriesopptyRevenueSchedulePeriod

`entities.opptyRevenueSchedulePeriod`

Read oppty revenue schedule period records with the opptyRevenueSchedulePeriod repository, and change them with the oppty revenue schedule period mutations. Same records as the REST OpptyRevenueSchedulePeriods entity.

Example: first three oppty revenue schedule period recordsGraphQLcURL

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

Queries

Fields of entities { opptyRevenueSchedulePeriod { … } }.

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.	OpptyRevenueSchedulePeriodEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[OpptyRevenueSchedulePeriodEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: OpptyRevenueSchedulePeriodFilterInput, orderBy: [OpptyRevenueSchedulePeriodOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[OpptyRevenueSchedulePeriodEntity!]!
QUERY	`getByCriteria`(filter: OpptyRevenueSchedulePeriodFilterInput, orderBy: [OpptyRevenueSchedulePeriodOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	OpptyRevenueSchedulePeriodEntityConnection
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.

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

One period of an opportunity revenue schedule, with its date and amount.

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.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`opptyRevenueSchedule`	OpptyRevenueScheduleEntity	Parent revenue schedule this period belongs to.
`date`	Date	Recognition date of this period.
`opptyRevenueScheduleId`	ID!	Id of the parent revenue schedule.
`transactionId`	ID!	Identifier linking the period to the recognition transaction.
`value`	Float	Amount recognised in this period.
`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.

OpptyRevenueSchedulePeriodEntityConnection object pageInfo: PageInfo!, edges: [OpptyRevenueSchedulePeriodEntityEdge]!, totalCount: Int

Paginated list of OpptyRevenueSchedulePeriod records.

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

OpptyRevenueSchedulePeriodEntityEdge object node: OpptyRevenueSchedulePeriodEntity, cursor: String!

A Relay edge containing a OpptyRevenueSchedulePeriodEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[OpptyRevenueSchedulePeriodFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[OpptyRevenueSchedulePeriodFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	OpptyRevenueSchedulePeriodFilterInput	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.
`opptyRevenueScheduleId`	EntityFilterStringField	Id of the parent revenue schedule.
`transactionId`	EntityFilterStringField	Identifier linking the period to the recognition transaction.
`value`	EntityFilterNumberField	Amount recognised in this period.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`opptyRevenueSchedule`	OpptyRevenueScheduleFilterInput	Parent revenue schedule this period belongs to. Matches records where a related record meets these conditions.

OpptyRevenueSchedulePeriodOrderByInput input Asc or Desc per field

Sorting of OpptyRevenueSchedulePeriod 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.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`opptyRevenueSchedule`	[OpptyRevenueScheduleOrderByNestedInput!]	Parent revenue schedule this period belongs to. Sorts by fields of the related record, listed in order of priority.
`date`	OrderByEnum	Recognition date of this period.
`opptyRevenueScheduleId`	OrderByEnum	Id of the parent revenue schedule.
`value`	OrderByEnum	Amount recognised in this period.
`revision`	OrderByEnum	Revision when entity was lastly changed.