ADadfin
Scheduled Activities

Read what is planned for a customer or a payment request

Changed on

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.

get/scheduled_activities

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/scheduled_activities
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Query parameters

entityType'INVOICE' | 'PAYMENT_REQUEST' | 'CUSTOMER' | 'SCHEDULE'

The kind of record an activity belongs to.

Example:CUSTOMER

The kind of record to read the plan for. Required, together with entityId. Only CUSTOMER and PAYMENT_REQUEST have a plan.

entityIdstring

The record to read the plan for, as a UUID. Required, together with entityType.

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6
pageinteger

Which page to return, counting from one.

Example:1
sizeinteger

How many rows to return per page. A request for more than the maximum is refused.

Example:50
sort'scheduledAt,asc' | 'scheduledAt,desc' | 'scheduledAt'

How to order the page. The direction is optional and defaults to soonest first.

Response

A page of the plan, soonest first unless another order was asked for. An empty list means nothing is planned.

Changes