Skip to main content
PUT
/
api
/
v2
/
employees
/
{employeeId}
/
flex
/
access
cURL
curl --request PUT \
  --url https://api.become1.de/api/v2/employees/{employeeId}/flex/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budget": {
    "value": 123,
    "currency": "EUR_CENT"
  },
  "accumulateBudget": true,
  "startDate": "2023-11-07T05:31:56Z",
  "allowedModules": [
    "MEALS"
  ],
  "flexTaxRuleTemplateId": "default",
  "endDate": "2023-11-07T05:31:56Z"
}
'
[
  {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "employeeId": "<string>",
    "budget": {},
    "allowedModules": [
      "MEALS"
    ],
    "accumulateBudget": false,
    "validFrom": "2023-11-07T05:31:56Z",
    "validFromYearMonth": "<string>",
    "dateDeleted": "2023-11-07T05:31:56Z",
    "flexTaxRuleTemplateId": "default",
    "validUntil": "2023-11-07T05:31:56Z",
    "validUntilYearMonth": "<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

The flex budget will be the maximum amount that can be spent per month by the employee.

​
accumulateBudget
boolean
required
If set, budget that has not been spent will be accumulated until the end of the year.

        If there is an entry where this value is false, this will break the accumulation.

        Example: 


        Jan - Mar -> accumulation = true, 50€ budget: if the user did not spent any budget, he would have 150 € budget in march.
        Apr - May -> accumulation = false, 50€ budget: the 150 € accumulated budget will not be available in April. The user has 50€ for april and 50€ for may
        June - Dec -> accumulation = true, 50€ budget: if the user did not spent any budget, he would have 350 € budget in december.
​
startDate
string<date-time>
required

Make sure the date is UTC+0.

To have the access applied on 1st of January 2023, the input would be: 2023-01-01T00:00:00.000Z.

    

    This can be set up for any date going back in time up to the past month until the 3rd of the current month.

    Example:

    Current Date 7th of March -> earliest validFrom = 1st of February

    Current Date 8th of March -> earlierst validFrom = 1st of March 

    

    The 7th of march is a reference date that can vary depending on the date of payroll creation.
​
allowedModules
enum<string>[] | null
Available options:
MEALS,
HEALTH,
INTERNET,
HOLIDAY,
KITA,
MOBILITY,
SPORTS
​
flexTaxRuleTemplateId
string | null
default:default
​
endDate
string<date-time>

Make sure the date is UTC+0.

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

    This can be set up for any date going back in time up to the past 2 months until the 7th of the current month.

    Example:

    Current Date 7th of March -> earliest validUntil = 2023-01-31T23:59:59.999Z

    Current Date 8th of March -> earlierst validUntil = 2023-02-29T23:59:59.999Z 

    

    The 7th of march is a reference date that can vary depending on the date of payroll creation.

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
​
budget
object
required
​
allowedModules
enum<string>[]
required
Available options:
MEALS,
HEALTH,
INTERNET,
HOLIDAY,
KITA,
MOBILITY,
SPORTS
​
accumulateBudget
boolean
default:false
required
​
validFrom
string<date-time>
required
​
validFromYearMonth
string
required

yyyy-MM

​
dateDeleted
string<date-time> | null
​
flexTaxRuleTemplateId
string | null
default:default
​
validUntil
string<date-time> | null
​
validUntilYearMonth
string | null

yyyy-MM