# Read what is planned for a customer or a payment request

The plan is a forecast rather than a record. It is recalculated as other activity changes what is needed, so a row is only true as at the moment it is read. While a recalculation is outstanding the plan is a single REASSESS row and nothing else.

Endpoint: GET /scheduled_activities
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Query parameters:

  - `entityType` (string)
    The kind of record to read the plan for. Required, together with entityId. Only CUSTOMER and PAYMENT_REQUEST have a plan.
    Enum: "INVOICE", "PAYMENT_REQUEST", "CUSTOMER", "SCHEDULE"

  - `entityId` (string)
    The record to read the plan for, as a UUID. Required, together with entityType.
    Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

  - `page` (integer)
    Which page to return, counting from one.
    Example: 1

  - `size` (integer)
    How many rows to return per page. A request for more than the maximum is refused.
    Example: 50

  - `sort` (string)
    How to order the page. The direction is optional and defaults to soonest first.
    Enum: "scheduledAt,asc", "scheduledAt,desc", "scheduledAt"

## Response 200 fields (application/json):

  - `activities` (array, required)
    What is planned, soonest first unless another order was asked for.

  - `activities.id` (string, required)
    This row, for reading the message it would send. Opaque, and only good for as long as the plan is unchanged.

  - `activities.scheduledAt` (string, required)
    When it is expected to happen.

  - `activities.entityType` (string, required)
    The kind of record it is planned against.
    Enum: "INVOICE", "PAYMENT_REQUEST", "CUSTOMER", "SCHEDULE"

  - `activities.entityId` (string, required)
    The record it is planned against.

  - `activities.type` (string, required)
    What is planned.
    Enum: "SEND_NOTIFICATION", "SEND_CUSTOMER_STATEMENT", "SEND_DIRECT_DEBIT_COLLECTION_NOTICE", "SEND_CARD_COLLECTION_NOTICE", "SEND_MANDATE_REQUEST", "SEND_MANDATE_REMINDER", "SEND_CARD_REQUEST", "SEND_CARD_REMINDER", "MAKE_PAYMENT", "COLLECT_DIRECT_DEBIT_PAYMENT", "COLLECT_CARD_PAYMENT", "APPLY_LATE_FEES", "PREVIEW_CHARGE_DATE", "PREVIEW_PAYOUT_DATE", "REASSESS", "ACTIVITY_SCHEDULED"

  - `activities.display` (object, required)
    What is planned, written out ready to show.

  - `activities.display.title` (string, required)
    What happened, in a few words.

  - `activities.display.summary` (string)
    The detail beneath the title. Absent where the title says everything.

  - `activities.actions` (array, required)
    What can be done about it. Empty where there is nothing to offer.

  - `activities.actions.action` (string, required)
    What the action does.
    Enum: "PREVIEW_NOTIFICATION"

  - `activities.actions.method` (string, required)
    The HTTP method to call it with.

  - `activities.actions.href` (string, required)
    The path to call it on.

  - `pagination` (object, required)
    Where this page sits in the whole result.

  - `pagination.page` (integer)
    The current page number One-based page index (1..N).

  - `pagination.size` (integer)
    The size of the page, i.e., the number of elements per page.

  - `pagination.totalPages` (integer)
    The total number of pages available.

  - `pagination.totalElements` (integer)
    The total number of elements across all pages.

  - `pagination.numberOfElements` (integer)
    The number of elements in the current page.

  - `pagination.sort` (string)
    Sorting criteria in the format: property,(asc|desc).

## Response 400 fields (application/json):

  - `type` (string)

  - `title` (string)

  - `status` (integer)

  - `detail` (string)

  - `instance` (string)

  - `properties` (object)

  - `errors` (array)

  - `errors.message` (string)


## Response 401 fields

## Response 403 fields

## Response 500 fields