---
title: "OpptyRevenueSchedules.list"
method: GET
path: "/entities/OpptyRevenueSchedules"
tags: ["Lead & Opportunity"]
---

# OpptyRevenueSchedules.list

`GET /entities/OpptyRevenueSchedules`

Returns all defined OpptyRevenueSchedules

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

list of OpptyRevenueSchedules

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` OpptyRevenueSchedule[]
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity. Must match with Opportunity id.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `cancelation_date` string, date — Date when the revenue schedule was cancelled. Empty for active schedules.
    - `period_count` integer — Number of periods the opportunity value is split into.
    - `period_type` 1 | 2 | 3 — Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year
    - `start_date` string, date — Date when revenue recognition for the opportunity begins.
    - `revision` integer — Revision when entity was lastly changed.
    - `periods` string[] — Periods produced by this revenue schedule, ordered by date.
  - `page_info` object — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
    - `start_cursor` string — Start cursor of result set.
    - `end_cursor` string — End cursor of result set.
    - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it).
    - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it).

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)