Voucher Archive

This endpoint can be used to query the voucher archive for a specific month.

GET https://api.e-guma.ch/v1/voucher_archives/{year}-{month}.json?apikey={api-key}

Parameters

ParameterDescription
api-keyrequired - The API key required to authenticate the request.
yearrequired - The year for which the archive is being queried. It is in four digits.
monthrequired - The month for which the archive is being queried. It is in two digits.
complimentary

If e-guma is set to book complimentary vouchers at the time of issue, they will be included here. If they are not booked at the time of issue, they will not appear here. This behaviour can be overridden using this parameter. The following values are available:

included
excluded
only

Return

monthThe month and year of the returned archive.
total_balance_in_centsThe total balance of the vouchers is shown in cents. Depending on the e-guma settings or the optional complimentary parameter, complimentary vouchers may or may not be included.

Example

GET https://api.e-guma.ch/v1/voucher_archives/2026-02.json?apikey=510e32c594d84816a4af9df1
{
    "month": "2026-02",
    "total_balance_in_cents": 120000
}