BIbindbee
Time Off Balance

Get Time Off Balance By Id

Changed on

Returns a TimeOffBalance object with the given id.

get/api/hris/v1/time-off-balances/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employeestring nullable required

The employee the balance belongs to.

policy_typestring nullable required

The policy type of this time off balance. If the value is not one of the defined enum values, the original value passed through will be returned.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "employee": "018b48d5-79f8-7deb-8813-3e47b375067e",
  "policy_type": "VACATION"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the ANNUAL_LEAVE enum value from the response property for the response status

    • info

      removed the BEREAVEMENT enum value from the response property for the response status

    • info

      removed the COMPASSIONATE enum value from the response property for the response status

    • info

      removed the COMP_OFF enum value from the response property for the response status

    • info

      removed the EMERGENCY_LEAVE enum value from the response property for the response status

    • info

      removed the FMLA enum value from the response property for the response status

    • info

      removed the JURY_DUTY enum value from the response property for the response status

    • info

      removed the LEAVE_OF_ABSENCE enum value from the response property for the response status

    • info

      removed the LONG_TERM_DISABILITY enum value from the response property for the response status

    • info

      removed the MATERNITY enum value from the response property for the response status

    • info

      removed the PAID_TIME_OFF enum value from the response property for the response status

    • info

      removed the PATERNITY enum value from the response property for the response status

    • info

      removed the PERSONAL enum value from the response property for the response status

    • info

      removed the SHORT_TERM_DISABILITY enum value from the response property for the response status

    • info

      removed the SICK enum value from the response property for the response status

    • info

      removed the TIME_OFF enum value from the response property for the response status

    • info

      removed the VACATION enum value from the response property for the response status

    • info

      removed the VOLUNTEER enum value from the response property for the response status

    • info

      removed the WORK_FROM_HOME enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API