Employee Time Off

Create a Pending Time Off

Creates a pending Time Off record

Authentication

This endpoint accepts any one of the following token types:

Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Employee-scoped access token	Manage timeoffs (time_and_attendance)	-	Manage timeoffs (timeoff:write)
Company-scoped access token	Manage timeoffs (time_and_attendance)	-	Manage timeoffs (timeoff:write)

post/v1/employee/timeoff

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/employee/timeoff
Auth
- OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: timeoff:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/employment.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: timeoff:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write

Request body

end_datestring date required

UTC date in ISO 8601 format

leave_policy_variant_idstring required

notesstring

start_datestring date required

UTC date in ISO 8601 format

timezonestring required

TZ identifier

Example request

{
  "end_date": "2021-12-21",
  "leave_policy_variant_id": "paid_time_off",
  "start_date": "2021-12-20",
  "timeoff_days": [
    {
      "day": "2021-12-20",
      "hours": 8
    },
    {
      "day": "2021-12-21",
      "hours": 8
    }
  ],
  "timezone": "Asia/Kolkata"
}

Response

Created

Example response

{
  "data": {
    "timeoff": {
      "automatic": false,
      "document": {
        "id": "9880b711-file-id-ecf8f551bd78",
        "inserted_at": "2021-07-15T18:18:17Z",
        "name": "id.pdf",
        "sub_type": "personal_id",
        "type": "id"
      },
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "end_date": "2021-12-21",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "leave_policy": {
        "leave_policy_variant_slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "leave_type": "sick_leave",
        "name": "Self-Care"
      },
      "notes": "Some notes",
      "start_date": "2021-12-20",
      "status": "approved",
      "timeoff_days": [
        {
          "day": "2021-12-20",
          "hours": 8,
          "minutes": 480
        },
        {
          "day": "2021-12-21",
          "hours": 8,
          "minutes": 480
        }
      ],
      "timeoff_type": "paid_time_off",
      "timezone": "Asia/Kolkata",
      "total_minutes": 960
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.