Get Schedule

GET

/schedules/{schedule_id}

curl --request GET \
  --url https://example.com/schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

The rule plus its live instances (oldest first; overdue flagged).

Parameters

Path Parameters

schedule_id

required

Schedule Id

string format: uuid

Responses

200

Successful Response

Media typeapplication/json

ScheduleDetail

object

account_id

required

Account Id

string format: uuid

amount

required

Any of:

string

string

null

null

amount_type

required

Amount Type

string

autopost_policy

required

Autopost Policy

string

category_path

Any of:

string

string

null

null

counterparty_account_id

Any of:

string

string format: uuid

null

null

currency

required

Currency

string

dtstart

required

Dtstart

string format: date

ended_at

required

Any of:

string

string format: date-time

null

null

estimate_basis

required

Any of:

string

string

null

null

id

required

Id

string format: uuid

instances

required

Instances

Array<object>

InstanceOut

A live (unmatched) expected instance of a schedule.

object

amount

required

Any of:

string

string

null

null

basis

required

Basis

Where the amount comes from: fixed, an estimate basis (last, rolling_avg_3, rolling_avg_12, counterparty_balance = the card’s current balance), override (a pinned instance: the amount is yours) or statement (a recorded card statement balance, decision 80)

string

Allowed values: fixed last rolling_avg_3 rolling_avg_12 counterparty_balance override statement

date

required

Date

string format: date

occurrence_date

required

Any of:

string

string format: date

null

null

overdue

required

Overdue

boolean

pinned

required

Pinned

Edited by a human/agent; exempt from rule refresh/resync

boolean

statement_balance

Any of:

string

string

null

null

statement_date

Any of:

string

string format: date

null

null

statement_source

Any of:

string

string

Allowed values: human agent

null

null

transaction_id

required

Transaction Id

string format: uuid

name

required

Name

string

next_due

required

Any of:

string

string format: date

null

null

rrule

required

Rrule

string

source

required

Source

string

status

required

Status

string

Example

{
  "instances": [
    {
      "basis": "fixed",
      "statement_source": "human"
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}