Skip to main content
PUT
/
api
/
v2
/
employees
/
{employeeId}
/
goodies
/
budget
cURL
curl --request PUT \
  --url https://api.become1.de/api/v2/employees/{employeeId}/goodies/budget \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budget": {
    "value": 123,
    "currency": "EUR_CENT"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z"
}
'
[
  {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "employeeId": "<string>",
    "amount": {},
    "goodiesVoucherType": "GENERIC",
    "interval": "ONCE",
    "nextDate": "2023-11-07T05:31:56Z",
    "startDate": "2023-11-07T05:31:56Z",
    "startDateYearMonth": "<string>",
    "dateDeleted": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "endDateYearMonth": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
employeeId
string
required

Body

application/json
​
budget
object
required

This budget restricts all budgets except for goodies and sports

​
startDate
string<date-time>
required

Make sure the date is UTC+0.

To have the planned monthly voucher created on 1st of January 2023, the input would be: 2023-01-01T00:00:00.000Z.

    

    This can be set up for any date present or in the future, not for a past date

    Example:

    Current Date 7th of March -> earliest startDate = 7th of March

    Current Date 8th of March -> earliest startDate = 8th of March
​
endDate
string<date-time>

Make sure the date is UTC+0.

To have the monthly voucher expire on the end of January 2023, the input would be: 2023-01-31T23:59:99.999Z\n
    

    This can be set up for any date in the future, not for a past or present date

    Example:

    Current Date 7th of March -> earliest endDate = 2023-03-08T23:59:99.999Z

    Current Date 8th of March -> earliest endDate = 2023-03-09T23:59:99.999Z

Response

200 - application/json
​
id
string
required

The unique primary key (UUID) of the entity.

​
dateCreated
string<date-time>
required
​
dateModified
string<date-time>
required
​
employeeId
string
required
​
amount
object
required
​
goodiesVoucherType
enum<string>
required
Available options:
GENERIC,
SPECIAL
​
interval
enum<string>
required
Available options:
ONCE,
DAILY,
WEEKLY,
MONTHLY,
YEARLY
​
nextDate
string<date-time> | null
required
​
startDate
string<date-time>
required
​
startDateYearMonth
string
required

yyyy-MM

​
dateDeleted
string<date-time> | null
​
endDate
string<date-time> | null
​
endDateYearMonth
string | null

yyyy-MM