API docs by Redocly

time.api (3.0)

Download OpenAPI specification:

Everest Public API

This is the public API for the Everest time management system.

Authentication

All endpoints require API key authentication via the X-Api-Key header.

Base URL

The API is available at the /public-api/v{version}/rest/ path.

Persons

Manage person base data

Update (V3)

Update an existing person partially. V3 uses replace-list semantics for time tracking and employment duration periods instead of the V1 dictionary-based semantics, which lets consumers synchronise their full set of periods in a single call without having to work around unique-start-date or overlap validation.

Authorizations:
secret
path Parameters
employeeNumber
required
string
Request Body schema:
required
id
string

Optional person id, i.e. the employee number.

titleId
integer <int32>

Optional title id. Valid values can be found under the /titles endpoint.

sex
integer
Enum: 0 1 2

Optional sex. Valid values can be found under the /genders endpoint.

language
integer <int32>

Optional user language. Valid values can be found under the /languages endpoint.

residencePermit
string

Optional residence permit.

ahvNumber
string

Optional AHV number (Swiss Social Security Number). Format: 756.XXXX.XXXX.XX, max 16 characters.

placeOfBirth
string

Optional place of birth, max 50 characters.

maritalStatus
string

Optional marital status (e.g. ledig, verheiratet, geschieden, verwitwet), max 20 characters.

frenchTaxNumber
string

Optional French tax identification number, max 25 characters.

grossRemunerationChf
number <decimal>

Optional gross remuneration in CHF for the certificate year.

nationalityId
integer <int32>

The nationality. Valid values can be found under the /countries endpoint.

object

Optional address.

object

Optional contact information.

remark
string

Optional remark.

firstName
string

Updates the firstname, if set.

lastName
string

Updates the lastname, if set.

dateOfBirth
string <date>

Updates the date of birth, if set. Triggers a re-calculation of the entitlements.

object (PatchPersonEmploymentPayloadV3)

Updates employment data, if set. Uses V3 replace-list semantics for time tracking and employment duration periods.

object (PatchEmployeeCostsPayload)

Updates costs data, if set.

object (PatchPresencePayload)

Updates presence data, if set.

object (PatchPlanningPayload)

Updates planning data, if set.

object (PatchPermissionsPayload)

Updates permissions data, if set.

object (PatchLoginPayload)

Updates login data, if set.

object

Updates timelook data, if set.

Responses

Request samples

Content type
{
  • "id": "string",
  • "titleId": 0,
  • "sex": 0,
  • "language": 0,
  • "residencePermit": "string",
  • "ahvNumber": "string",
  • "placeOfBirth": "string",
  • "maritalStatus": "string",
  • "frenchTaxNumber": "string",
  • "grossRemunerationChf": 0,
  • "nationalityId": 0,
  • "address": {
    },
  • "contact": {
    },
  • "remark": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "dateOfBirth": "2019-08-24",
  • "employment": {
    },
  • "costs": {
    },
  • "presence": {
    },
  • "planning": {
    },
  • "permissions": {
    },
  • "login": {
    },
  • "timelook": {
    }
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}