Skip to main content

​
Default Access

A user will see the goodies module & have access to it in the frontend if
  • at least one goodies voucher exists
  • a planned voucher exists
  • the user has Default Access
Default access is useful if you want to grant the user the access to the goodies module to select their preferred voucher provider (Ikea, Rewe …)

​
Monthly Budget & Planned Vouchers

The monthly goodies budget is handled via a Planned Voucher with the interval monthly. It is only possible to have one or zero valid planned voucher for any given month. If you have a existing planned voucher:
Planned Voucher
{
    "validFrom": "2024-01-01",
    "validUntil": null
}
and you call the Set monthly budget Endpoint with the following:
Body
{
    "validFrom": "2024-02-01",
    "validUntil": "2024-12-31"
}
this would result in the following monthly planned vouchers:
Planned Vouchers
[
    {
    "validFrom": "2024-02-01",
    "validUntil": "2024-12-31"
    },
    {
    "validFrom": "2024-02-01",
    "validUntil": "2024-12-31"
    },
    {
    "validFrom": "2025-01-01",
    "validUntil": null
    }
]

​
Revoke all Planned vouchers

To revoke all planned vouchers, you can call the Revoke Planned Vouchers Endpoint.

​
Other planned vouchers

The API currently does not support the creation of any other planned vouchers than the monthly generic ones.