Create Schedule

POST

/schedules

curl --request POST \
  --url https://example.com/schedules \
  --header 'Content-Type: application/json' \
  --data '{ "account": "example", "amount": 1, "amount_type": "fixed", "autopost_policy": "auto_post", "category": "example", "counterparty_account": "example", "dtstart": "2026-04-15", "estimate_basis": "last", "name": "example", "note": "example", "payee": "example", "propose": false, "rrule": "example" }'

Create a bill/income schedule, active. With propose=true it lands a SUGGESTION instead (status='proposed', suggestion_id) that the user’s decision turns into the schedule. A proposal for a payee or counterparty the account already has a schedule for is refused (422, naming that schedule).

Request Body^required

Media typeapplication/json

ScheduleCreate

object

account

required

Account

Account id or path

string

amount

Any of:

number

number

string

string

null

null

amount_type

Amount Type

string

default: fixed

Allowed values: fixed estimated

autopost_policy

Autopost Policy

string

default: wait_for_match

Allowed values: auto_post wait_for_match reminder_only

category

Any of:

string

string

null

null

counterparty_account

Any of:

string

string

null

null

dtstart

Any of:

string

string format: date

null

null

estimate_basis

Any of:

string

string

Allowed values: last rolling_avg_3 rolling_avg_12 counterparty_balance

null

null

name

required

Name

string

note

Any of:

string

string

<= 200 characters

null

null

payee

Any of:

string

string

null

null

propose

Propose

Land a suggestion in the inbox for the user to decide instead of creating the schedule; for an agent acting on its own initiative (#436)

boolean

rrule

required

Rrule

RFC 5545 RRULE, e.g. FREQ=MONTHLY;BYMONTHDAY=19

string

Responses

201

Successful Response

Media typeapplication/json

Any of:

ScheduleOut

ScheduleOut

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

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

SuggestionRef

SuggestionRef

What a propose=true create returns (#233, #436): the suggestion the draft landed in, not a schedule. status='proposed' keeps the old contract readable; suggestion_id is the row to decide on.

object

headline

required

Headline

string

id

required

Id

string format: uuid

kind

Kind

string

default: schedule

Allowed value: schedule

source

required

Source

string

status

Status

string

default: proposed

Allowed value: proposed

suggestion_id

required

Suggestion Id

string format: uuid

Example

{
  "kind": "schedule",
  "status": "proposed"
}

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"
    }
  ]
}