Time off balances

GET /2023-03-01/xhr/time-off-balances

Retrieve all time off balances.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- employee_id string Required
  
  The Affix-assigned id of the individual
- employee_remote_id string Required
  
  the remote system-assigned id of the individual
- balance number | null Required
- used number | null Required
- policy_id string | null Required
  
  The Affix-assigned id of the policy
- policy_remote_id string | null Required
  
  The remote system-assigned id of the policy
- policy_name string | null Required
  
  The name of the policy, as assigned by the remote system
- policy_type string | null Required
  
  Values are null, bereavement, holiday, jury_duty, personal, sick, vacation, or volunteer.
- remote_created_at string(date) | null Required
- remote_modified_at string(date) | null Required
202 application/json

Accepted + pending (async job started)
Hide headers attribute Show headers attribute
- Retry-After integer
  
  Retry your call after the specified amount of seconds
Hide response attribute Show response attribute object
- message string Required
401 application/json

Authentication Error
Hide response attributes Show response attributes object
- error string Required
  
  The type of error
  
  Value is authentication_error.
- message string Required
  
  A descriptive description of the error
- code string Required
  
  Values are incorrect_username_or_password, incorrect_mfa_or_otp, reauthentication_required // cookies are now expired, additional_account_setup_required // password reset, etc, captcha_challenge // amazon type1 captcha challenge (currently unsovable), no_valid_accounts // not used currently but reserved for future use, or insufficient_permission // not enough privileges (ie not an admin, or not enough provider scopes on a provider api token for the Affix scopes requested).
429 application/json

Rate Limited / Too Many Requests
Hide headers attribute Show headers attribute
- Retry-After integer
  
  Retry your call after the specified amount of seconds
Hide response attribute Show response attribute object
- message string Required
500 application/json

Server Error
Hide response attribute Show response attribute object
- message string Required
501 application/json

Not Implemented
Hide response attribute Show response attribute object
- message string Required

GET /2023-03-01/xhr/time-off-balances

curl \
 -X GET https://api.affixapi.com/2023-03-01/xhr/time-off-balances \
 -H "Authorization: $API_KEY"

Response examples (200)

[
  {
    "employee_id": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    "employee_remote_id": "19202938",
    "balance": 24.5,
    "used": 12,
    "policy_id": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    "policy_remote_id": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    "policy_name": "Comp/In Lieu Time",
    "policy_type": "vacation",
    "remote_created_at": "2020-10-11",
    "remote_modified_at": "2020-10-11"
  }
]

Response examples (202)

# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}

Response examples (401)

{
  "error": "authentication_error",
  "message": "Your password is incorrect",
  "code": "incorrect_username_or_password"
}

Response examples (429)

# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}

Response examples (500)

{
  "message": "string"
}

Response examples (501)

{
  "message": "string"
}