Legacy (v1-compat)

Create a recurring/subscription transaction definition

post/groups/{groupId}/finance/recurring

Request

  • Base URL: https://whatareyoudo.ing/api/v1
  • URL: https://whatareyoudo.ing/api/v1/groups/{groupId}/finance/recurring
  • Auth: HTTP bearer

Path parameters

groupIdstring uuid required

Request body

namestring required
type'income' | 'expense' | 'transfer' required
amountnumber required
amountMinorstring

issue #63: exact alternative to amount -- wins when present

nextRunstring required
interval'day' | 'week' | 'month' | 'year'
intervalCountinteger
sourceAssetIdstring uuid nullable
destAssetIdstring uuid nullable
categoryIdstring uuid nullable
payeestring nullable
descriptionstring
activeboolean

Response

Created

idstring uuid required
namestring required
type'income' | 'expense' | 'transfer' required
amountnumber required
amount_minorstring required

issue #63: exact integer minor-units mirror of amount

currencystring required

What amount is in: the accounts' currency (ISO 4217).

source_asset_idstring uuid nullable required
dest_asset_idstring uuid nullable required
category_idstring uuid nullable required
payeestring nullable required
descriptionstring required
interval'day' | 'week' | 'month' | 'year' required
interval_countinteger required
next_runstring required
activeboolean required
can_editboolean

Whether the caller may change or remove it: its creator, or the group's owner/admin (never an admin of a system group). Present on list responses.

Changes

No recorded changes to this operation across all 6 revisions of this API.