---
title: entities.opptyProductRelationRevenueSchedulePeriod
description: Read oppty product relation revenue schedule period records with the opptyProductRelationRevenueSchedulePeriod repository, and change them with the oppty product relation revenue schedule period mutations. Same records as the REST OpptyProductRelationRevenueSchedulePeriods entity.
canonical: https://developers.coevera.com/reference/graphql/oppty-product-relation-revenue-schedule-period/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.opptyProductRelationRevenueSchedulePeriod

Read oppty product relation revenue schedule period records with the opptyProductRelationRevenueSchedulePeriod repository, and change them with the oppty product relation revenue schedule period mutations. Same records as the REST OpptyProductRelationRevenueSchedulePeriods entity.

REST: [OpptyProductRelationRevenueSchedulePeriods](https://developers.coevera.com/reference/rest/oppty-product-relation-revenue-schedule-periods.md).

## Queries

- `getById(entityId: ID!): OpptyProductRelationRevenueSchedulePeriodEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [OpptyProductRelationRevenueSchedulePeriodEntity!]!` 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: OpptyProductRelationRevenueSchedulePeriodFilterInput, orderBy: [OpptyProductRelationRevenueSchedulePeriodOrderByInput!], includeDeleted: Boolean): [OpptyProductRelationRevenueSchedulePeriodEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: OpptyProductRelationRevenueSchedulePeriodFilterInput, orderBy: [OpptyProductRelationRevenueSchedulePeriodOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): OpptyProductRelationRevenueSchedulePeriodEntityConnection` 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.

## Types

### OpptyProductRelationRevenueSchedulePeriodEntity (object)

One period of a product line item revenue schedule, with its date and amount.

- `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.
- `opptyProductRelationRevenueSchedule: OpptyProductRelationRevenueScheduleEntity` Parent revenue schedule this period belongs to.
- `date: Date` Recognition date of this period.
- `opptyProductRelationRevenueScheduleId: 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.

### OpptyProductRelationRevenueSchedulePeriodEntityConnection (object)

Paginated list of OpptyProductRelationRevenueSchedulePeriod records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [OpptyProductRelationRevenueSchedulePeriodEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### OpptyProductRelationRevenueSchedulePeriodEntityEdge (object)

A Relay edge containing a `OpptyProductRelationRevenueSchedulePeriodEntity` and its cursor.

- `node: OpptyProductRelationRevenueSchedulePeriodEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### OpptyProductRelationRevenueSchedulePeriodFilterInput (input)

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

- `OR: [OpptyProductRelationRevenueSchedulePeriodFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [OpptyProductRelationRevenueSchedulePeriodFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: OpptyProductRelationRevenueSchedulePeriodFilterInput` 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.
- `opptyProductRelationRevenueScheduleId: 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.
- `opptyProductRelationRevenueSchedule: OpptyProductRelationRevenueScheduleFilterInput` Parent revenue schedule this period belongs to. Matches records where a related record meets these conditions.

### OpptyProductRelationRevenueSchedulePeriodOrderByInput (input)

Sorting of OpptyProductRelationRevenueSchedulePeriod 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.
- `opptyProductRelationRevenueSchedule: [OpptyProductRelationRevenueScheduleOrderByNestedInput!]` 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.
- `opptyProductRelationRevenueScheduleId: OrderByEnum` Id of the parent revenue schedule.
- `value: OrderByEnum` Amount recognised in this period.
- `revision: OrderByEnum` Revision when entity was lastly changed.

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