Models

BillStore

object

currency_idstring

Use either currency_id or currency_code

Example

currency_codestring

Use either currency_id or currency_code

Example

EUR

namestringrequired

Example

Rent

amount_minstring<amount>required

Example

123.45

amount_maxstring<amount>required

Example

123.45

datestring<date-time>required

Example

2026-10-01T00:00:00+00:00

end_datestring<date-time>

The date after which this bill is no longer valid or applicable

Example

2026-10-31T23:59:59+00:00

extension_datestring<date-time>

The date before which the bill must be renewed (or cancelled)

Example

2026-10-31T23:59:59+00:00

repeat_freqBillRepeatFrequencyweeklymonthlyquarterlyhalf-yearyearlyrequired

How often the bill must be paid.

Example

monthly

skipinteger<int32>

How often the bill must be skipped. 1 means a bi-monthly bill.

Example

activeboolean

If the bill is active.

Example

true

notesstring | null

Example

Some example notes

object_group_idstring | null

The group ID of the group this object is part of. NULL if no group.

Example

object_group_titlestring | null

The name of the group. NULL if no group.

Example

Example Group

Example

{
  "currency_id": "5",
  "currency_code": "EUR",
  "name": "Rent",
  "amount_min": "123.45",
  "amount_max": "123.45",
  "date": "2026-10-01T00:00:00+00:00",
  "end_date": "2026-10-31T23:59:59+00:00",
  "extension_date": "2026-10-31T23:59:59+00:00",
  "repeat_freq": "monthly",
  "skip": 0,
  "active": true,
  "notes": "Some example notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}