Skip to content
Patrimoine
v9.1.0

Payday Plan Endpoint

GET
/api/v1/envelopes/payday-plan
curl --request GET \
  --url 'https://example.com/api/v1/envelopes/payday-plan?limit=50&offset=0'

What each pay schedule sets aside for the envelopes and goals that use it.

One group per schedule with at least one line (the default schedule first, then by next payday): the lines’ per-payday amounts and their total, in the user’s base currency. A suggestion only; nothing is posted and no money moves.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 250
offset
Offset
integer
0

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Payday Plan Endpoint Api V1 Envelopes Payday Plan Get
Array<object>
PaydayPlanItem
object
schedule_id
required
Schedule Id
integer
schedule_name
required
Schedule Name
string
is_default
required
Is Default
boolean
next_date
required
Any of:
string format: date
lines
required
Lines
Array<object>
PaydayPlanLine
object
kind
required
Kind
string
Allowed values: envelope goal
id
required
Id
integer
name
required
Name
string
due_date
required
Any of:
string format: date
remaining_amount
required
Remaining Amount
string
paydays_remaining
required
Any of:
integer
suggested_per_payday
required
Any of:
string
total_set_aside
required
Total Set Aside
string

Example 

[
  {
    "lines": [
      {
        "kind": "envelope"
      }
    ]
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

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