Introduction

API endpoint

https://<tenant>.staff.cloud/api/v1/

The Staffcloud API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). By default JSON is returned by all API responses, including errors.

All API URLs listed in this documentation are relative to the API endpoint. For example, the GET /employees/1 API call is reachable at https://<tenant>.staff.cloud/api/v1/employees/1. Parameters should be sent in URL escaped format. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Libraries

Official libraries for the Staffcloud API will be available in several languages. Until they are released, a regular, language specific REST client may be used.

Versioning

Versioning helps us iterate faster and prevents invalid requests from hitting updated endpoints. It also helps smooth over any major API version transitions as we can continue to offer old API versions for a period of time. We are keeping the version in the URL to ensure browser explorability of the resources across versions.

Resources

The key principles of REST involve separating an API into logical resources. So what do we call resources? They are nouns that make sense from the perspective of the API consumer. For example, our API provides resources such as employees, events, projects, contacts and others.

Fields

A resource has many fields. Since it is easier to read, all field names (as well as the resource names) are written in snake_case. Every field has exactly one data type according to the JSON Schema definition.

Dynamic fields

A core concept of Staffcloud are the fully configurable entities. It is possible to manage most of the fields of most of the entities, i.e. it's possible that an employee of tenant X contains entirely different fields than an employee of tenant Y.

However, some of the dynamic fields are preexisting and linked to a given functionality. They can't be deleted. Since these fields and their intended behavior may also be relevant for an API consumer, they are given human readable names and they are listed in the particular resource documentations.

All other (user generated) dynamic fields are given a generic name like dynamic_field_50 where 50 refers to the ID of the related attribute. They are not included in the API documentation. To retrieve a list of all dynamic fields for a resource, you may either use the forms resource or perform a simple GET request to the desired resource.

Authentication

Example request

$ curl https://<tenant>.staff.cloud/api/v1/ \
    -H "Authorization: Bearer <ACCESS_TOKEN>"

Our RESTful API is stateless, meaning that the authentication request does not depend on cookies or sessions.

For authentication we are using JSON Web Tokens. Each request must provide an Authorization header containing a Bearer token.

Since the API also supports JSONP and a JSONP request can't contain custom headers, a special query parameter authorization_bearer is supported as well.

Generating tokens

A tenant can have multiple API users.

API users and tokens are managed in the Office.

Privileges

There is no granular privilege control for API users except a ready-only state which is preventing a user from calling POST, PUT and DELETE actions.

Apart from that, an API user has access to all resources of its tenant, considering the available modules, addons, etc.

Actions

RESTful principles provide strategies to handle CRUD actions using HTTP methods mapped as follows:

GET /employees - Retrieves a list of employees
GET /employees/12 - Retrieves a specific employee
POST /employees - Creates a new employee
PUT /employees/12 - Updates employee #12
DELETE /employees/12 - Deletes employee #12

In case of a POST that resulted in a creation, a Location header that points to the URL of the new resource will be included in the response.

Our API does not support the PATCH HTTP verb, but only PUT which may accept only partial updates.

Overriding the HTTP method

Some HTTP clients can only work with simple GET and POST requests. To increase accessibility to these limited clients, the API supports a request header X-HTTP-Method-Override with a string value containing one of PUT or DELETE.

Note that the override header is only accepted on POST requests. GET requests must never change data!

Special actions

If an action doesn't fit in the CRUD operations set, so called special actions will be available for the particular resources. These special actions will be documented separately in the resource documentation sections.

Relations

Example request

$ curl https://<tenant>.staff.cloud/api/v1/projects/12 \
    -H "Authorization: Bearer <ACCESS_TOKEN>"

Example response

{
    "id" : 12,
    "name" : "My project",
    "date" : "2015-01-01",
    "client" : {
        "id" : 330,
        "name" : "Sample Inc.",
        "location" : "Anywhere"
    },
    "events" : [
        {
            "id" : 445,
            "name" : "My event"
        },
        {
            "id" : 446,
            "name" : "Another event"
        }
    ],
    "locations" : [
        {
            "id" : 33,
            "name" : "A location"
        },
        {
            "id" : 42,
            "name" : "Another location"
        }
    ]
}

Example request

$ curl https://<tenant>.staff.cloud/api/v1/projects/12?embed=client.id,client.name,events \
       -H "Authorization: Bearer <ACCESS_TOKEN>"

Example response

{
    "id" : 12,
    "name" : "My project",
    "date" : "2015-01-01",
    "client" : {
        "id" : 330,
        "name" : "Sample Inc."
    },
    "events" : [
        {
            "id"  : 445,
            "name" : "My event"
        },
        {
            "id" : 446,
            "name" : "Another event"
        }
    ]
}

For resources that are related to other resources or only exist as children of such, RESTful principles provide useful guidance. An example of this would be as the following:

A form in Staffcloud contains a number of attributes. These attributes can be logically mapped to the /forms endpoint as follows:

GET /forms/12/attributes - Retrieves list of attributes for form #12
GET /forms/12/attributes/5 - Retrieves attribute #5 for form #12
POST /forms/12/attributes - Creates a new attribute in form #12
PUT /forms/12/attributes/5 - Updates attribute #5 for form #12
DELETE /forms/12/attributes/5 - Deletes attribute #5 for form #12

For providing information about relations and providing access to them, we will include identifiers (foreign keys) in the result sets. The API consumer will then have to hit the child relation's endpoint.

However, if the relation is commonly requested alongside the resource, the API is offering the functionality to automatically embed the relation's representation and avoid the second hit to the API. In this case, embed is a query parameter having a comma separated list of fields to be embedded. Dot-notation may be used to refer to sub-fields. Note that the dot notation is optional. If a sub-resource is requested without specifying fields, the full relation resource will be returned.

Filtering, searching and sorting

Complex result filters, sorting and advanced searching (when restricted to a single type of resource) can all be easily achieved by using query parameters on top of the base URL. Let's look at these in more detail:

Filtering

Use an unique query parameter for each field that implements filtering. For example, when requesting a list of employees from the /employees endpoint, you may want to limit these to only those having state active. This could be accomplished with a request like GET /employees?state=1. Here, state is a query parameter that implements a filter.

The filters supports expressions and operators like this:

Name	Expression	Example
Like (case insensitive)	=~	?name=~john
Equals (case sensitive)	=	?name=john
Not equals	=-	?name=-john
Less than	=<	?age=<5
Greater than	=>	?age=>5
Contains	=...	?name=doe
Not contains	=-...	?name=-doe
Starts with	=*...	?name=*john
Ends with	=...*	?name=doe*
null	=null	?name=null
not null	=-null	?name=-null
empty string	=	?name=
not empty string	=-	?name=-
And	Use multiple filters	?count[]=>2&count[]=<5
Or	=...,...	?name=john,george ?count=2,<2,>5

All of these expressions and operators may be combined as far as possible. Reserved characters for expressions must be escaped with a backslash if not contemplated as such.

Limiting returned fields

The API consumer doesn't always need the full representation of a resource.

The fields query parameter accepts a comma separated list of fields to include. A request like this will limit the fields returned for employees:

GET /employees?fields=id,firstname,lastname,age

Sorting

Similar to filtering, a generic parameter sort is used to describe sorting rules.

It accepts a list of comma separated fields, each with a possible negative prefix to imply descending sort order. By default, if no prefix is specified, the field will be used to sort results in ascending order. Let's look at some examples:

GET /employees?sort=+age - Retrieves a list of employees in ascending order of age.
GET /employees?sort=-age,name - Retrieves a list of employees in descending order of age. Within a specific age, employees are ordered ascending by name

Aliases for common queries

To make the API experience more pleasant for basic consumers, there are sets of conditions (templates) packed into easily accessible RESTful paths.

For example, the query GET /events?fields=name,start_time,end_time&state=1&date=2001-01-01&sort=name,-start_time could be packaged up as GET /events/today.

Similar to special actions, all aliases will be documented separately in the resource documentation sections.

Response format

Though JSON is the de-facto standard for RESTful API's today, our API supports multiple return formats.

To ensure browser explorability, the format can be passed in the URL. Therefore you may just append the format as a file extension to the endpoint URL:

GET /employees/12.json - Retrieves employee #12 in JSON format.
GET /forms/12/attributes.xml?sort=name - Retrieves a list of attributes for form #12 sorted by name in XML format.

For the moment only JSON and XML are supported, while JSON is used as the default format. A content type header in compliance with RFC 6838 is sent according to the response format.

JSON specific features

JSON return values are always pretty printed.

Envelopes

JSONP envelope

callback_function({
    status_code: 200,
    additional_header: "...",
    response: {
        ... actual JSON response body ...
    }
})

By default, a JSON API response is not wrapped in an envelope.

If you need to use cross domain requests over JSONP you may use the additional query parameter callback containing the name of the desired callback function. Now the API will switch to a full envelope mode where it always responds with a 200 HTTP status code and passes the real status code in the JSON payload. Any additional HTTP headers that would have been passed alongside the response will be mapped to JSON fields.

Similarly, to support limited HTTP clients, a special query parameter envelope=true that will trigger full enveloping is supported.

Compression

All responses are compressed using GZIP, a corresponding Content-Encoding header is always included in the response.

Encoding / formats

All returned data is UTF-8 encoded. Dates, times and other formatable types are returned in consistent, common formats.

Input format

In contrast to the responses, the API only accepts JSON as format for input values used for POST and PUT actions.

An Accept-Encoding header is sent with every response to inform the client about the accepted format. If the API receives malformed data, a 415 error code will be sent.

File uploads

Example file upload POST request. Please note that the Content-Type and X-File-Name and X-File-Visibility headers are optional. The X-File-Visibility header is used to (optionally) set the visibility of the file. Possible values are 'private' and 'public'. Default is 'private'

curl -X POST https://<tenant>.staff.cloud/api/v1/files \
    -H "Authorization: Bearer <ACCESS_TOKEN>" \
    -H "Content-Type: image/jpeg" \
    -H "X-File-Name: filename.jpg" \
    -H "X-File-Visibility: private" \
    -d "@/path/to/filename.jpg"

Example response

{
  "id": 8,
  "path": "9f1d1d056e86af3b542453521ea7691",
  "name": "text_58ac754s1cb2234.80345007.plain-charset-UTF-8",
  "mime": "text/plain;charset=UTF-8",
  "status": 0,
  "user_id": 54
}

File uploads are a bit harder to implement in a pure REST manner so the file upload action is documented here although it is part of the files resource.

A file upload request looks like this: POST /files and the body of the request should contain the file content (binary data)

The platform will autodetect the file type and also generate a sensible and unique name for the folder/file.

Should you however want to specify the filename or the mime type for the file you can optionally do this by specifying the following headers:

X-File-Name - to specify a file name for the uploaded file
Content-Type - to specify a mime type for the uploaded file

The response will be the stored file resource. You can see an example on the right.

Rate limiting

To prevent abuse, we are rate limiting our API. RFC 6585 introduced a HTTP status code 429 Too Many Requests to accommodate this. In order to notify the API consumer about the current limits, the following headers will be sent:

X-Rate-Limit-Limit - The number of allowed requests in the current period.
X-Rate-Limit-Remaining - The number of remaining requests in the current period.
X-Rate-Limit-Reset - The number of seconds left in the current period.

Caching

The API is using an caching mechanism called ETag. The response will contain an ETag header which contains a hash of the representation sent. The value of the header will change whenever the output representation changes.

If an inbound HTTP request contains a If-None-Match header with an matching ETag value, the API will return a 304 Not Modified status code instead of the output representation of the resource.

HTTP status codes

Status Code	Description
200 OK	Response to a successful GET, PUT or DELETE. Can also be returned for a POST that doesn't result in a creation.
201 Created	Response to a POST that results in a creation. It is combined with a Location header pointing to the location of the new resource.
204 No Content	Response to a successful request that won't be returning a body (like a DELETE request).
304 Not Modified	Used when HTTP caching headers are used.
400 Bad Request	The request is malformed, such as if the body does not parse.
401 Unauthorized	When no or invalid authentication details are provided.
403 Forbidden	When authentication succeeded but authenticated user doesn't have access to the resource.
404 Not Found	When a non-existent resource is requested.
405 Method Not Allowed	When an HTTP method is being requested that isn't allowed for the authenticated user.
410 Gone	Indicates that the resource at this end point is no longer available.
415 Unsupported Media Type	If incorrect content type was provided as part of the request.
422 Unprocessable Entity	Used for validation errors.
429 Too Many Requests	When a request is rejected due to rate limiting.
500 Internal Server Error	Something unexpected happened.
503 Service Unavailable	The API is not available at the moment.

Errors

Example error response

{
    "code" : "field_deleted",
    "message" : "Field not available",
    "description" : "The requested field has been deleted."
}

Example validation error response for PUT and POST requests

{
    "code" : "validation_failed",
    "message" : "Validation Failed",
    "errors" : [
        {
            "code" : "invalid_character",
            "field" : "first_name",
            "message" : "First name must not contain have special characters"
        },
        {
            "code" : "not_empty",
            "field" : "password",
            "message" : "Password cannot be blank"
        }
    ]
}

In case of errors, the API provides useful responses which explain the errors thrown.

Resources

Assignment contract

Schema

Assignment-contract schema

{
    "properties": {
        "assignment_id": {
            "label": "Assignment Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "document_template_id": {
            "label": "Document Template Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "type": {
            "label": "Document Type",
            "editable": false,
            "type": "string",
            "format": "int"
        },
        "file": {
            "label": "Document file",
            "editable": false,
            "type": "string"
        },
        "data": {
            "label": "Document data",
            "editable": false,
            "type": "array"
        },
        "created_at": {
            "label": "Created at Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "created_at_date": {
            "label": "Created at Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created at Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        }
    }
}

Fields

Name	Properties	Type	Description
assignment_id	`Read Only`	foreignKey (int)	Assignment Id
document_template_id	`Read Only`	foreignKey (int)	Document Template Id
planner_id	`Read Only`	foreignKey (int)	Planner Id
type	`Read Only`	string (int)	Document Type
file	`Read Only`	string	Document file
data	`Read Only`	array	Document data
created_at	`Read Only`	string (date-time)	Created at Date-Time
created_at_date	`Read Only`	string (date)	Created at Date-Time Date
created_at_time	`Read Only`	string (time)	Created at Date-Time Time

Relations

Name	Resource	Foreign Key	Description
contractAssignment	assignments	assignment-contract.assignment_id

Actions

Request	Description
`GET /assignment-contract`	Resource listing
`GET /assignment-contract/<id>`	Resource read
`POST /assignment-contract`	Resource create
`PUT /assignment-contract/<id>`	Resource update
`DELETE /assignment-contract/<id>`	Resource delete
`GET /assignment-contract/<id>/file`	Note: this action is deprecated. Get the contract file of an assignment.

Assignment employment reports

Schema

Assignment-employment-reports schema

{
    "properties": {
        "assignment_id": {
            "label": "Assignment Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "type": {
            "label": "Report Type",
            "editable": false,
            "type": "int",
            "format": "int"
        },
        "data": {
            "label": "Document data",
            "editable": false,
            "type": "array"
        },
        "created_at": {
            "label": "Created at Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated at Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "created_at_date": {
            "label": "Created at Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created at Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated at Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated at Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
assignment_id	`Read Only`	foreignKey (int)	Assignment Id
planner_id	`Read Only`	foreignKey (int)	Planner Id
type	`Read Only`	int (int)	Report Type
data	`Read Only`	array	Document data
created_at	`Read Only`	string (date-time)	Created at Date-Time
updated_at	`Read Only`	string (date-time)	Updated at Date-Time
created_at_date	`Read Only`	string (date)	Created at Date-Time Date
created_at_time	`Read Only`	string (time)	Created at Date-Time Time
updated_at_date	`Read Only`	string (date)	Updated at Date-Time Date
updated_at_time	`Read Only`	string (time)	Updated at Date-Time Time

Relations

Name	Resource	Foreign Key	Description
reportAssignment	assignments	assignment-employment-reports.assignment_id

Actions

Request	Description
`GET /assignment-employment-reports`	Resource listing
`GET /assignment-employment-reports/<id>`	Resource read
`POST /assignment-employment-reports`	Resource create
`PUT /assignment-employment-reports/<id>`	Resource update
`DELETE /assignment-employment-reports/<id>`	Resource delete

Assignment wages

Schema

Assignment-wages schema

{
    "properties": {
        "assignment_id": {
            "label": "Assignment ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "wage_profile_id": {
            "label": "Profile Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "type": {
            "label": "Payment Type",
            "editable": false,
            "type": "string",
            "format": "int"
        },
        "payable_amount": {
            "label": "Payable Amount",
            "editable": false,
            "type": "float"
        },
        "base_value": {
            "label": "Base Value",
            "editable": false,
            "type": "float"
        },
        "factor": {
            "label": "Factor",
            "editable": false,
            "type": "float",
            "format": "int"
        },
        "is_disabled": {
            "label": "Disabled",
            "editable": false,
            "type": "integer",
            "format": "bool"
        },
        "is_valid": {
            "label": "Valid",
            "editable": false,
            "type": "integer",
            "format": "bool"
        },
        "wage_type": {
            "label": "Wage Type",
            "editable": false,
            "type": "object",
            "flatten": true
        },
        "wage_type_value": {
            "label": "Wage Type Value",
            "editable": false,
            "type": "object",
            "flatten": true
        },
        "wage_type.name": {
            "label": "Wage Type Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "wage_type.external_id": {
            "label": "Wage Type External ID",
            "editable": false,
            "type": "string"
        },
        "wage_type.external_cost": {
            "label": "Wage Type External cost",
            "editable": false,
            "format": "string"
        },
        "wage_type.currency_format": {
            "label": "Wage Type Currency Format",
            "editable": false,
            "type": "string"
        },
        "wage_type_value.unit": {
            "label": "Wage Type Unit",
            "format": "string",
            "editable": false,
            "type": "string"
        }
    }
}

Fields

Name	Properties	Type	Description
assignment_id	`Read Only`	foreignKey (int)	Assignment ID
wage_profile_id	`Read Only`	foreignKey (int)	Profile Id
type	`Read Only`	string (int)	Payment Type
payable_amount	`Read Only`	float	Payable Amount
base_value	`Read Only`	float	Base Value
factor	`Read Only`	float (int)	Factor
is_disabled	`Read Only`	integer (bool)	Disabled
is_valid	`Read Only`	integer (bool)	Valid
wage_type	`Read Only`	object	Wage Type
wage_type_value	`Read Only`	object	Wage Type Value
wage_type.name	`Read Only`	string (string)	Wage Type Name
wage_type.external_id	`Read Only`	string	Wage Type External ID
wage_type.external_cost	`Read Only`	(string)	Wage Type External cost
wage_type.currency_format	`Read Only`	string	Wage Type Currency Format
wage_type_value.unit	`Read Only`	string (string)	Wage Type Unit

Relations

Name	Resource	Foreign Key	Description
wageAssignment	assignments	assignment-wages.assignment_id
wageProfile	wage-profiles	assignment-wages.wage_profile_id

Actions

Request	Description
`GET /assignment-wages`	Resource listing
`GET /assignment-wages/<id>`	Resource read
`POST /assignment-wages`	Resource create
`PUT /assignment-wages/<id>`	Resource update
`DELETE /assignment-wages/<id>`	Resource delete

Assignments

Describes event assignments. An event function that has been assigned to an employee.

Schema

Assignments schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "event_function_id": {
            "label": "Event Function Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "event_id": {
            "label": "Event Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "project_id": {
            "label": "Project Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "client_id": {
            "label": "Client Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "contact_id": {
            "label": "Contact Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "location_id": {
            "label": "Location Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "wage_profile_id": {
            "label": "Assignment Wage Profile Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "event_function.id": {
            "label": "Event Function ID",
            "editable": false,
            "description": "ID of the event function",
            "type": "int"
        },
        "event_function.function_id": {
            "label": "Function ID",
            "editable": false,
            "description": "ID of the event function",
            "type": "int"
        },
        "event_function.description": {
            "label": "Event Function Description",
            "editable": false,
            "description": "Short description of the event function referenced by the assignment.",
            "type": "string"
        },
        "event_function.location.name": {
            "label": "Event Function Location",
            "editable": false,
            "description": "The assignments event function location name.",
            "type": "string"
        },
        "event_function.start": {
            "label": "Event Function Start Date-Time",
            "editable": false,
            "description": "The assignments event function start time.",
            "type": "string",
            "format": "date-time"
        },
        "event_function.end": {
            "label": "Event Function End Date-Time",
            "editable": false,
            "description": "The assignments event function end time.",
            "type": "string",
            "format": "date-time"
        },
        "event_function.is_locked": {
            "label": "Event Function is locked",
            "editable": false,
            "description": "The assignments event function is locked.",
            "type": "int",
            "format": "bool"
        },
        "event_function.wage_profile_id": {
            "label": "Event Function Wage Profile Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "event_function.function": {
            "label": "Event Function Name",
            "editable": false,
            "description": "Name of the event function",
            "type": "string"
        },
        "event_function.function.project_leader": {
            "label": "Event Function Team Leader At The Event Level",
            "editable": false,
            "description": "Flag that decides whether the assignments event function has team leader role at the event level or not.",
            "type": "int",
            "format": "bool"
        },
        "event.name": {
            "label": "Event Name",
            "editable": false,
            "description": "The name of the event that the assignment belongs to.",
            "type": "string"
        },
        "event.start": {
            "label": "Event Start Date-Time",
            "editable": false,
            "description": "The start time of the event that the assignment belongs to.",
            "type": "string",
            "format": "date-time"
        },
        "event.end": {
            "label": "Event End Date-Time",
            "editable": false,
            "description": "The end time of the event that the assignment belongs to.",
            "type": "string",
            "format": "date-time"
        },
        "event.auto_assign_enabled": {
            "label": "Event Auto Assign Enabled",
            "editable": false,
            "description": "The flag that states whether the auto assign is enabled on the event or not.",
            "type": "int",
            "format": "bool"
        },
        "event.location.name": {
            "label": "Event Location Name",
            "editable": false,
            "description": "The assignments event location name",
            "type": "string"
        },
        "event.client.name": {
            "label": "Event client name",
            "editable": false,
            "description": "Name of the event client.",
            "type": "string"
        },
        "event.contact.first_name": {
            "label": "Client contact first name",
            "editable": false,
            "description": "First name of the assignment client contact.",
            "type": "string"
        },
        "event.contact.last_name": {
            "label": "Client contact last name",
            "editable": false,
            "description": "Last name of the assignment client contact.",
            "type": "string"
        },
        "event.planner.first_name": {
            "label": "Planner first name",
            "editable": false,
            "description": "First name of the assignment planner.",
            "type": "string"
        },
        "event.planner.last_name": {
            "label": "Planner last name",
            "editable": false,
            "description": "Last name of the assignment planner.",
            "type": "string"
        },
        "event.project.name": {
            "label": "Project Name",
            "editable": false,
            "description": "Name of the assignment project.",
            "type": "string"
        },
        "event.tags": {
            "label": "Event tags",
            "editable": false,
            "description": "Tags of the assignment event.",
            "type": "array"
        },
        "project.event.client.id": {
            "label": "Project client ID",
            "editable": false,
            "description": "ID of the project client.",
            "type": "string"
        },
        "project.event.client.name": {
            "label": "Project client name",
            "editable": false,
            "description": "Name of the project client.",
            "type": "string"
        },
        "project.event.contact.id": {
            "label": "Project client contact ID",
            "editable": false,
            "description": "ID of the project client contact.",
            "type": "string"
        },
        "project.event.contact.first_name": {
            "label": "Project client contact first name",
            "editable": false,
            "description": "First name of the project client contact.",
            "type": "string"
        },
        "project.event.contact.last_name": {
            "label": "Project client contact last name",
            "editable": false,
            "description": "Last name of the project client contact.",
            "type": "string"
        },
        "status": {
            "label": "Status",
            "editable": true,
            "description": "The status of the assignment.",
            "type": "integer",
            "enum": {
                "invited": 1,
                "invited_ignored": 2,
                "applied": 3,
                "applied_maybe": 4,
                "denied": 8,
                "assigned": 6,
                "assigned_provisional": 5,
                "confirmed": 7
            },
            "format": "int",
            "valueMapping": {
                "1": "Invited",
                "2": "Ignored",
                "3": "Applied",
                "4": "Applied (maybe)",
                "5": "Assigned (provisional)",
                "6": "Assigned",
                "7": "Confirmed",
                "8": "Denied"
            }
        },
        "remarks": {
            "label": "Remarks",
            "editable": true,
            "description": "Remarks on the assignment.",
            "type": "string"
        },
        "notes": {
            "label": "Notes",
            "editable": false,
            "description": "Notes on the assignment.",
            "type": "string"
        },
        "start": {
            "label": "Start Date-Time",
            "editable": false,
            "description": "The start time of the assignment.",
            "type": "string",
            "format": "date-time"
        },
        "end": {
            "label": "End Date-Time",
            "editable": false,
            "description": "The end time of the assignment",
            "type": "string",
            "format": "date-time"
        },
        "break_start": {
            "label": "Break Start Date-Time",
            "editable": false,
            "description": "The start time of the assignment break.",
            "type": "string",
            "format": "date-time"
        },
        "break_end": {
            "label": "Break End Date-Time",
            "editable": false,
            "description": "The end time of the assignment break",
            "type": "string",
            "format": "date-time"
        },
        "planned_work_time": {
            "label": "Planned Work Time including breaks",
            "editable": false,
            "description": "The assignments planned work time including breaks.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "planned_work_time_without_break": {
            "label": "Planned Work Time excluding breaks",
            "editable": false,
            "description": "The assignments planned work time excluding breaks.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "planned_break_time": {
            "label": "Planned Break Time",
            "editable": false,
            "description": "The assignments planned break time.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "is_approved": {
            "label": "Approved",
            "editable": false,
            "description": "Is assignment data approved by planner",
            "type": "int",
            "format": "bool"
        },
        "pay_amount": {
            "label": "Approved pay amount",
            "editable": false,
            "description": "Wage amount that has been approved for payment",
            "type": "float",
            "format": "currency",
            "minimum": 0
        },
        "approved_on": {
            "label": "Payment Approval Date-Time",
            "editable": false,
            "description": "Date and time when the payment was approved",
            "type": "string",
            "format": "date-time"
        },
        "approved_by_planner_id": {
            "label": "Id of the planner that approved the payment",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "paid_on": {
            "label": "Payment Date-Time",
            "editable": false,
            "description": "Date and time when the payment was made",
            "type": "string",
            "format": "date-time"
        },
        "assigned_by_availability": {
            "label": "Assigned by availability",
            "editable": false,
            "description": "Whether the employee was assigned by its availability or not",
            "type": "int",
            "format": "bool"
        },
        "auto_assigned": {
            "label": "Auto assigned",
            "editable": false,
            "description": "Whether the employee was assigned automatically by the system or not",
            "type": "int",
            "format": "bool"
        },
        "team_leader_level": {
            "label": "Team Leader Level",
            "editable": false,
            "description": "Team leader level at the event level or project level",
            "type": "int",
            "format": "int"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "description": "The date the assignment was created.",
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "description": "The date the assignment was updated.",
            "type": "string",
            "format": "date-time"
        },
        "open_actions": {
            "label": "Open Actions",
            "editable": false,
            "description": "Contains information about all open actions that can be performed on an assignment",
            "type": "object"
        },
        "configurations": {
            "label": "Configurations",
            "editable": false,
            "description": "Contains information about assignment specific configuration",
            "type": "object"
        },
        "location": {
            "label": "Assignment Location",
            "editable": false,
            "description": "Assignment location address.",
            "type": "string"
        },
        "statistics": {
            "label": "Statistics",
            "editable": true,
            "description": "Contains some filled positions statistics regarding the assigment",
            "type": "string"
        },
        "event_function.start_date": {
            "label": "Event Function Start Date-Time Date",
            "editable": false,
            "description": "The assignments event function start time.",
            "type": "string",
            "format": "date",
            "source": "event_function.start"
        },
        "event_function.start_time": {
            "label": "Event Function Start Date-Time Time",
            "editable": false,
            "description": "The assignments event function start time.",
            "type": "string",
            "format": "time",
            "source": "event_function.start"
        },
        "event_function.end_date": {
            "label": "Event Function End Date-Time Date",
            "editable": false,
            "description": "The assignments event function end time.",
            "type": "string",
            "format": "date",
            "source": "event_function.end"
        },
        "event_function.end_time": {
            "label": "Event Function End Date-Time Time",
            "editable": false,
            "description": "The assignments event function end time.",
            "type": "string",
            "format": "time",
            "source": "event_function.end"
        },
        "event.start_date": {
            "label": "Event Start Date-Time Date",
            "editable": false,
            "description": "The start time of the event that the assignment belongs to.",
            "type": "string",
            "format": "date",
            "source": "event.start"
        },
        "event.start_time": {
            "label": "Event Start Date-Time Time",
            "editable": false,
            "description": "The start time of the event that the assignment belongs to.",
            "type": "string",
            "format": "time",
            "source": "event.start"
        },
        "event.end_date": {
            "label": "Event End Date-Time Date",
            "editable": false,
            "description": "The end time of the event that the assignment belongs to.",
            "type": "string",
            "format": "date",
            "source": "event.end"
        },
        "event.end_time": {
            "label": "Event End Date-Time Time",
            "editable": false,
            "description": "The end time of the event that the assignment belongs to.",
            "type": "string",
            "format": "time",
            "source": "event.end"
        },
        "start_date": {
            "label": "Start Date-Time Date",
            "editable": false,
            "description": "The start time of the assignment.",
            "type": "string",
            "format": "date",
            "source": "start"
        },
        "start_time": {
            "label": "Start Date-Time Time",
            "editable": false,
            "description": "The start time of the assignment.",
            "type": "string",
            "format": "time",
            "source": "start"
        },
        "end_date": {
            "label": "End Date-Time Date",
            "editable": false,
            "description": "The end time of the assignment",
            "type": "string",
            "format": "date",
            "source": "end"
        },
        "end_time": {
            "label": "End Date-Time Time",
            "editable": false,
            "description": "The end time of the assignment",
            "type": "string",
            "format": "time",
            "source": "end"
        },
        "break_start_date": {
            "label": "Break Start Date-Time Date",
            "editable": false,
            "description": "The start time of the assignment break.",
            "type": "string",
            "format": "date",
            "source": "break_start"
        },
        "break_start_time": {
            "label": "Break Start Date-Time Time",
            "editable": false,
            "description": "The start time of the assignment break.",
            "type": "string",
            "format": "time",
            "source": "break_start"
        },
        "break_end_date": {
            "label": "Break End Date-Time Date",
            "editable": false,
            "description": "The end time of the assignment break",
            "type": "string",
            "format": "date",
            "source": "break_end"
        },
        "break_end_time": {
            "label": "Break End Date-Time Time",
            "editable": false,
            "description": "The end time of the assignment break",
            "type": "string",
            "format": "time",
            "source": "break_end"
        },
        "approved_on_date": {
            "label": "Payment Approval Date-Time Date",
            "editable": false,
            "description": "Date and time when the payment was approved",
            "type": "string",
            "format": "date",
            "source": "approved_on"
        },
        "approved_on_time": {
            "label": "Payment Approval Date-Time Time",
            "editable": false,
            "description": "Date and time when the payment was approved",
            "type": "string",
            "format": "time",
            "source": "approved_on"
        },
        "paid_on_date": {
            "label": "Payment Date-Time Date",
            "editable": false,
            "description": "Date and time when the payment was made",
            "type": "string",
            "format": "date",
            "source": "paid_on"
        },
        "paid_on_time": {
            "label": "Payment Date-Time Time",
            "editable": false,
            "description": "Date and time when the payment was made",
            "type": "string",
            "format": "time",
            "source": "paid_on"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "description": "The date the assignment was created.",
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "description": "The date the assignment was created.",
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "description": "The date the assignment was updated.",
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "description": "The date the assignment was updated.",
            "type": "string",
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id	`Read Only`	foreignKey (int)	Employee Id
event_function_id	`Read Only`	foreignKey (int)	Event Function Id
event_id	`Read Only`	foreignKey (int)	Event Id
project_id	`Read Only`	foreignKey (int)	Project Id
client_id	`Read Only`	foreignKey (int)	Client Id
contact_id	`Read Only`	foreignKey (int)	Contact Id
planner_id	`Read Only`	foreignKey (int)	Planner Id
location_id	`Read Only`	foreignKey (int)	Location Id
wage_profile_id	`Read Only`	foreignKey (int)	Assignment Wage Profile Id
event_function.id	`Read Only`	int	Event Function ID ID of the event function
event_function.function_id	`Read Only`	int	Function ID ID of the event function
event_function.description	`Read Only`	string	Event Function Description Short description of the event function referenced by the assignment.
event_function.location.name	`Read Only`	string	Event Function Location The assignments event function location name.
event_function.start	`Read Only`	string (date-time)	Event Function Start Date-Time The assignments event function start time.
event_function.end	`Read Only`	string (date-time)	Event Function End Date-Time The assignments event function end time.
event_function.is_locked	`Read Only`	int (bool)	Event Function is locked The assignments event function is locked.
event_function.wage_profile_id	`Read Only`	foreignKey (int)	Event Function Wage Profile Id
event_function.function	`Read Only`	string	Event Function Name Name of the event function
event_function.function.project_leader	`Read Only`	int (bool)	Event Function Team Leader At The Event Level Flag that decides whether the assignments event function has team leader role at the event level or not.
event.name	`Read Only`	string	Event Name The name of the event that the assignment belongs to.
event.start	`Read Only`	string (date-time)	Event Start Date-Time The start time of the event that the assignment belongs to.
event.end	`Read Only`	string (date-time)	Event End Date-Time The end time of the event that the assignment belongs to.
event.auto_assign_enabled	`Read Only`	int (bool)	Event Auto Assign Enabled The flag that states whether the auto assign is enabled on the event or not.
event.location.name	`Read Only`	string	Event Location Name The assignments event location name
event.client.name	`Read Only`	string	Event client name Name of the event client.
event.contact.first_name	`Read Only`	string	Client contact first name First name of the assignment client contact.
event.contact.last_name	`Read Only`	string	Client contact last name Last name of the assignment client contact.
event.planner.first_name	`Read Only`	string	Planner first name First name of the assignment planner.
event.planner.last_name	`Read Only`	string	Planner last name Last name of the assignment planner.
event.project.name	`Read Only`	string	Project Name Name of the assignment project.
event.tags	`Read Only`	array	Event tags Tags of the assignment event.
project.event.client.id	`Read Only`	string	Project client ID ID of the project client.
project.event.client.name	`Read Only`	string	Project client name Name of the project client.
project.event.contact.id	`Read Only`	string	Project client contact ID ID of the project client contact.
project.event.contact.first_name	`Read Only`	string	Project client contact first name First name of the project client contact.
project.event.contact.last_name	`Read Only`	string	Project client contact last name Last name of the project client contact.
status		integer (int)	Status The status of the assignment.
remarks		string	Remarks Remarks on the assignment.
notes	`Read Only`	string	Notes Notes on the assignment.
start	`Read Only`	string (date-time)	Start Date-Time The start time of the assignment.
end	`Read Only`	string (date-time)	End Date-Time The end time of the assignment
break_start	`Read Only`	string (date-time)	Break Start Date-Time The start time of the assignment break.
break_end	`Read Only`	string (date-time)	Break End Date-Time The end time of the assignment break
planned_work_time	`Read Only`	string (fromHoursIntervalToHumans)	Planned Work Time including breaks The assignments planned work time including breaks.
planned_work_time_without_break	`Read Only`	string (fromHoursIntervalToHumans)	Planned Work Time excluding breaks The assignments planned work time excluding breaks.
planned_break_time	`Read Only`	string (fromHoursIntervalToHumans)	Planned Break Time The assignments planned break time.
is_approved	`Read Only`	int (bool)	Approved Is assignment data approved by planner
pay_amount	`Read Only`	float (currency)	Approved pay amount Wage amount that has been approved for payment
approved_on	`Read Only`	string (date-time)	Payment Approval Date-Time Date and time when the payment was approved
approved_by_planner_id	`Read Only`	foreignKey (int)	Id of the planner that approved the payment
paid_on	`Read Only`	string (date-time)	Payment Date-Time Date and time when the payment was made
assigned_by_availability	`Read Only`	int (bool)	Assigned by availability Whether the employee was assigned by its availability or not
auto_assigned	`Read Only`	int (bool)	Auto assigned Whether the employee was assigned automatically by the system or not
team_leader_level	`Read Only`	int (int)	Team Leader Level Team leader level at the event level or project level
created_at	`Read Only`	string (date-time)	Created Date-Time The date the assignment was created.
updated_at	`Read Only`	string (date-time)	Updated Date-Time The date the assignment was updated.
open_actions	`Read Only`	object	Open Actions Contains information about all open actions that can be performed on an assignment
configurations	`Read Only`	object	Configurations Contains information about assignment specific configuration
location	`Read Only`	string	Assignment Location Assignment location address.
statistics		string	Statistics Contains some filled positions statistics regarding the assigment
event_function.start_date	`Read Only`	string (date)	Event Function Start Date-Time Date The assignments event function start time.
event_function.start_time	`Read Only`	string (time)	Event Function Start Date-Time Time The assignments event function start time.
event_function.end_date	`Read Only`	string (date)	Event Function End Date-Time Date The assignments event function end time.
event_function.end_time	`Read Only`	string (time)	Event Function End Date-Time Time The assignments event function end time.
event.start_date	`Read Only`	string (date)	Event Start Date-Time Date The start time of the event that the assignment belongs to.
event.start_time	`Read Only`	string (time)	Event Start Date-Time Time The start time of the event that the assignment belongs to.
event.end_date	`Read Only`	string (date)	Event End Date-Time Date The end time of the event that the assignment belongs to.
event.end_time	`Read Only`	string (time)	Event End Date-Time Time The end time of the event that the assignment belongs to.
start_date	`Read Only`	string (date)	Start Date-Time Date The start time of the assignment.
start_time	`Read Only`	string (time)	Start Date-Time Time The start time of the assignment.
end_date	`Read Only`	string (date)	End Date-Time Date The end time of the assignment
end_time	`Read Only`	string (time)	End Date-Time Time The end time of the assignment
break_start_date	`Read Only`	string (date)	Break Start Date-Time Date The start time of the assignment break.
break_start_time	`Read Only`	string (time)	Break Start Date-Time Time The start time of the assignment break.
break_end_date	`Read Only`	string (date)	Break End Date-Time Date The end time of the assignment break
break_end_time	`Read Only`	string (time)	Break End Date-Time Time The end time of the assignment break
approved_on_date	`Read Only`	string (date)	Payment Approval Date-Time Date Date and time when the payment was approved
approved_on_time	`Read Only`	string (time)	Payment Approval Date-Time Time Date and time when the payment was approved
paid_on_date	`Read Only`	string (date)	Payment Date-Time Date Date and time when the payment was made
paid_on_time	`Read Only`	string (time)	Payment Date-Time Time Date and time when the payment was made
created_at_date	`Read Only`	string (date)	Created Date-Time Date The date the assignment was created.
created_at_time	`Read Only`	string (time)	Created Date-Time Time The date the assignment was created.
updated_at_date	`Read Only`	string (date)	Updated Date-Time Date The date the assignment was updated.
updated_at_time	`Read Only`	string (time)	Updated Date-Time Time The date the assignment was updated.

Relations

Name	Resource	Foreign Key	Description
assignmentEmployee	employees	assignments.employee_id	Employee referenced by the assignment.
assignmentEvent	events	assignments.event_id	Event referenced by the assignment.
assignmentProject	projects	assignments.project_id	Project referenced by the assignment.
assignmentFunction	event-functions	assignments.event_function_id	Function referenced by the assignment.
assignmentWageProfile	wage-profiles	assignments.wage_profile_id	Wage profile referenced by the assignment.
assignmentLocation	locations	assignments.location_id	Location of the assignment.
paysheets	paysheets	paysheets.assignment_id
work-times	work-times	work-times.event_function_employee_id
wages	assignment-wages	assignment-wages.assignment_id
report	assignment-employment-reports	assignment-employment-reports.assignment_id
contract	assignment-contract	assignment-contract.assignment_id
work-time-proposals	work-time-proposals	work-time-proposals.assignment_id
wage-proposals	wage-proposals	wage-proposals.assignment_id
livestamps	livestamps	livestamps.assignment_id
checkins	checkins	checkins.assignment_id
pre-checkins	pre-checkins	pre-checkins.assignment_id

Actions

Request	Description
`GET /assignments`	Resource listing
`GET /assignments/<id>`	Resource read
`POST /assignments`	Resource create
`PUT /assignments/<id>`	Resource update
`DELETE /assignments/<id>`	Resource delete
`GET /assignments/<id>/status-map`	Available assignment status values.
`PUT /assignments/<id>/status`	Change assignment specific state
`PUT /assignments/<id>/status`	Bulk change assignments states
`GET /assignments/<id>/teamsheet`	Get the team sheet for a specific assignment
`GET /assignments/<id>/open-actions`	Get open actions for a specific assignment.
`GET /assignments/<id>/configurations`	Get configurations for a specific assignment
`GET /assignments/<id>/configurations`	Get configurations for a set of given assignment
`PUT /assignments/<id>/pay`	Set payment time for a specific assignment
`GET /assignments/<id>/reporting-forms`	Get reporting forms attached to a particular assignment via related event / project.
`GET /assignments/<id>/reporting-forms`	Get reporting forms attached to multiple assignments via related events / projects.
`POST /assignments/<id>/signed-work-data`	Post signed work data like work times proposals.
`GET /assignments/<id>/signed-work-data`	Get configurations for signed work data Note: this action is deprecated. Use GET /assignments//signed-work-data-approvers instead
`GET /assignments/<id>/signed-work-data-approvers`	Get the approvers that can sign work data
`PUT /assignments/<id>/time`	Set time for a specific assignment

Attributes

Schema

Attributes schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "collection_id": {
            "label": "Project ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "entity_id": {
            "label": "Entity ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "type_id": {
            "label": "Attribute type ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "identifier": {
            "label": "Identifier",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "name": {
            "label": "Label",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "language_id": {
            "label": "Language ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "is_locked_employees": {
            "label": "Is locked for employees",
            "type": "integer",
            "format": "bool",
            "editable": false
        },
        "read_only_for_recruiting_forms": {
            "label": "Enable read-only for recruiting forms",
            "type": "integer",
            "format": "bool",
            "editable": false
        },
        "deletable": {
            "label": "Is deletable",
            "type": "int",
            "format": "bool",
            "editable": false
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
collection_id	`Read Only`	foreignKey (int)	Project ID
entity_id	`Read Only`	foreignKey (int)	Entity ID
type_id	`Read Only`	foreignKey (int)	Attribute type ID
identifier	`Read Only`	string (string)	Identifier
name	`Read Only`	string (string)	Label
language_id	`Read Only`	foreignKey (int)	Language ID
is_locked_employees	`Read Only`	integer (bool)	Is locked for employees
read_only_for_recruiting_forms	`Read Only`	integer (bool)	Enable read-only for recruiting forms
deletable	`Read Only`	int (bool)	Is deletable

Relations

Name	Resource	Foreign Key	Description
attributeCollection	collections	attributes.collection_id
languages	languages	attributes.language_id

Actions

Request	Description
`GET /attributes`	Resource listing
`GET /attributes/<id>`	Resource read
`POST /attributes`	Resource create
`PUT /attributes/<id>`	Resource update
`DELETE /attributes/<id>`	Resource delete

Automations

Schema

Automations schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "trigger_type": {
            "label": "Trigger Type",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "trigger_configuration": {
            "label": "Trigger Configuration",
            "editable": true,
            "type": "string",
            "format": "json"
        },
        "routine_type": {
            "label": "Routine Type",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "routine_configuration": {
            "label": "Routine Configuration",
            "editable": true,
            "type": "string",
            "format": "json"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
trigger_type		string (string)	Trigger Type
trigger_configuration		string (json)	Trigger Configuration
routine_type		string (string)	Routine Type
routine_configuration		string (json)	Routine Configuration

Actions

Request	Description
`GET /automations`	Resource listing
`GET /automations/<id>`	Resource read
`POST /automations`	Resource create
`PUT /automations/<id>`	Resource update
`DELETE /automations/<id>`	Resource delete

Availability requests

Schema

Availability-requests schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "from": {
            "label": "From date",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "to": {
            "label": "To date",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "blocked_at": {
            "label": "Request blocked at date",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "completed_at": {
            "label": "Request completed at date",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "completed_by_enforcement": {
            "label": "Request completed by enforcement",
            "editable": false,
            "type": "integer",
            "format": "bool"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id	`Read Only`	foreignKey (int)	Employee ID
name	`Read Only`	string (string)	Name
from	`Read Only`	string (string)	From date
to	`Read Only`	string (string)	To date
blocked_at	`Read Only`	string (string)	Request blocked at date
completed_at	`Read Only`	string (string)	Request completed at date
completed_by_enforcement	`Read Only`	integer (bool)	Request completed by enforcement

Relations

Name	Resource	Foreign Key
employee	employees	availability-requests.employee_id
definition	availability-requests-definitions	availability-requests.id
availabilities	availability-requests-availabilities	availability-requests.id

Actions

Request	Description
`GET /availability-requests`	Resource listing
`GET /availability-requests/<id>`	Resource read
`POST /availability-requests`	Resource create
`PUT /availability-requests/<id>`	Resource update
`DELETE /availability-requests/<id>`	Resource delete

Availability requests availabilities

Schema

Availability-requests-availabilities schema

{
    "properties": {
        "availability_request_id": {
            "label": "Availability request ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee ID",
            "editable": false,
            "type": "int",
            "format": "int"
        },
        "availabilities": {
            "label": "Availabilities",
            "editable": false,
            "type": "array",
            "format": "array"
        }
    }
}

Fields

Name	Properties	Type	Description
availability_request_id	`Read Only`	identityField (int)	Availability request ID
employee_id	`Read Only`	int (int)	Employee ID
availabilities	`Read Only`	array (array)	Availabilities

Relations

Name	Resource	Foreign Key	Description
availability-request	availability-requests	availability-requests-availabilities.availability_request_id
employee	employees	availability-requests-availabilities.employee_id

Actions

Request	Description
`GET /availability-requests-availabilities`	Resource listing
`GET /availability-requests-availabilities/<id>`	Resource read
`POST /availability-requests-availabilities`	Resource create
`PUT /availability-requests-availabilities/<id>`	Resource update
`DELETE /availability-requests-availabilities/<id>`	Resource delete

Availability requests definitions

Schema

Availability-requests-definitions schema

{
    "properties": {
        "availability_request_id": {
            "label": "Availability request ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "rules": {
            "label": "Rules",
            "editable": false,
            "type": "array",
            "format": "array"
        },
        "time_slots": {
            "label": "Time slots",
            "editable": false,
            "type": "array",
            "format": "array"
        },
        "requested_availabilities": {
            "label": "Requested availabilities",
            "editable": false,
            "type": "array",
            "format": "array"
        }
    }
}

Fields

Name	Properties	Type	Description
availability_request_id	`Read Only`	identityField (int)	Availability request ID
rules	`Read Only`	array (array)	Rules
time_slots	`Read Only`	array (array)	Time slots
requested_availabilities	`Read Only`	array (array)	Requested availabilities

Relations

Name	Resource	Foreign Key	Description
availability-request	availability-requests	availability-requests-definitions.availability_request_id

Actions

Request	Description
`GET /availability-requests-definitions`	Resource listing
`GET /availability-requests-definitions/<id>`	Resource read
`POST /availability-requests-definitions`	Resource create
`PUT /availability-requests-definitions/<id>`	Resource update
`DELETE /availability-requests-definitions/<id>`	Resource delete

Busy dates

Schema

Busy-dates schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee Id",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "description": {
            "label": "Description",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "type": {
            "label": "Type",
            "editable": true,
            "type": "string",
            "format": "string",
            "enum": [
                "vacation",
                "paid_training",
                "sick_leave",
                "parental_leave",
                "compensation_time",
                "day_off",
                "no_show",
                "other"
            ],
            "valueMapping": {
                "vacation": "Vacation",
                "paid_training": "Paid training",
                "sick_leave": "Sick leave",
                "parental_leave": "Parental leave",
                "compensation_time": "Compensation time",
                "day_off": "Day Off",
                "no_show": "No Show",
                "other": "Other"
            }
        },
        "reason": {
            "label": "Reason (deprecated)",
            "editable": true,
            "type": "string",
            "format": "string",
            "description": "This field is deprecated and will be removed in the future. Instead of this field use the type and description fields."
        },
        "start": {
            "label": "Start Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "end": {
            "label": "End Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "busy_entry": {
            "label": "Busy date configuration",
            "type": "object"
        },
        "files_ids": {
            "label": "Busy dates files IDs (optional)",
            "editable": true,
            "description": "The IDs of the files to be added to the busy dates.",
            "type": "array",
            "format": "array"
        },
        "start_date": {
            "label": "Start Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "start"
        },
        "start_time": {
            "label": "Start Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "start"
        },
        "end_date": {
            "label": "End Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "end"
        },
        "end_time": {
            "label": "End Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "end"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id		foreignKey (int)	Employee Id
description		string (string)	Description
type		string (string)	Type
reason		string (string)	Reason (deprecated) This field is deprecated and will be removed in the future. Instead of this field use the type and description fields.
start	`Read Only`	string (date-time)	Start Date-Time
end	`Read Only`	string (date-time)	End Date-Time
busy_entry	`Read Only`	object	Busy date configuration
files_ids		array (array)	Busy dates files IDs (optional) The IDs of the files to be added to the busy dates.
start_date	`Read Only`	string (date)	Start Date-Time Date
start_time	`Read Only`	string (time)	Start Date-Time Time
end_date	`Read Only`	string (date)	End Date-Time Date
end_time	`Read Only`	string (time)	End Date-Time Time

Relations

Name	Resource	Foreign Key	Description
busyDatesEmployee	employees	busy-dates.employee_id

Actions

Request	Description
`GET /busy-dates`	Resource listing
`GET /busy-dates/<id>`	Resource read
`POST /busy-dates`	Resource create
`PUT /busy-dates/<id>`	Resource update
`DELETE /busy-dates/<id>`	Resource delete

Checkins

Schema

Checkins schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField"
        },
        "assignment_id": {
            "label": "Assignment ID",
            "type": "foreignKey",
            "editable": false
        },
        "timestamp": {
            "label": "Timestamp Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "hash": {
            "label": "Hash",
            "description": "Optional check-in hash.",
            "editable": false,
            "type": "string"
        },
        "metadata": {
            "label": "Metadata",
            "description": "Check-in metadata.",
            "editable": false,
            "type": "associativeArray"
        },
        "source": {
            "label": "Source",
            "editable": false,
            "type": "int",
            "enum": [
                1,
                2,
                3
            ],
            "valueMapping": {
                "1": "QR code",
                "2": "External",
                "3": "NFC"
            }
        },
        "type": {
            "label": "Type",
            "editable": false,
            "type": "int",
            "enum": [
                1,
                2,
                3,
                4
            ],
            "valueMapping": {
                "1": "Start",
                "2": "Break Start",
                "3": "Break End",
                "4": "End"
            }
        },
        "created_at": {
            "label": "Created",
            "editable": false
        },
        "timestamp_date": {
            "label": "Timestamp Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "timestamp"
        },
        "timestamp_time": {
            "label": "Timestamp Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "timestamp"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField	ID
assignment_id	`Read Only`	foreignKey	Assignment ID
timestamp	`Read Only`	string (date-time)	Timestamp Date-Time
hash	`Read Only`	string	Hash Optional check-in hash.
metadata	`Read Only`	associativeArray	Metadata Check-in metadata.
source	`Read Only`	int	Source
type	`Read Only`	int	Type
created_at	`Read Only`		Created
timestamp_date	`Read Only`	string (date)	Timestamp Date-Time Date
timestamp_time	`Read Only`	string (time)	Timestamp Date-Time Time

Relations

Name	Resource	Foreign Key	Description
checkInAssignment	assignments	checkins.assignment_id

Actions

Request	Description
`GET /checkins`	Resource listing
`GET /checkins/<id>`	Resource read
`POST /checkins`	Resource create
`PUT /checkins/<id>`	Resource update
`DELETE /checkins/<id>`	Resource delete

Clients

This resource uses dynamic fields.

Schema

Clients schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "relation_id": {
            "label": "Relation ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "status": {
            "label": "Status",
            "editable": true,
            "type": "integer",
            "enum": [
                1,
                2
            ],
            "format": "int",
            "valueMapping": {
                "1": "Active",
                "2": "Inactive"
            }
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "company": {
            "label": "Company name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 11,
            "input_type": "text"
        },
        "address_first": {
            "label": "Address line 1",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 12,
            "input_type": "text"
        },
        "address_second": {
            "label": "Address line 2",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 13,
            "input_type": "text"
        },
        "zip": {
            "label": "ZIP",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 14,
            "input_type": "text"
        },
        "city": {
            "label": "City",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 15,
            "input_type": "text"
        },
        "country": {
            "label": "Country",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 16,
            "input_type": "select"
        },
        "dynamic_field_86": {
            "label": "Checkbox",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 86,
            "input_type": "boolean"
        },
        "dynamic_field_212": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 212,
            "input_type": "select"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
relation_id	`Read Only`	foreignKey (int)	Relation ID
status		integer (int)	Status
created_at	`Read Only`	string (date-time)	Created Date-Time
updated_at	`Read Only`	string (date-time)	Updated Date-Time
company	`Dynamic Field`		Company name
address_first	`Dynamic Field`		Address line 1
address_second	`Dynamic Field`		Address line 2
zip	`Dynamic Field`		ZIP
city	`Dynamic Field`		City
country	`Dynamic Field`		Country
dynamic_field_86	`Dynamic Field`		Checkbox
dynamic_field_212	`Dynamic Field`		[missing translation]
created_at_date	`Read Only`	string (date)	Created Date-Time Date
created_at_time	`Read Only`	string (time)	Created Date-Time Time
updated_at_date	`Read Only`	string (date)	Updated Date-Time Date
updated_at_time	`Read Only`	string (time)	Updated Date-Time Time

Relations

Name	Resource	Foreign Key
clientEvents	events	events.client_id
clientProjects	projects	projects.client_id
clientContacts	contacts	contacts.client_id

Actions

Request	Description
`GET /clients`	Resource listing
`GET /clients/<id>`	Resource read
`POST /clients`	Resource create
`PUT /clients/<id>`	Resource update
`DELETE /clients/<id>`	Resource delete Note: this action is deprecated. In order to mark a client as deleted you can use `PUT /clients/<id>` action by sending `{ status: 2 }` as one of the parameters

Collections

Schema

Collections schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "identifier": {
            "label": "Identifier",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "name": {
            "label": "Name",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "editable": {
            "label": "Editable",
            "editable": false,
            "type": "integer",
            "format": "bool"
        },
        "visible": {
            "label": "Visible",
            "editable": false,
            "type": "integer",
            "format": "bool"
        },
        "deleted": {
            "label": "Deleted",
            "editable": true,
            "type": "integer",
            "format": "bool"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
identifier	`Read Only`	string (string)	Identifier
name		string (string)	Name
editable	`Read Only`	integer (bool)	Editable
visible	`Read Only`	integer (bool)	Visible
deleted		integer (bool)	Deleted

Actions

Request	Description
`GET /collections`	Resource listing Note: This returns all collections, including those marked as deleted. Use `GET /collections?deleted=0` to filter out collections marked as deleted.
`GET /collections/<id>`	Resource read
`POST /collections`	Resource create
`PUT /collections/<id>`	Resource update
`DELETE /collections/<id>`	Resource delete Note: this action is deprecated. In order to mark a collection as deleted you can use `PUT /collections/<id>` action by sending `{ deleted: true }` as one of the parameters
`GET /collections/<id>/values`	List all values of a specific collection
`GET /collections/<id>/objects`	List all objects of a specific collection
`POST /collections/<id>/value`	Add new value to a collection
`GET /collections/<id>/value`	Get specific value from a collection
`PUT /collections/<id>/value`	Update specific value from a collection
`DELETE /collections/<id>/value`	Delete specific value from a collection Note: this action is deprecated. In order to mark a collection item as deleted you can use `PUT /collections/<id>/value` action by sending `{ deleted: true }` as one of the parameters

Contacts

This resource uses dynamic fields.

Schema

Contacts schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "relation_id": {
            "label": "Relation ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "client_id": {
            "label": "Client ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int"
        },
        "status": {
            "label": "Status",
            "editable": true,
            "type": "integer",
            "enum": [
                1,
                2
            ],
            "format": "int",
            "valueMapping": {
                "1": "Active",
                "2": "Inactive"
            }
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "firstname": {
            "label": "First name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 17,
            "input_type": "text"
        },
        "lastname": {
            "label": "Last name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 18,
            "input_type": "text"
        },
        "email": {
            "label": "Email address",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 19,
            "input_type": "email"
        },
        "mobile": {
            "label": "Mobile number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 20,
            "input_type": "phone"
        },
        "gender": {
            "label": "Gender",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 53,
            "input_type": "select"
        },
        "dynamic_field_167": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 167,
            "input_type": "text"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
relation_id	`Read Only`	foreignKey (int)	Relation ID
client_id		foreignKey (int)	Client ID
status		integer (int)	Status
created_at	`Read Only`	string (date-time)	Created Date-Time
updated_at	`Read Only`	string (date-time)	Updated Date-Time
firstname	`Dynamic Field`		First name
lastname	`Dynamic Field`		Last name
email	`Dynamic Field`		Email address
mobile	`Dynamic Field`		Mobile number
gender	`Dynamic Field`		Gender
dynamic_field_167	`Dynamic Field`		[missing translation]
created_at_date	`Read Only`	string (date)	Created Date-Time Date
created_at_time	`Read Only`	string (time)	Created Date-Time Time
updated_at_date	`Read Only`	string (date)	Updated Date-Time Date
updated_at_time	`Read Only`	string (time)	Updated Date-Time Time

Relations

Name	Resource	Foreign Key
contactClient	clients	contacts.client_id
contactEvents	events	events.contact_id
contactProjects	projects	projects.contact_id

Actions

Request	Description
`GET /contacts`	Resource listing
`GET /contacts/<id>`	Resource read
`POST /contacts`	Resource create
`PUT /contacts/<id>`	Resource update
`DELETE /contacts/<id>`	Resource delete Note: this action is deprecated. In order to mark a contact as deleted you can use `PUT /contacts/<id>` action by sending `{ status: 2 }` as one of the parameters

Counties

Schema

Counties schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "code": {
            "label": "Code",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "country": {
            "label": "Country",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "deleted": {
            "label": "Deleted",
            "editable": false,
            "type": "integer",
            "format": "bool",
            "description": "Whether the county is deleted or not."
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
name	`Read Only`	string (string)	Name
code	`Read Only`	string (string)	Code
country	`Read Only`	string (string)	Country
deleted	`Read Only`	integer (bool)	Deleted Whether the county is deleted or not.

Actions

Request	Description
`GET /counties`	Resource listing
`GET /counties/<id>`	Resource read
`POST /counties`	Resource create
`PUT /counties/<id>`	Resource update
`DELETE /counties/<id>`	Resource delete

Employee availability

Schema

Employee-availability schema

{
    "properties": {
        "time_slot_id": {
            "label": "Time slot ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "date": {
            "label": "Availability date",
            "editable": false,
            "type": "string",
            "format": "date"
        },
        "employee_id": {
            "label": "Employee ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "availability_request_name": {
            "label": "Availability request name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "planner_name": {
            "label": "Availability planner name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "completed_at": {
            "label": "Request completed at",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "completed_at_date": {
            "label": "Request completed at Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "completed_at"
        },
        "completed_at_time": {
            "label": "Request completed at Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "completed_at"
        }
    }
}

Fields

Name	Properties	Type	Description
time_slot_id	`Read Only`	identityField (int)	Time slot ID
date	`Read Only`	string (date)	Availability date
employee_id	`Read Only`	identityField (int)	Employee ID
availability_request_name	`Read Only`	string (string)	Availability request name
planner_name	`Read Only`	string (string)	Availability planner name
completed_at	`Read Only`	string (date-time)	Request completed at
completed_at_date	`Read Only`	string (date)	Request completed at Date
completed_at_time	`Read Only`	string (time)	Request completed at Time

Relations

Name	Resource	Foreign Key	Description
employee	employees	employee-availability.employee_id
timeSlot	time-slots	employee-availability.time_slot_id

Actions

Request	Description
`GET /employee-availability`	Resource listing
`GET /employee-availability/<id>`	Resource read
`POST /employee-availability`	Resource create
`PUT /employee-availability/<id>`	Resource update
`DELETE /employee-availability/<id>`	Resource delete

Employee notes

Schema

Employee-notes schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int",
            "description": "The ID of the employee this note belongs to."
        },
        "planner_id": {
            "label": "Planner ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int",
            "description": "The ID of the planner who created or last modified the note. Automatically set to the authenticated planner."
        },
        "content": {
            "label": "Content",
            "type": "string",
            "editable": true,
            "description": "The content of the note. HTML tags will be sanitized."
        },
        "created_at": {
            "label": "Created on",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated on",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "created_at_date": {
            "label": "Created on Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created on Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Last update Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Last update Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id		foreignKey (int)	Employee ID The ID of the employee this note belongs to.
planner_id	`Read Only`	foreignKey (int)	Planner ID The ID of the planner who created or last modified the note. Automatically set to the authenticated planner.
content		string	Content The content of the note. HTML tags will be sanitized.
created_at	`Read Only`	string (date-time)	Created on
updated_at	`Read Only`	string (date-time)	Updated on
created_at_date	`Read Only`	string (date)	Created on Date
created_at_time	`Read Only`	string (time)	Created on Time
updated_at_date	`Read Only`	string (date)	Last update Date
updated_at_time	`Read Only`	string (time)	Last update Time

Relations

Name	Resource	Foreign Key	Description
employee	employees	employee-notes.employee_id

Actions

Request	Description
`GET /employee-notes`	Resource listing
`GET /employee-notes/<id>`	Resource read
`POST /employee-notes`	Resource create
`PUT /employee-notes/<id>`	Resource update
`DELETE /employee-notes/<id>`	Resource delete

Employee pictures

Schema

Employee-pictures schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee Id",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "file_id": {
            "label": "File Id",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "order": {
            "label": "Order index",
            "editable": true,
            "type": "integer",
            "format": "int"
        },
        "is_profile_picture": {
            "label": "Is Profile Picture",
            "editable": true,
            "type": "integer",
            "format": "bool"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id	`Read Only`	foreignKey (int)	Employee Id
file_id	`Read Only`	foreignKey (int)	File Id
order		integer (int)	Order index
is_profile_picture		integer (bool)	Is Profile Picture

Relations

Name	Resource	Foreign Key	Description
employee	employees	employee-pictures.employee_id
file	files	employee-pictures.file_id

Actions

Request	Description
`GET /employee-pictures`	Resource listing
`GET /employee-pictures/<id>`	Resource read
`POST /employee-pictures`	Resource create
`PUT /employee-pictures/<id>`	Resource update
`DELETE /employee-pictures/<id>`	Resource delete

Employee teams

Schema

Employee-teams schema

{
    "properties": {
        "employee_id": {
            "label": "Employee ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "team_id": {
            "label": "Team ID",
            "type": "int",
            "editable": false,
            "format": "int"
        },
        "team_name": {
            "label": "Team name",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "team_created_at": {
            "label": "Team Created At Date-Time",
            "type": "string",
            "editable": false,
            "format": "date-time"
        },
        "team_created_at_date": {
            "label": "Team Created At Date-Time Date",
            "type": "string",
            "editable": false,
            "format": "date",
            "source": "team_created_at"
        },
        "team_created_at_time": {
            "label": "Team Created At Date-Time Time",
            "type": "string",
            "editable": false,
            "format": "time",
            "source": "team_created_at"
        }
    }
}

Fields

Name	Properties	Type	Description
employee_id	`Read Only`	foreignKey (int)	Employee ID
team_id	`Read Only`	int (int)	Team ID
team_name	`Read Only`	string (string)	Team name
team_created_at	`Read Only`	string (date-time)	Team Created At Date-Time
team_created_at_date	`Read Only`	string (date)	Team Created At Date-Time Date
team_created_at_time	`Read Only`	string (time)	Team Created At Date-Time Time

Relations

Name	Resource	Foreign Key	Description
employee	employees	employee-teams.employee_id

Actions

Request	Description
`GET /employee-teams`	Resource listing
`GET /employee-teams/<id>`	Resource read
`POST /employee-teams`	Resource create
`PUT /employee-teams/<id>`	Resource update
`DELETE /employee-teams/<id>`	Resource delete

Employees

This resource uses dynamic fields.

Schema

Employees schema

{
    "properties": {
        "id": {
            "label": "ID",
            "type": "identityField",
            "format": "int",
            "editable": false
        },
        "status": {
            "label": "Status",
            "type": "integer",
            "editable": true,
            "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6
            ],
            "valueMapping": [
                "Uncompleted",
                "Applicant",
                "Provisional candidate",
                "Candidate",
                "Active",
                "Inactive",
                "Deleted"
            ],
            "format": "int"
        },
        "wage_profile_id": {
            "label": "Wage Profile ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int"
        },
        "contract_type_id": {
            "label": "Contract Type",
            "type": "Collection",
            "identifier": "contract_type",
            "input_type": "multi_select",
            "editable": true,
            "format": "int"
        },
        "employment_type": {
            "label": "Employment Type",
            "type": "integer",
            "editable": true,
            "enum": [
                1,
                2,
                3
            ],
            "valueMapping": {
                "1": "Flexible",
                "2": "Fixed",
                "3": "External"
            },
            "format": "int"
        },
        "created_at": {
            "label": "Created on Date-Time",
            "editable": false,
            "description": "The date the employee was created in the system.",
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated on Date-Time",
            "editable": false,
            "description": "The date the employee was last updated in the system.",
            "type": "string",
            "format": "date-time"
        },
        "reminded_at": {
            "label": "Reminded on Date-Time",
            "editable": false,
            "description": "The date the employee was last reminded to complete the recruiting process.",
            "type": "string",
            "format": "date-time"
        },
        "last_logged_in_at": {
            "label": "Logged in on Date-Time",
            "editable": false,
            "description": "The date the employee was last logged in on.",
            "type": "string",
            "format": "date-time"
        },
        "last_active_at": {
            "label": "Last active on Date-Time",
            "editable": false,
            "description": "The date the employee was last active on.",
            "type": "string",
            "format": "date-time"
        },
        "activated_at": {
            "label": "Activated on Date-Time",
            "editable": false,
            "description": "The date the employee was activated on.",
            "type": "string",
            "format": "date-time"
        },
        "deactivated_at": {
            "label": "Deactivated on Date-Time",
            "editable": false,
            "description": "The date the employee was deactivated on.",
            "type": "string",
            "format": "date-time"
        },
        "password_expires_at": {
            "label": "Password expires at Date-Time",
            "editable": false,
            "description": "The date when the employee password will expire.",
            "type": "string",
            "format": "date-time"
        },
        "employee_tags": {
            "label": "Tags",
            "editable": false,
            "type": "array",
            "format": "array"
        },
        "employee_notes": {
            "label": "Employee Notes",
            "editable": false,
            "type": "string"
        },
        "firstname": {
            "label": "First name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 1,
            "input_type": "text"
        },
        "lastname": {
            "label": "Last name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 2,
            "input_type": "text"
        },
        "email": {
            "label": "Email address",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 3,
            "input_type": "email"
        },
        "mobile": {
            "label": "Mobile number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 4,
            "input_type": "phone"
        },
        "address_first": {
            "label": "Street ",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 5,
            "input_type": "text"
        },
        "address_second": {
            "label": "Address line 2",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 6,
            "input_type": "text"
        },
        "zip": {
            "label": "Postcode",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 7,
            "input_type": "text"
        },
        "city": {
            "label": "City",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 8,
            "input_type": "text"
        },
        "country": {
            "label": "Country",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 9,
            "input_type": "select"
        },
        "qualifications": {
            "label": "Qualifications",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 10,
            "input_type": "multi_select"
        },
        "dynamic_field_26": {
            "label": "Applies for",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 26,
            "input_type": "select"
        },
        "dynamic_field_27": {
            "label": "How did you hear about us?",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 27,
            "input_type": "multi_select"
        },
        "dynamic_field_28": {
            "label": "Height",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 28,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_30": {
            "label": "E-Mail Sprache",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 30,
            "input_type": "select"
        },
        "dynamic_field_31": {
            "label": "Driver",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 31,
            "input_type": "select"
        },
        "dynamic_field_32": {
            "label": "Car",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 32,
            "input_type": "select"
        },
        "dynamic_field_33": {
            "label": "Gesundheitszeugnis",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 33,
            "input_type": "select"
        },
        "dynamic_field_34": {
            "label": "NI Number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 34,
            "input_type": "text"
        },
        "dynamic_field_38": {
            "label": "IBAN",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 38,
            "input_type": "text"
        },
        "dynamic_field_39": {
            "label": "Bank",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 39,
            "input_type": "text"
        },
        "dynamic_field_41": {
            "label": "Religious denomination",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 41,
            "input_type": "select"
        },
        "dynamic_field_43": {
            "label": "Driver's licence",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 43,
            "input_type": "multi_select"
        },
        "birthday": {
            "label": "Birthday",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 47,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_48": {
            "label": "Employment Contract",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 48,
            "input_type": "file"
        },
        "dynamic_field_49": {
            "label": "Visa",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 49,
            "input_type": "file"
        },
        "gender": {
            "label": "Gender",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 51,
            "input_type": "select"
        },
        "dynamic_field_54": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 54,
            "input_type": "file"
        },
        "dynamic_field_62": {
            "label": "Document 3",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 62,
            "input_type": "file"
        },
        "dynamic_field_63": {
            "label": "Photo 1",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 63,
            "input_type": "file"
        },
        "dynamic_field_66": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 66,
            "input_type": "level_select"
        },
        "dynamic_field_69": {
            "label": "Ich akzeptiere die AGB",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 69,
            "input_type": "boolean"
        },
        "dynamic_field_72": {
            "label": "Employment type",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 72,
            "input_type": "select"
        },
        "dynamic_field_73": {
            "label": "Expiry date Student card",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 73,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_74": {
            "label": "DIAS number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 74,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_75": {
            "label": "Languages",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 75,
            "input_type": "level_select"
        },
        "dynamic_field_76": {
            "label": "Date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 76,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_77": {
            "label": "Account Balance",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 77,
            "input_type": "money",
            "format": "formatted-currency"
        },
        "dynamic_field_80": {
            "label": "Validatione Grande",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 80,
            "input_type": "text"
        },
        "dynamic_field_81": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 81,
            "input_type": "file"
        },
        "dynamic_field_83": {
            "label": "Afbeelding badge",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 83,
            "input_type": "file"
        },
        "dynamic_field_84": {
            "label": "Datum Badge",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 84,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_87": {
            "label": "EMP ID",
            "description": "",
            "editable": false,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 87,
            "input_type": "index",
            "format": "int"
        },
        "dynamic_field_90": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 90,
            "input_type": "wysiwyg"
        },
        "dynamic_field_91": {
            "label": "Nationality",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 91,
            "input_type": "select"
        },
        "dynamic_field_92": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 92,
            "input_type": "boolean"
        },
        "dynamic_field_93": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 93,
            "input_type": "boolean"
        },
        "dynamic_field_94": {
            "label": "T-Shirt size",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 94,
            "input_type": "select"
        },
        "dynamic_field_95": {
            "label": "Railcard",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 95,
            "input_type": "select"
        },
        "dynamic_field_97": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 97,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_98": {
            "label": "Profession",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 98,
            "input_type": "text"
        },
        "dynamic_field_99": {
            "label": "Landline",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 99,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_100": {
            "label": "Marital status",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 100,
            "input_type": "select"
        },
        "dynamic_field_101": {
            "label": "Work team",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 101,
            "input_type": "multi_select"
        },
        "dynamic_field_102": {
            "label": "Visible tattoos?",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 102,
            "input_type": "select"
        },
        "dynamic_field_103": {
            "label": "Trouser size",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 103,
            "input_type": "select"
        },
        "dynamic_field_104": {
            "label": "CV",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 104,
            "input_type": "file"
        },
        "dynamic_field_107": {
            "label": "Assignments",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 107,
            "input_type": "select"
        },
        "dynamic_field_108": {
            "label": "Other languages",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 108,
            "input_type": "text_area"
        },
        "dynamic_field_111": {
            "label": "Collectionfield",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 111,
            "input_type": "select"
        },
        "dynamic_field_114": {
            "label": "Remarks",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 114,
            "input_type": "text_area"
        },
        "dynamic_field_115": {
            "label": "Driving Licence Copy",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 115,
            "input_type": "file"
        },
        "dynamic_field_118": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 118,
            "input_type": "text"
        },
        "dynamic_field_119": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 119,
            "input_type": "select"
        },
        "dynamic_field_120": {
            "label": "Preferred locations",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 120,
            "input_type": "multi_select"
        },
        "dynamic_field_130": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 130,
            "input_type": "multi_select"
        },
        "dynamic_field_131": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 131,
            "input_type": "select"
        },
        "dynamic_field_132": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 132,
            "input_type": "url"
        },
        "dynamic_field_134": {
            "label": "This is a checkbox",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 134,
            "input_type": "boolean"
        },
        "dynamic_field_135": {
            "label": "Date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 135,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_136": {
            "label": "Lieblingsfarbe",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 136,
            "input_type": "color"
        },
        "dynamic_field_137": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 137,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_138": {
            "label": "decimal",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 138,
            "input_type": "decimal"
        },
        "dynamic_field_139": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 139,
            "input_type": "url"
        },
        "dynamic_field_140": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 140,
            "input_type": "time",
            "format": "formatted-time"
        },
        "dynamic_field_141": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 141,
            "input_type": "text"
        },
        "dynamic_field_145": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 145,
            "input_type": "select"
        },
        "dynamic_field_146": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 146,
            "input_type": "text"
        },
        "communication_language": {
            "label": "Communication language",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 148,
            "input_type": "select"
        },
        "dynamic_field_155": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 155,
            "input_type": "multi_select"
        },
        "dynamic_field_156": {
            "label": "Nachtschicht",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 156,
            "input_type": "select"
        },
        "dynamic_field_158": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 158,
            "input_type": "select"
        },
        "dynamic_field_159": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 159,
            "input_type": "multi_select"
        },
        "dynamic_field_160": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 160,
            "input_type": "money",
            "format": "formatted-currency"
        },
        "dynamic_field_164": {
            "label": "Shoes",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 164,
            "input_type": "color"
        },
        "dynamic_field_172": {
            "label": "Work location",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 172,
            "input_type": "select"
        },
        "dynamic_field_179": {
            "label": "Timesheet",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 179,
            "input_type": "file"
        },
        "dynamic_field_180": {
            "label": "Pension Insurance",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 180,
            "input_type": "file"
        },
        "dynamic_field_183": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 183,
            "input_type": "boolean"
        },
        "dynamic_field_184": {
            "label": "Contractual period",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 184,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_186": {
            "label": "Additional data needed",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 186,
            "input_type": "wysiwyg"
        },
        "dynamic_field_189": {
            "label": "Technologies",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 189,
            "input_type": "level_select"
        },
        "dynamic_field_191": {
            "label": "Safety shoes",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 191,
            "input_type": "select"
        },
        "dynamic_field_192": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 192,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_193": {
            "label": "County",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 193,
            "input_type": "select"
        },
        "dynamic_field_195": {
            "label": "Status before employment",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 195,
            "input_type": "select"
        },
        "dynamic_field_196": {
            "label": "Certificate",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 196,
            "input_type": "select"
        },
        "dynamic_field_197": {
            "label": "Upload",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 197,
            "input_type": "file"
        },
        "dynamic_field_198": {
            "label": "Validity",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 198,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_199": {
            "label": "T&C's",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 199,
            "input_type": "boolean"
        },
        "dynamic_field_200": {
            "label": "T&C's done",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 200,
            "input_type": "select"
        },
        "dynamic_field_204": {
            "label": "date validation 1",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 204,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_205": {
            "label": "date validation 2",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 205,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_206": {
            "label": "new date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 206,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_207": {
            "label": "new date 1",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 207,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_209": {
            "label": "Date hide",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 209,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_210": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 210,
            "input_type": "date",
            "format": "formatted-date"
        },
        "external_staff_providers": {
            "label": "External staff provider",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 213,
            "input_type": "select"
        },
        "framework_contract": {
            "label": "Framework contract",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 221,
            "input_type": "file"
        },
        "framework_contract_expiry_date": {
            "label": "Framework contract expiry date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 222,
            "input_type": "date"
        },
        "framework_contract_start_date": {
            "label": "Framework contract start date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 223,
            "input_type": "date"
        },
        "dynamic_field_225": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 225,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_226": {
            "label": "Mobitrain Group",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 226,
            "input_type": "multi_select"
        },
        "dynamic_field_230": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 230,
            "input_type": "level_select"
        },
        "dynamic_field_231": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 231,
            "input_type": "text"
        },
        "created_at_date": {
            "label": "Created on Date-Time Date",
            "editable": false,
            "description": "The date the employee was created in the system.",
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created on Date-Time Time",
            "editable": false,
            "description": "The date the employee was created in the system.",
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last updated in the system.",
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last updated in the system.",
            "type": "string",
            "format": "time",
            "source": "updated_at"
        },
        "reminded_at_date": {
            "label": "Reminded on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last reminded to complete the recruiting process.",
            "type": "string",
            "format": "date",
            "source": "reminded_at"
        },
        "reminded_at_time": {
            "label": "Reminded on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last reminded to complete the recruiting process.",
            "type": "string",
            "format": "time",
            "source": "reminded_at"
        },
        "last_logged_in_at_date": {
            "label": "Logged in on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last logged in on.",
            "type": "string",
            "format": "date",
            "source": "last_logged_in_at"
        },
        "last_logged_in_at_time": {
            "label": "Logged in on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last logged in on.",
            "type": "string",
            "format": "time",
            "source": "last_logged_in_at"
        },
        "last_active_at_date": {
            "label": "Last active on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last active on.",
            "type": "string",
            "format": "date",
            "source": "last_active_at"
        },
        "last_active_at_time": {
            "label": "Last active on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last active on.",
            "type": "string",
            "format": "time",
            "source": "last_active_at"
        },
        "activated_at_date": {
            "label": "Activated on Date-Time Date",
            "editable": false,
            "description": "The date the employee was activated on.",
            "type": "string",
            "format": "date",
            "source": "activated_at"
        },
        "activated_at_time": {
            "label": "Activated on Date-Time Time",
            "editable": false,
            "description": "The date the employee was activated on.",
            "type": "string",
            "format": "time",
            "source": "activated_at"
        },
        "deactivated_at_date": {
            "label": "Deactivated on Date-Time Date",
            "editable": false,
            "description": "The date the employee was deactivated on.",
            "type": "string",
            "format": "date",
            "source": "deactivated_at"
        },
        "deactivated_at_time": {
            "label": "Deactivated on Date-Time Time",
            "editable": false,
            "description": "The date the employee was deactivated on.",
            "type": "string",
            "format": "time",
            "source": "deactivated_at"
        },
        "password_expires_at_date": {
            "label": "Password expires at Date-Time Date",
            "editable": false,
            "description": "The date when the employee password will expire.",
            "type": "string",
            "format": "date",
            "source": "password_expires_at"
        },
        "password_expires_at_time": {
            "label": "Password expires at Date-Time Time",
            "editable": false,
            "description": "The date when the employee password will expire.",
            "type": "string",
            "format": "time",
            "source": "password_expires_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
status		integer (int)	Status
wage_profile_id		foreignKey (int)	Wage Profile ID
contract_type_id		Collection (int)	Contract Type
employment_type		integer (int)	Employment Type
created_at	`Read Only`	string (date-time)	Created on Date-Time The date the employee was created in the system.
updated_at	`Read Only`	string (date-time)	Updated on Date-Time The date the employee was last updated in the system.
reminded_at	`Read Only`	string (date-time)	Reminded on Date-Time The date the employee was last reminded to complete the recruiting process.
last_logged_in_at	`Read Only`	string (date-time)	Logged in on Date-Time The date the employee was last logged in on.
last_active_at	`Read Only`	string (date-time)	Last active on Date-Time The date the employee was last active on.
activated_at	`Read Only`	string (date-time)	Activated on Date-Time The date the employee was activated on.
deactivated_at	`Read Only`	string (date-time)	Deactivated on Date-Time The date the employee was deactivated on.
password_expires_at	`Read Only`	string (date-time)	Password expires at Date-Time The date when the employee password will expire.
employee_tags	`Read Only`	array (array)	Tags
employee_notes	`Read Only`	string	Employee Notes
firstname	`Dynamic Field`		First name
lastname	`Dynamic Field`		Last name
email	`Dynamic Field`		Email address
mobile	`Dynamic Field`		Mobile number
address_first	`Dynamic Field`		Street
address_second	`Dynamic Field`		Address line 2
zip	`Dynamic Field`		Postcode
city	`Dynamic Field`		City
country	`Dynamic Field`		Country
qualifications	`Dynamic Field`		Qualifications
dynamic_field_26	`Dynamic Field`		Applies for
dynamic_field_27	`Dynamic Field`		How did you hear about us?
dynamic_field_28	`Dynamic Field`	(formatted-number)	Height
dynamic_field_30	`Dynamic Field`		E-Mail Sprache
dynamic_field_31	`Dynamic Field`		Driver
dynamic_field_32	`Dynamic Field`		Car
dynamic_field_33	`Dynamic Field`		Gesundheitszeugnis
dynamic_field_34	`Dynamic Field`		NI Number
dynamic_field_38	`Dynamic Field`		IBAN
dynamic_field_39	`Dynamic Field`		Bank
dynamic_field_41	`Dynamic Field`		Religious denomination
dynamic_field_43	`Dynamic Field`		Driver's licence
birthday	`Dynamic Field`	(formatted-date)	Birthday
dynamic_field_48	`Dynamic Field`		Employment Contract
dynamic_field_49	`Dynamic Field`		Visa
gender	`Dynamic Field`		Gender
dynamic_field_54	`Dynamic Field`
dynamic_field_62	`Dynamic Field`		Document 3
dynamic_field_63	`Dynamic Field`		Photo 1
dynamic_field_66	`Dynamic Field`
dynamic_field_69	`Dynamic Field`		Ich akzeptiere die AGB
dynamic_field_72	`Dynamic Field`		Employment type
dynamic_field_73	`Dynamic Field`	(formatted-date)	Expiry date Student card
dynamic_field_74	`Dynamic Field`	(formatted-number)	DIAS number
dynamic_field_75	`Dynamic Field`		Languages
dynamic_field_76	`Dynamic Field`	(formatted-date)	Date
dynamic_field_77	`Dynamic Field`	(formatted-currency)	Account Balance
dynamic_field_80	`Dynamic Field`		Validatione Grande
dynamic_field_81	`Dynamic Field`
dynamic_field_83	`Dynamic Field`		Afbeelding badge
dynamic_field_84	`Dynamic Field`	(formatted-date)	Datum Badge
dynamic_field_87	`Read Only` `Dynamic Field`	(int)	EMP ID
dynamic_field_90	`Dynamic Field`
dynamic_field_91	`Dynamic Field`		Nationality
dynamic_field_92	`Dynamic Field`
dynamic_field_93	`Dynamic Field`
dynamic_field_94	`Dynamic Field`		T-Shirt size
dynamic_field_95	`Dynamic Field`		Railcard
dynamic_field_97	`Dynamic Field`	(formatted-number)
dynamic_field_98	`Dynamic Field`		Profession
dynamic_field_99	`Dynamic Field`	(formatted-number)	Landline
dynamic_field_100	`Dynamic Field`		Marital status
dynamic_field_101	`Dynamic Field`		Work team
dynamic_field_102	`Dynamic Field`		Visible tattoos?
dynamic_field_103	`Dynamic Field`		Trouser size
dynamic_field_104	`Dynamic Field`		CV
dynamic_field_107	`Dynamic Field`		Assignments
dynamic_field_108	`Dynamic Field`		Other languages
dynamic_field_111	`Dynamic Field`		Collectionfield
dynamic_field_114	`Dynamic Field`		Remarks
dynamic_field_115	`Dynamic Field`		Driving Licence Copy
dynamic_field_118	`Dynamic Field`
dynamic_field_119	`Dynamic Field`
dynamic_field_120	`Dynamic Field`		Preferred locations
dynamic_field_130	`Dynamic Field`
dynamic_field_131	`Dynamic Field`
dynamic_field_132	`Dynamic Field`
dynamic_field_134	`Dynamic Field`		This is a checkbox
dynamic_field_135	`Dynamic Field`	(formatted-date)	Date
dynamic_field_136	`Dynamic Field`		Lieblingsfarbe
dynamic_field_137	`Dynamic Field`	(formatted-datetime)
dynamic_field_138	`Dynamic Field`		decimal
dynamic_field_139	`Dynamic Field`
dynamic_field_140	`Dynamic Field`	(formatted-time)
dynamic_field_141	`Dynamic Field`
dynamic_field_145	`Dynamic Field`		[missing translation]
dynamic_field_146	`Dynamic Field`		[missing translation]
communication_language	`Dynamic Field`		Communication language
dynamic_field_155	`Dynamic Field`		[missing translation]
dynamic_field_156	`Dynamic Field`		Nachtschicht
dynamic_field_158	`Dynamic Field`		[missing translation]
dynamic_field_159	`Dynamic Field`		[missing translation]
dynamic_field_160	`Dynamic Field`	(formatted-currency)	[missing translation]
dynamic_field_164	`Dynamic Field`		Shoes
dynamic_field_172	`Dynamic Field`		Work location
dynamic_field_179	`Dynamic Field`		Timesheet
dynamic_field_180	`Dynamic Field`		Pension Insurance
dynamic_field_183	`Dynamic Field`		[missing translation]
dynamic_field_184	`Dynamic Field`	(formatted-date)	Contractual period
dynamic_field_186	`Dynamic Field`		Additional data needed
dynamic_field_189	`Dynamic Field`		Technologies
dynamic_field_191	`Dynamic Field`		Safety shoes
dynamic_field_192	`Dynamic Field`	(formatted-datetime)	[missing translation]
dynamic_field_193	`Dynamic Field`		County
dynamic_field_195	`Dynamic Field`		Status before employment
dynamic_field_196	`Dynamic Field`		Certificate
dynamic_field_197	`Dynamic Field`		Upload
dynamic_field_198	`Dynamic Field`	(formatted-date)	Validity
dynamic_field_199	`Dynamic Field`		T&C's
dynamic_field_200	`Dynamic Field`		T&C's done
dynamic_field_204	`Dynamic Field`	(formatted-datetime)	date validation 1
dynamic_field_205	`Dynamic Field`	(formatted-datetime)	date validation 2
dynamic_field_206	`Dynamic Field`	(formatted-date)	new date
dynamic_field_207	`Dynamic Field`	(formatted-date)	new date 1
dynamic_field_209	`Dynamic Field`	(formatted-date)	Date hide
dynamic_field_210	`Dynamic Field`	(formatted-date)	[missing translation]
external_staff_providers	`Dynamic Field`		External staff provider
framework_contract	`Dynamic Field`		Framework contract
framework_contract_expiry_date	`Dynamic Field`		Framework contract expiry date
framework_contract_start_date	`Dynamic Field`		Framework contract start date
dynamic_field_225	`Dynamic Field`	(formatted-date)	[missing translation]
dynamic_field_226	`Dynamic Field`		Mobitrain Group
dynamic_field_230	`Dynamic Field`		[missing translation]
dynamic_field_231	`Dynamic Field`		[missing translation]
created_at_date	`Read Only`	string (date)	Created on Date-Time Date The date the employee was created in the system.
created_at_time	`Read Only`	string (time)	Created on Date-Time Time The date the employee was created in the system.
updated_at_date	`Read Only`	string (date)	Updated on Date-Time Date The date the employee was last updated in the system.
updated_at_time	`Read Only`	string (time)	Updated on Date-Time Time The date the employee was last updated in the system.
reminded_at_date	`Read Only`	string (date)	Reminded on Date-Time Date The date the employee was last reminded to complete the recruiting process.
reminded_at_time	`Read Only`	string (time)	Reminded on Date-Time Time The date the employee was last reminded to complete the recruiting process.
last_logged_in_at_date	`Read Only`	string (date)	Logged in on Date-Time Date The date the employee was last logged in on.
last_logged_in_at_time	`Read Only`	string (time)	Logged in on Date-Time Time The date the employee was last logged in on.
last_active_at_date	`Read Only`	string (date)	Last active on Date-Time Date The date the employee was last active on.
last_active_at_time	`Read Only`	string (time)	Last active on Date-Time Time The date the employee was last active on.
activated_at_date	`Read Only`	string (date)	Activated on Date-Time Date The date the employee was activated on.
activated_at_time	`Read Only`	string (time)	Activated on Date-Time Time The date the employee was activated on.
deactivated_at_date	`Read Only`	string (date)	Deactivated on Date-Time Date The date the employee was deactivated on.
deactivated_at_time	`Read Only`	string (time)	Deactivated on Date-Time Time The date the employee was deactivated on.
password_expires_at_date	`Read Only`	string (date)	Password expires at Date-Time Date The date when the employee password will expire.
password_expires_at_time	`Read Only`	string (time)	Password expires at Date-Time Time The date when the employee password will expire.

Relations

Name	Resource	Foreign Key	Description
employeePictures	employee-pictures	employee-pictures.employee_id
employeeBusyDates	busy-dates	busy-dates.employee_id
employeeAssignments	assignments	assignments.employee_id
employeeWageProfile	wage-profiles	employees.wage_profile_id	Base wage profile of the employee
employeeWorkQuotaProfiles	work-quota-profiles	work-quota-profiles.employee_id
employeeTeams	employee-teams	employee-teams.employee_id
availability-requests	availability-requests	availability-requests.employee_id
availabilities	availability-requests-availabilities	availability-requests-availabilities.employee_id
employeeAvailability	employee-availability	employee-availability.employee_id
employeeRatings	ratings	ratings.employee_id
payslips	payslips	payslips.employee_id
employeeNotes	employee-notes	employee-notes.employee_id

Actions

Request	Description
`GET /employees`	Resource listing
`GET /employees/<id>`	Resource read
`POST /employees`	Resource create
`PUT /employees/<id>`	Resource update
`DELETE /employees/<id>`	Resource delete Note: this action is deprecated. In order to mark an employee as deleted or inactive you can use `PUT /employees/<id>/state/<statusId>` action where `statusId` can be `5` for inactive, or `6` for deleted
`GET /employees/<id>/active`	Get all active employees.
`PUT /employees/<id>/state`	Set the state of an employee.
`PUT /employees/<id>/forms`
`GET /employees/<id>/forms`	Get employee rendered through a given form.

Event functions

Schema

Event-functions schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "code": {
            "label": "Code",
            "editable": true,
            "type": "string"
        },
        "description": {
            "label": "Description",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "quantity": {
            "label": "Quantity",
            "editable": true,
            "type": "integer",
            "format": "int"
        },
        "event_id": {
            "label": "Event ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "function_id": {
            "label": "Function ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "location_id": {
            "label": "Inherited location ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int"
        },
        "eventFunction.location_id": {
            "label": "Location ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int"
        },
        "wage_profile_id": {
            "label": "Location ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int"
        },
        "project_shift_id": {
            "label": "Shift ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int"
        },
        "shift_name": {
            "label": "Shift Name",
            "editable": true
        },
        "start": {
            "label": "Start Date-Time",
            "editable": true,
            "format": "date-time"
        },
        "end": {
            "label": "End Date-Time",
            "editable": true,
            "format": "date-time"
        },
        "break_start": {
            "label": "Break Start Date-Time",
            "editable": true,
            "format": "date-time"
        },
        "break_end": {
            "label": "Break End Date-Time",
            "editable": true,
            "format": "date-time"
        },
        "is_locked": {
            "label": "Is locked",
            "editable": false,
            "type": "int",
            "format": "bool"
        },
        "is_private": {
            "label": "Is private",
            "editable": false,
            "type": "int",
            "format": "bool"
        },
        "is_transition_locked": {
            "label": "Is locked while changing states",
            "editable": false,
            "type": "int",
            "format": "bool",
            "description": "This field is deprecated. Please use transition_locked_at instead."
        },
        "transition_locked_at": {
            "label": "Transition Locked Date-Time",
            "editable": false,
            "format": "date-time"
        },
        "planner_id": {
            "label": "Planner ID",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "start_date": {
            "label": "Start Date-Time Date",
            "editable": true,
            "format": "date",
            "source": "start"
        },
        "start_time": {
            "label": "Start Date-Time Time",
            "editable": true,
            "format": "time",
            "source": "start"
        },
        "end_date": {
            "label": "End Date-Time Date",
            "editable": true,
            "format": "date",
            "source": "end"
        },
        "end_time": {
            "label": "End Date-Time Time",
            "editable": true,
            "format": "time",
            "source": "end"
        },
        "break_start_date": {
            "label": "Break Start Date-Time Date",
            "editable": true,
            "format": "date",
            "source": "break_start"
        },
        "break_start_time": {
            "label": "Break Start Date-Time Time",
            "editable": true,
            "format": "time",
            "source": "break_start"
        },
        "break_end_date": {
            "label": "Break End Date-Time Date",
            "editable": true,
            "format": "date",
            "source": "break_end"
        },
        "break_end_time": {
            "label": "Break End Date-Time Time",
            "editable": true,
            "format": "time",
            "source": "break_end"
        },
        "transition_locked_at_date": {
            "label": "Transition Locked Date-Time Date",
            "editable": false,
            "format": "date",
            "source": "transition_locked_at"
        },
        "transition_locked_at_time": {
            "label": "Transition Locked Date-Time Time",
            "editable": false,
            "format": "time",
            "source": "transition_locked_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
code		string	Code
description		string (string)	Description
quantity		integer (int)	Quantity
event_id	`Read Only`	foreignKey (int)	Event ID
function_id	`Read Only`	foreignKey (int)	Function ID
location_id		foreignKey (int)	Inherited location ID
eventFunction.location_id		foreignKey (int)	Location ID
wage_profile_id		foreignKey (int)	Location ID
project_shift_id		foreignKey (int)	Shift ID
shift_name			Shift Name
start		(date-time)	Start Date-Time
end		(date-time)	End Date-Time
break_start		(date-time)	Break Start Date-Time
break_end		(date-time)	Break End Date-Time
is_locked	`Read Only`	int (bool)	Is locked
is_private	`Read Only`	int (bool)	Is private
is_transition_locked	`Read Only`	int (bool)	Is locked while changing states This field is deprecated. Please use transition_locked_at instead.
transition_locked_at	`Read Only`	(date-time)	Transition Locked Date-Time
planner_id		foreignKey (int)	Planner ID
start_date		(date)	Start Date-Time Date
start_time		(time)	Start Date-Time Time
end_date		(date)	End Date-Time Date
end_time		(time)	End Date-Time Time
break_start_date		(date)	Break Start Date-Time Date
break_start_time		(time)	Break Start Date-Time Time
break_end_date		(date)	Break End Date-Time Date
break_end_time		(time)	Break End Date-Time Time
transition_locked_at_date	`Read Only`	(date)	Transition Locked Date-Time Date
transition_locked_at_time	`Read Only`	(time)	Transition Locked Date-Time Time

Relations

Name	Resource	Foreign Key
functionEvent	events	event-functions.event_id
eventFunctionAssignments	assignments	assignments.event_function_id
location	locations	event-functions.location_id
function	functions	event-functions.function_id

Actions

Request	Description
`GET /event-functions`	Resource listing
`GET /event-functions/<id>`	Resource read
`POST /event-functions`	Resource create
`PUT /event-functions/<id>`	Resource update
`DELETE /event-functions/<id>`	Resource delete

Events

This resource uses dynamic fields.

Schema

Events schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "project_id": {
            "label": "Project ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "location_id": {
            "label": "Location ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "client_id": {
            "label": "Client ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "contact_id": {
            "label": "Contact ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "event.client_id": {
            "label": "Client ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int",
            "description": "This field is deprecated. Please use client_id instead."
        },
        "event.contact_id": {
            "label": "Contact ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int",
            "description": "This field is deprecated. Please use contact_id instead."
        },
        "status": {
            "label": "Status",
            "editable": false,
            "type": "integer",
            "enum": [
                1,
                2,
                3,
                5
            ],
            "valueMapping": {
                "1": "Draft",
                "2": "Active",
                "3": "Archived",
                "5": "Aborted"
            }
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "start": {
            "label": "Start Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "end": {
            "label": "End Date-Time",
            "editable": false,
            "format": "date-time"
        },
        "break_start": {
            "label": "Break Start Date-Time",
            "editable": false,
            "format": "date-time"
        },
        "break_end": {
            "label": "Break End Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "format": "date-time"
        },
        "project_name": {
            "label": "Project",
            "editable": false,
            "type": "string"
        },
        "event_tags": {
            "label": "Tags",
            "editable": false,
            "type": "array",
            "format": "array"
        },
        "dynamic_field_60": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 60,
            "input_type": "file"
        },
        "dynamic_field_61": {
            "label": "File upload",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 61,
            "input_type": "file"
        },
        "dynamic_field_67": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 67,
            "input_type": "multi_select"
        },
        "dynamic_field_78": {
            "label": "Auto",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 78,
            "input_type": "select"
        },
        "dynamic_field_82": {
            "label": "Bitte mitbringen",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 82,
            "input_type": "multi_select"
        },
        "dynamic_field_89": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 89,
            "input_type": "wysiwyg"
        },
        "dynamic_field_105": {
            "label": "Expenses paid",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 105,
            "input_type": "multi_select"
        },
        "dynamic_field_112": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 112,
            "input_type": "text"
        },
        "dynamic_field_116": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 116,
            "input_type": "multi_select"
        },
        "dynamic_field_127": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 127,
            "input_type": "select"
        },
        "dynamic_field_147": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 147,
            "input_type": "money",
            "format": "formatted-currency"
        },
        "dynamic_field_157": {
            "label": "Offerte",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 157,
            "input_type": "select"
        },
        "dynamic_field_168": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 168,
            "input_type": "text_area"
        },
        "dynamic_field_178": {
            "label": "[missing translation]",
            "description": "",
            "editable": false,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 178,
            "input_type": "index",
            "format": "int"
        },
        "dynamic_field_187": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 187,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_188": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 188,
            "input_type": "money",
            "format": "formatted-currency"
        },
        "start_date": {
            "label": "Start Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "start"
        },
        "start_time": {
            "label": "Start Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "start"
        },
        "end_date": {
            "label": "End Date-Time Date",
            "editable": false,
            "format": "date",
            "source": "end"
        },
        "end_time": {
            "label": "End Date-Time Time",
            "editable": false,
            "format": "time",
            "source": "end"
        },
        "break_start_date": {
            "label": "Break Start Date-Time Date",
            "editable": false,
            "format": "date",
            "source": "break_start"
        },
        "break_start_time": {
            "label": "Break Start Date-Time Time",
            "editable": false,
            "format": "time",
            "source": "break_start"
        },
        "break_end_date": {
            "label": "Break End Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "break_end"
        },
        "break_end_time": {
            "label": "Break End Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "break_end"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
planner_id	`Read Only`	foreignKey (int)	Planner Id
project_id	`Read Only`	foreignKey (int)	Project ID
location_id	`Read Only`	foreignKey (int)	Location ID
client_id	`Read Only`	foreignKey (int)	Client ID
contact_id	`Read Only`	foreignKey (int)	Contact ID
event.client_id	`Read Only`	foreignKey (int)	Client ID This field is deprecated. Please use client_id instead.
event.contact_id	`Read Only`	foreignKey (int)	Contact ID This field is deprecated. Please use contact_id instead.
status	`Read Only`	integer	Status
name	`Read Only`	string (string)	Name
start	`Read Only`	string (date-time)	Start Date-Time
end	`Read Only`	(date-time)	End Date-Time
break_start	`Read Only`	(date-time)	Break Start Date-Time
break_end	`Read Only`	string (date-time)	Break End Date-Time
created_at	`Read Only`	string (date-time)	Created Date-Time
updated_at	`Read Only`	(date-time)	Updated Date-Time
project_name	`Read Only`	string	Project
event_tags	`Read Only`	array (array)	Tags
dynamic_field_60	`Dynamic Field`
dynamic_field_61	`Dynamic Field`		File upload
dynamic_field_67	`Dynamic Field`
dynamic_field_78	`Dynamic Field`		Auto
dynamic_field_82	`Dynamic Field`		Bitte mitbringen
dynamic_field_89	`Dynamic Field`
dynamic_field_105	`Dynamic Field`		Expenses paid
dynamic_field_112	`Dynamic Field`		[missing translation]
dynamic_field_116	`Dynamic Field`
dynamic_field_127	`Dynamic Field`
dynamic_field_147	`Dynamic Field`	(formatted-currency)	[missing translation]
dynamic_field_157	`Dynamic Field`		Offerte
dynamic_field_168	`Dynamic Field`		[missing translation]
dynamic_field_178	`Read Only` `Dynamic Field`	(int)	[missing translation]
dynamic_field_187	`Dynamic Field`	(formatted-number)	[missing translation]
dynamic_field_188	`Dynamic Field`	(formatted-currency)	[missing translation]
start_date	`Read Only`	string (date)	Start Date-Time Date
start_time	`Read Only`	string (time)	Start Date-Time Time
end_date	`Read Only`	(date)	End Date-Time Date
end_time	`Read Only`	(time)	End Date-Time Time
break_start_date	`Read Only`	(date)	Break Start Date-Time Date
break_start_time	`Read Only`	(time)	Break Start Date-Time Time
break_end_date	`Read Only`	string (date)	Break End Date-Time Date
break_end_time	`Read Only`	string (time)	Break End Date-Time Time
created_at_date	`Read Only`	string (date)	Created Date-Time Date
created_at_time	`Read Only`	string (time)	Created Date-Time Time
updated_at_date	`Read Only`	(date)	Updated Date-Time Date
updated_at_time	`Read Only`	(time)	Updated Date-Time Time

Relations

Name	Resource	Foreign Key	Description
eventProject	projects	events.project_id
eventFunctions	event-functions	event-functions.event_id
eventClient	clients	events.client_id
eventContact	contacts	events.contact_id
eventAssignments	assignments	assignments.event_id
eventPlanner	planners	events.planner_id	Planner of the event.
eventLocation	locations	events.location_id	Location of the event.

Actions

Request	Description
`GET /events`	Resource listing
`GET /events/<id>`	Resource read
`POST /events`	Resource create
`PUT /events/<id>`	Resource update
`DELETE /events/<id>`	Resource delete
`GET /events/<id>/forms`	Get event rendered through a given form.
`GET /events/<id>/reporting-forms`	Get reporting forms attached to a particular event.
`GET /events/<id>/reporting-forms`	Get reporting forms for indicated / all events

External staff providers

This resource uses dynamic fields.

Schema

External-staff-providers schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "relation_id": {
            "label": "Relation ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "status": {
            "label": "Status",
            "editable": true,
            "type": "integer",
            "enum": [
                1,
                2,
                3
            ],
            "format": "int",
            "valueMapping": {
                "1": "Active",
                "2": "Inactive",
                "3": "Deleted"
            }
        },
        "external_staff_provider_name": {
            "label": "Provider name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 214,
            "input_type": "text"
        },
        "external_staff_provider_id": {
            "label": "Provider external ID",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 215,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_216": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 216,
            "input_type": "text"
        },
        "email": {
            "label": "E-mail",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 217,
            "input_type": "email"
        },
        "mobile": {
            "label": "Mobile",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 218,
            "input_type": "phone"
        },
        "city": {
            "label": "City",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 219,
            "input_type": "text"
        },
        "staff_provider_address": {
            "label": "Address",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 220,
            "input_type": "text"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
relation_id	`Read Only`	foreignKey (int)	Relation ID
status		integer (int)	Status
external_staff_provider_name	`Dynamic Field`		Provider name
external_staff_provider_id	`Dynamic Field`	(formatted-number)	Provider external ID
dynamic_field_216	`Dynamic Field`		[missing translation]
email	`Dynamic Field`		E-mail
mobile	`Dynamic Field`		Mobile
city	`Dynamic Field`		City
staff_provider_address	`Dynamic Field`		Address

Actions

Request	Description
`GET /external-staff-providers`	Resource listing
`GET /external-staff-providers/<id>`	Resource read
`POST /external-staff-providers`	Resource create
`PUT /external-staff-providers/<id>`	Resource update
`DELETE /external-staff-providers/<id>`	Resource delete

External staff requests

Schema

External-staff-requests schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "event_function_id": {
            "label": "Event Function Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "external_staff_provider_id": {
            "label": "External Staff Provider Id",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "external_worker_id": {
            "label": "External Worker Id",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "assignment_id": {
            "label": "Assignment Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "managed_by": {
            "label": "Provider Service",
            "description": "This is a text identifier of the service that is managing the request. This is used to determine the service that is responsible for the request. If you are building a dedicated staffcloud integration that manages external staff requests please consistently set this value to your system identifier. Can be ignored in all other cases.",
            "editable": true,
            "type": "string",
            "format": "string",
            "enum": [
                "staffcloud",
                "external",
                "tempcloud",
                "adia"
            ]
        },
        "state": {
            "label": "State",
            "description": "This is the internal state of the request. This has implications in the logic of the system and determines the state indicators that are shown in the UI.",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "status": {
            "label": "External Status",
            "description": "This can be any string representing the corresponding status in the external system. Is only informational and not used for any logic.",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "status_message": {
            "label": "External Status Message",
            "description": "A message detailing the status. Can be an error message in the case of an error status or a success message in the case of a success status.",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "link": {
            "label": "External URL",
            "description": "A url to the external system if one exists. The user will be able to click a link with this url to navigate to the external system managing the request.",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "remarks": {
            "label": "External Remarks",
            "description": "Any text remarks relating to the request. The Staffcloud user will be able to see these in the UI",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "attributes": {
            "label": "Attributes",
            "description": "This is a json object that can be used to store any additional data that is not covered by the other fields.",
            "editable": true,
            "type": "string",
            "format": "json"
        },
        "last_status_update_at": {
            "label": "Last Status Update Date-Time",
            "editable": false,
            "format": "date-time"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "format": "date-time"
        },
        "last_status_update_at_date": {
            "label": "Last Status Update Date-Time Date",
            "editable": false,
            "format": "date",
            "source": "last_status_update_at"
        },
        "last_status_update_at_time": {
            "label": "Last Status Update Date-Time Time",
            "editable": false,
            "format": "time",
            "source": "last_status_update_at"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
event_function_id	`Read Only`	foreignKey (int)	Event Function Id
external_staff_provider_id		foreignKey (int)	External Staff Provider Id
external_worker_id		foreignKey (int)	External Worker Id
assignment_id	`Read Only`	foreignKey (int)	Assignment Id
managed_by		string (string)	Provider Service This is a text identifier of the service that is managing the request. This is used to determine the service that is responsible for the request. If you are building a dedicated staffcloud integration that manages external staff requests please consistently set this value to your system identifier. Can be ignored in all other cases.
state		string (string)	State This is the internal state of the request. This has implications in the logic of the system and determines the state indicators that are shown in the UI.
status		string (string)	External Status This can be any string representing the corresponding status in the external system. Is only informational and not used for any logic.
status_message		string (string)	External Status Message A message detailing the status. Can be an error message in the case of an error status or a success message in the case of a success status.
link		string (string)	External URL A url to the external system if one exists. The user will be able to click a link with this url to navigate to the external system managing the request.
remarks		string (string)	External Remarks Any text remarks relating to the request. The Staffcloud user will be able to see these in the UI
attributes		string (json)	Attributes This is a json object that can be used to store any additional data that is not covered by the other fields.
last_status_update_at	`Read Only`	(date-time)	Last Status Update Date-Time
created_at	`Read Only`	(date-time)	Created Date-Time
updated_at	`Read Only`	(date-time)	Updated Date-Time
last_status_update_at_date	`Read Only`	(date)	Last Status Update Date-Time Date
last_status_update_at_time	`Read Only`	(time)	Last Status Update Date-Time Time
created_at_date	`Read Only`	(date)	Created Date-Time Date
created_at_time	`Read Only`	(time)	Created Date-Time Time
updated_at_date	`Read Only`	(date)	Updated Date-Time Date
updated_at_time	`Read Only`	(time)	Updated Date-Time Time

Relations

Name	Resource	Foreign Key	Description
eventFunction	event-functions	external-staff-requests.event_function_id
assignment	assignments	external-staff-requests.assignment_id

Actions

Request	Description
`GET /external-staff-requests`	Resource listing
`GET /external-staff-requests/<id>`	Resource read
`POST /external-staff-requests`	Resource create
`PUT /external-staff-requests/<id>`	Resource update
`DELETE /external-staff-requests/<id>`	Resource delete

External workers

This resource uses dynamic fields.

Schema

External-workers schema

{
    "properties": {
        "id": {
            "label": "ID",
            "type": "identityField",
            "format": "int",
            "editable": false
        },
        "status": {
            "label": "Status",
            "type": "integer",
            "editable": true,
            "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6
            ],
            "valueMapping": [
                "Uncompleted",
                "Applicant",
                "Provisional candidate",
                "Candidate",
                "Active",
                "Inactive",
                "Deleted"
            ],
            "format": "int"
        },
        "wage_profile_id": {
            "label": "Wage Profile ID",
            "type": "foreignKey",
            "editable": true,
            "format": "int"
        },
        "created_at": {
            "label": "Created on Date-Time",
            "editable": false,
            "description": "The date the employee was created in the system.",
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated on Date-Time",
            "editable": false,
            "description": "The date the employee was last updated in the system.",
            "type": "string",
            "format": "date-time"
        },
        "reminded_at": {
            "label": "Reminded on Date-Time",
            "editable": false,
            "description": "The date the employee was last reminded to complete the recruiting process.",
            "type": "string",
            "format": "date-time"
        },
        "last_logged_in_at": {
            "label": "Logged in on Date-Time",
            "editable": false,
            "description": "The date the employee was last logged in on.",
            "type": "string",
            "format": "date-time"
        },
        "last_active_at": {
            "label": "Last active on Date-Time",
            "editable": false,
            "description": "The date the employee was last active on.",
            "type": "string",
            "format": "date-time"
        },
        "activated_at": {
            "label": "Activated on Date-Time",
            "editable": false,
            "description": "The date the employee was activated on.",
            "type": "string",
            "format": "date-time"
        },
        "deactivated_at": {
            "label": "Deactivated on Date-Time",
            "editable": false,
            "description": "The date the employee was deactivated on.",
            "type": "string",
            "format": "date-time"
        },
        "password_expires_at": {
            "label": "Password expires at Date-Time",
            "editable": false,
            "description": "The date when the employee password will expire.",
            "type": "string",
            "format": "date-time"
        },
        "firstname": {
            "label": "First name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 1,
            "input_type": "text"
        },
        "lastname": {
            "label": "Last name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 2,
            "input_type": "text"
        },
        "email": {
            "label": "Email address",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 3,
            "input_type": "email"
        },
        "mobile": {
            "label": "Mobile number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 4,
            "input_type": "phone"
        },
        "address_first": {
            "label": "Street ",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 5,
            "input_type": "text"
        },
        "address_second": {
            "label": "Address line 2",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 6,
            "input_type": "text"
        },
        "zip": {
            "label": "Postcode",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 7,
            "input_type": "text"
        },
        "city": {
            "label": "City",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 8,
            "input_type": "text"
        },
        "country": {
            "label": "Country",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 9,
            "input_type": "select"
        },
        "qualifications": {
            "label": "Qualifications",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 10,
            "input_type": "multi_select"
        },
        "dynamic_field_26": {
            "label": "Applies for",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 26,
            "input_type": "select"
        },
        "dynamic_field_27": {
            "label": "How did you hear about us?",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 27,
            "input_type": "multi_select"
        },
        "dynamic_field_28": {
            "label": "Height",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 28,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_30": {
            "label": "E-Mail Sprache",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 30,
            "input_type": "select"
        },
        "dynamic_field_31": {
            "label": "Driver",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 31,
            "input_type": "select"
        },
        "dynamic_field_32": {
            "label": "Car",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 32,
            "input_type": "select"
        },
        "dynamic_field_33": {
            "label": "Gesundheitszeugnis",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 33,
            "input_type": "select"
        },
        "dynamic_field_34": {
            "label": "NI Number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 34,
            "input_type": "text"
        },
        "dynamic_field_38": {
            "label": "IBAN",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 38,
            "input_type": "text"
        },
        "dynamic_field_39": {
            "label": "Bank",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 39,
            "input_type": "text"
        },
        "dynamic_field_41": {
            "label": "Religious denomination",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 41,
            "input_type": "select"
        },
        "dynamic_field_43": {
            "label": "Driver's licence",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 43,
            "input_type": "multi_select"
        },
        "birthday": {
            "label": "Birthday",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 47,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_48": {
            "label": "Employment Contract",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 48,
            "input_type": "file"
        },
        "dynamic_field_49": {
            "label": "Visa",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 49,
            "input_type": "file"
        },
        "gender": {
            "label": "Gender",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 51,
            "input_type": "select"
        },
        "dynamic_field_54": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 54,
            "input_type": "file"
        },
        "dynamic_field_62": {
            "label": "Document 3",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 62,
            "input_type": "file"
        },
        "dynamic_field_63": {
            "label": "Photo 1",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 63,
            "input_type": "file"
        },
        "dynamic_field_66": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 66,
            "input_type": "level_select"
        },
        "dynamic_field_69": {
            "label": "Ich akzeptiere die AGB",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 69,
            "input_type": "boolean"
        },
        "dynamic_field_72": {
            "label": "Employment type",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 72,
            "input_type": "select"
        },
        "dynamic_field_73": {
            "label": "Expiry date Student card",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 73,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_74": {
            "label": "DIAS number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 74,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_75": {
            "label": "Languages",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 75,
            "input_type": "level_select"
        },
        "dynamic_field_76": {
            "label": "Date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 76,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_77": {
            "label": "Account Balance",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 77,
            "input_type": "money",
            "format": "formatted-currency"
        },
        "dynamic_field_80": {
            "label": "Validatione Grande",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 80,
            "input_type": "text"
        },
        "dynamic_field_81": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 81,
            "input_type": "file"
        },
        "dynamic_field_83": {
            "label": "Afbeelding badge",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 83,
            "input_type": "file"
        },
        "dynamic_field_84": {
            "label": "Datum Badge",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 84,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_87": {
            "label": "EMP ID",
            "description": "",
            "editable": false,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 87,
            "input_type": "index",
            "format": "int"
        },
        "dynamic_field_90": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 90,
            "input_type": "wysiwyg"
        },
        "dynamic_field_91": {
            "label": "Nationality",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 91,
            "input_type": "select"
        },
        "dynamic_field_92": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 92,
            "input_type": "boolean"
        },
        "dynamic_field_93": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 93,
            "input_type": "boolean"
        },
        "dynamic_field_94": {
            "label": "T-Shirt size",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 94,
            "input_type": "select"
        },
        "dynamic_field_95": {
            "label": "Railcard",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 95,
            "input_type": "select"
        },
        "dynamic_field_97": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 97,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_98": {
            "label": "Profession",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 98,
            "input_type": "text"
        },
        "dynamic_field_99": {
            "label": "Landline",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 99,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_100": {
            "label": "Marital status",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 100,
            "input_type": "select"
        },
        "dynamic_field_101": {
            "label": "Work team",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 101,
            "input_type": "multi_select"
        },
        "dynamic_field_102": {
            "label": "Visible tattoos?",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 102,
            "input_type": "select"
        },
        "dynamic_field_103": {
            "label": "Trouser size",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 103,
            "input_type": "select"
        },
        "dynamic_field_104": {
            "label": "CV",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 104,
            "input_type": "file"
        },
        "dynamic_field_107": {
            "label": "Assignments",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 107,
            "input_type": "select"
        },
        "dynamic_field_108": {
            "label": "Other languages",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 108,
            "input_type": "text_area"
        },
        "dynamic_field_111": {
            "label": "Collectionfield",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 111,
            "input_type": "select"
        },
        "dynamic_field_114": {
            "label": "Remarks",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 114,
            "input_type": "text_area"
        },
        "dynamic_field_115": {
            "label": "Driving Licence Copy",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 115,
            "input_type": "file"
        },
        "dynamic_field_118": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 118,
            "input_type": "text"
        },
        "dynamic_field_119": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 119,
            "input_type": "select"
        },
        "dynamic_field_120": {
            "label": "Preferred locations",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 120,
            "input_type": "multi_select"
        },
        "dynamic_field_130": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 130,
            "input_type": "multi_select"
        },
        "dynamic_field_131": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 131,
            "input_type": "select"
        },
        "dynamic_field_132": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 132,
            "input_type": "url"
        },
        "dynamic_field_134": {
            "label": "This is a checkbox",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 134,
            "input_type": "boolean"
        },
        "dynamic_field_135": {
            "label": "Date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 135,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_136": {
            "label": "Lieblingsfarbe",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 136,
            "input_type": "color"
        },
        "dynamic_field_137": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 137,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_138": {
            "label": "decimal",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 138,
            "input_type": "decimal"
        },
        "dynamic_field_139": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 139,
            "input_type": "url"
        },
        "dynamic_field_140": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 140,
            "input_type": "time",
            "format": "formatted-time"
        },
        "dynamic_field_141": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 141,
            "input_type": "text"
        },
        "dynamic_field_145": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 145,
            "input_type": "select"
        },
        "dynamic_field_146": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 146,
            "input_type": "text"
        },
        "communication_language": {
            "label": "Communication language",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 148,
            "input_type": "select"
        },
        "dynamic_field_155": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 155,
            "input_type": "multi_select"
        },
        "dynamic_field_156": {
            "label": "Nachtschicht",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 156,
            "input_type": "select"
        },
        "dynamic_field_158": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 158,
            "input_type": "select"
        },
        "dynamic_field_159": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 159,
            "input_type": "multi_select"
        },
        "dynamic_field_160": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 160,
            "input_type": "money",
            "format": "formatted-currency"
        },
        "dynamic_field_164": {
            "label": "Shoes",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 164,
            "input_type": "color"
        },
        "dynamic_field_172": {
            "label": "Work location",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 172,
            "input_type": "select"
        },
        "dynamic_field_179": {
            "label": "Timesheet",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 179,
            "input_type": "file"
        },
        "dynamic_field_180": {
            "label": "Pension Insurance",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 180,
            "input_type": "file"
        },
        "dynamic_field_183": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 183,
            "input_type": "boolean"
        },
        "dynamic_field_184": {
            "label": "Contractual period",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 184,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_186": {
            "label": "Additional data needed",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 186,
            "input_type": "wysiwyg"
        },
        "dynamic_field_189": {
            "label": "Technologies",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 189,
            "input_type": "level_select"
        },
        "dynamic_field_191": {
            "label": "Safety shoes",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 191,
            "input_type": "select"
        },
        "dynamic_field_192": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 192,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_193": {
            "label": "County",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 193,
            "input_type": "select"
        },
        "dynamic_field_195": {
            "label": "Status before employment",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 195,
            "input_type": "select"
        },
        "dynamic_field_196": {
            "label": "Certificate",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 196,
            "input_type": "select"
        },
        "dynamic_field_197": {
            "label": "Upload",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 197,
            "input_type": "file"
        },
        "dynamic_field_198": {
            "label": "Validity",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 198,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_199": {
            "label": "T&C's",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 199,
            "input_type": "boolean"
        },
        "dynamic_field_200": {
            "label": "T&C's done",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 200,
            "input_type": "select"
        },
        "dynamic_field_204": {
            "label": "date validation 1",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 204,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_205": {
            "label": "date validation 2",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 205,
            "input_type": "datetime",
            "format": "formatted-datetime"
        },
        "dynamic_field_206": {
            "label": "new date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 206,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_207": {
            "label": "new date 1",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 207,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_209": {
            "label": "Date hide",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 209,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_210": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 210,
            "input_type": "date",
            "format": "formatted-date"
        },
        "external_staff_providers": {
            "label": "External staff provider",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 213,
            "input_type": "select"
        },
        "framework_contract": {
            "label": "Framework contract",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 221,
            "input_type": "file"
        },
        "framework_contract_expiry_date": {
            "label": "Framework contract expiry date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 222,
            "input_type": "date"
        },
        "framework_contract_start_date": {
            "label": "Framework contract start date",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 223,
            "input_type": "date"
        },
        "dynamic_field_225": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 225,
            "input_type": "date",
            "format": "formatted-date"
        },
        "dynamic_field_226": {
            "label": "Mobitrain Group",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 226,
            "input_type": "multi_select"
        },
        "dynamic_field_230": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 230,
            "input_type": "level_select"
        },
        "dynamic_field_231": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 231,
            "input_type": "text"
        },
        "created_at_date": {
            "label": "Created on Date-Time Date",
            "editable": false,
            "description": "The date the employee was created in the system.",
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created on Date-Time Time",
            "editable": false,
            "description": "The date the employee was created in the system.",
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last updated in the system.",
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last updated in the system.",
            "type": "string",
            "format": "time",
            "source": "updated_at"
        },
        "reminded_at_date": {
            "label": "Reminded on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last reminded to complete the recruiting process.",
            "type": "string",
            "format": "date",
            "source": "reminded_at"
        },
        "reminded_at_time": {
            "label": "Reminded on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last reminded to complete the recruiting process.",
            "type": "string",
            "format": "time",
            "source": "reminded_at"
        },
        "last_logged_in_at_date": {
            "label": "Logged in on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last logged in on.",
            "type": "string",
            "format": "date",
            "source": "last_logged_in_at"
        },
        "last_logged_in_at_time": {
            "label": "Logged in on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last logged in on.",
            "type": "string",
            "format": "time",
            "source": "last_logged_in_at"
        },
        "last_active_at_date": {
            "label": "Last active on Date-Time Date",
            "editable": false,
            "description": "The date the employee was last active on.",
            "type": "string",
            "format": "date",
            "source": "last_active_at"
        },
        "last_active_at_time": {
            "label": "Last active on Date-Time Time",
            "editable": false,
            "description": "The date the employee was last active on.",
            "type": "string",
            "format": "time",
            "source": "last_active_at"
        },
        "activated_at_date": {
            "label": "Activated on Date-Time Date",
            "editable": false,
            "description": "The date the employee was activated on.",
            "type": "string",
            "format": "date",
            "source": "activated_at"
        },
        "activated_at_time": {
            "label": "Activated on Date-Time Time",
            "editable": false,
            "description": "The date the employee was activated on.",
            "type": "string",
            "format": "time",
            "source": "activated_at"
        },
        "deactivated_at_date": {
            "label": "Deactivated on Date-Time Date",
            "editable": false,
            "description": "The date the employee was deactivated on.",
            "type": "string",
            "format": "date",
            "source": "deactivated_at"
        },
        "deactivated_at_time": {
            "label": "Deactivated on Date-Time Time",
            "editable": false,
            "description": "The date the employee was deactivated on.",
            "type": "string",
            "format": "time",
            "source": "deactivated_at"
        },
        "password_expires_at_date": {
            "label": "Password expires at Date-Time Date",
            "editable": false,
            "description": "The date when the employee password will expire.",
            "type": "string",
            "format": "date",
            "source": "password_expires_at"
        },
        "password_expires_at_time": {
            "label": "Password expires at Date-Time Time",
            "editable": false,
            "description": "The date when the employee password will expire.",
            "type": "string",
            "format": "time",
            "source": "password_expires_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
status		integer (int)	Status
wage_profile_id		foreignKey (int)	Wage Profile ID
created_at	`Read Only`	string (date-time)	Created on Date-Time The date the employee was created in the system.
updated_at	`Read Only`	string (date-time)	Updated on Date-Time The date the employee was last updated in the system.
reminded_at	`Read Only`	string (date-time)	Reminded on Date-Time The date the employee was last reminded to complete the recruiting process.
last_logged_in_at	`Read Only`	string (date-time)	Logged in on Date-Time The date the employee was last logged in on.
last_active_at	`Read Only`	string (date-time)	Last active on Date-Time The date the employee was last active on.
activated_at	`Read Only`	string (date-time)	Activated on Date-Time The date the employee was activated on.
deactivated_at	`Read Only`	string (date-time)	Deactivated on Date-Time The date the employee was deactivated on.
password_expires_at	`Read Only`	string (date-time)	Password expires at Date-Time The date when the employee password will expire.
firstname	`Dynamic Field`		First name
lastname	`Dynamic Field`		Last name
email	`Dynamic Field`		Email address
mobile	`Dynamic Field`		Mobile number
address_first	`Dynamic Field`		Street
address_second	`Dynamic Field`		Address line 2
zip	`Dynamic Field`		Postcode
city	`Dynamic Field`		City
country	`Dynamic Field`		Country
qualifications	`Dynamic Field`		Qualifications
dynamic_field_26	`Dynamic Field`		Applies for
dynamic_field_27	`Dynamic Field`		How did you hear about us?
dynamic_field_28	`Dynamic Field`	(formatted-number)	Height
dynamic_field_30	`Dynamic Field`		E-Mail Sprache
dynamic_field_31	`Dynamic Field`		Driver
dynamic_field_32	`Dynamic Field`		Car
dynamic_field_33	`Dynamic Field`		Gesundheitszeugnis
dynamic_field_34	`Dynamic Field`		NI Number
dynamic_field_38	`Dynamic Field`		IBAN
dynamic_field_39	`Dynamic Field`		Bank
dynamic_field_41	`Dynamic Field`		Religious denomination
dynamic_field_43	`Dynamic Field`		Driver's licence
birthday	`Dynamic Field`	(formatted-date)	Birthday
dynamic_field_48	`Dynamic Field`		Employment Contract
dynamic_field_49	`Dynamic Field`		Visa
gender	`Dynamic Field`		Gender
dynamic_field_54	`Dynamic Field`
dynamic_field_62	`Dynamic Field`		Document 3
dynamic_field_63	`Dynamic Field`		Photo 1
dynamic_field_66	`Dynamic Field`
dynamic_field_69	`Dynamic Field`		Ich akzeptiere die AGB
dynamic_field_72	`Dynamic Field`		Employment type
dynamic_field_73	`Dynamic Field`	(formatted-date)	Expiry date Student card
dynamic_field_74	`Dynamic Field`	(formatted-number)	DIAS number
dynamic_field_75	`Dynamic Field`		Languages
dynamic_field_76	`Dynamic Field`	(formatted-date)	Date
dynamic_field_77	`Dynamic Field`	(formatted-currency)	Account Balance
dynamic_field_80	`Dynamic Field`		Validatione Grande
dynamic_field_81	`Dynamic Field`
dynamic_field_83	`Dynamic Field`		Afbeelding badge
dynamic_field_84	`Dynamic Field`	(formatted-date)	Datum Badge
dynamic_field_87	`Read Only` `Dynamic Field`	(int)	EMP ID
dynamic_field_90	`Dynamic Field`
dynamic_field_91	`Dynamic Field`		Nationality
dynamic_field_92	`Dynamic Field`
dynamic_field_93	`Dynamic Field`
dynamic_field_94	`Dynamic Field`		T-Shirt size
dynamic_field_95	`Dynamic Field`		Railcard
dynamic_field_97	`Dynamic Field`	(formatted-number)
dynamic_field_98	`Dynamic Field`		Profession
dynamic_field_99	`Dynamic Field`	(formatted-number)	Landline
dynamic_field_100	`Dynamic Field`		Marital status
dynamic_field_101	`Dynamic Field`		Work team
dynamic_field_102	`Dynamic Field`		Visible tattoos?
dynamic_field_103	`Dynamic Field`		Trouser size
dynamic_field_104	`Dynamic Field`		CV
dynamic_field_107	`Dynamic Field`		Assignments
dynamic_field_108	`Dynamic Field`		Other languages
dynamic_field_111	`Dynamic Field`		Collectionfield
dynamic_field_114	`Dynamic Field`		Remarks
dynamic_field_115	`Dynamic Field`		Driving Licence Copy
dynamic_field_118	`Dynamic Field`
dynamic_field_119	`Dynamic Field`
dynamic_field_120	`Dynamic Field`		Preferred locations
dynamic_field_130	`Dynamic Field`
dynamic_field_131	`Dynamic Field`
dynamic_field_132	`Dynamic Field`
dynamic_field_134	`Dynamic Field`		This is a checkbox
dynamic_field_135	`Dynamic Field`	(formatted-date)	Date
dynamic_field_136	`Dynamic Field`		Lieblingsfarbe
dynamic_field_137	`Dynamic Field`	(formatted-datetime)
dynamic_field_138	`Dynamic Field`		decimal
dynamic_field_139	`Dynamic Field`
dynamic_field_140	`Dynamic Field`	(formatted-time)
dynamic_field_141	`Dynamic Field`
dynamic_field_145	`Dynamic Field`		[missing translation]
dynamic_field_146	`Dynamic Field`		[missing translation]
communication_language	`Dynamic Field`		Communication language
dynamic_field_155	`Dynamic Field`		[missing translation]
dynamic_field_156	`Dynamic Field`		Nachtschicht
dynamic_field_158	`Dynamic Field`		[missing translation]
dynamic_field_159	`Dynamic Field`		[missing translation]
dynamic_field_160	`Dynamic Field`	(formatted-currency)	[missing translation]
dynamic_field_164	`Dynamic Field`		Shoes
dynamic_field_172	`Dynamic Field`		Work location
dynamic_field_179	`Dynamic Field`		Timesheet
dynamic_field_180	`Dynamic Field`		Pension Insurance
dynamic_field_183	`Dynamic Field`		[missing translation]
dynamic_field_184	`Dynamic Field`	(formatted-date)	Contractual period
dynamic_field_186	`Dynamic Field`		Additional data needed
dynamic_field_189	`Dynamic Field`		Technologies
dynamic_field_191	`Dynamic Field`		Safety shoes
dynamic_field_192	`Dynamic Field`	(formatted-datetime)	[missing translation]
dynamic_field_193	`Dynamic Field`		County
dynamic_field_195	`Dynamic Field`		Status before employment
dynamic_field_196	`Dynamic Field`		Certificate
dynamic_field_197	`Dynamic Field`		Upload
dynamic_field_198	`Dynamic Field`	(formatted-date)	Validity
dynamic_field_199	`Dynamic Field`		T&C's
dynamic_field_200	`Dynamic Field`		T&C's done
dynamic_field_204	`Dynamic Field`	(formatted-datetime)	date validation 1
dynamic_field_205	`Dynamic Field`	(formatted-datetime)	date validation 2
dynamic_field_206	`Dynamic Field`	(formatted-date)	new date
dynamic_field_207	`Dynamic Field`	(formatted-date)	new date 1
dynamic_field_209	`Dynamic Field`	(formatted-date)	Date hide
dynamic_field_210	`Dynamic Field`	(formatted-date)	[missing translation]
external_staff_providers	`Dynamic Field`		External staff provider
framework_contract	`Dynamic Field`		Framework contract
framework_contract_expiry_date	`Dynamic Field`		Framework contract expiry date
framework_contract_start_date	`Dynamic Field`		Framework contract start date
dynamic_field_225	`Dynamic Field`	(formatted-date)	[missing translation]
dynamic_field_226	`Dynamic Field`		Mobitrain Group
dynamic_field_230	`Dynamic Field`		[missing translation]
dynamic_field_231	`Dynamic Field`		[missing translation]
created_at_date	`Read Only`	string (date)	Created on Date-Time Date The date the employee was created in the system.
created_at_time	`Read Only`	string (time)	Created on Date-Time Time The date the employee was created in the system.
updated_at_date	`Read Only`	string (date)	Updated on Date-Time Date The date the employee was last updated in the system.
updated_at_time	`Read Only`	string (time)	Updated on Date-Time Time The date the employee was last updated in the system.
reminded_at_date	`Read Only`	string (date)	Reminded on Date-Time Date The date the employee was last reminded to complete the recruiting process.
reminded_at_time	`Read Only`	string (time)	Reminded on Date-Time Time The date the employee was last reminded to complete the recruiting process.
last_logged_in_at_date	`Read Only`	string (date)	Logged in on Date-Time Date The date the employee was last logged in on.
last_logged_in_at_time	`Read Only`	string (time)	Logged in on Date-Time Time The date the employee was last logged in on.
last_active_at_date	`Read Only`	string (date)	Last active on Date-Time Date The date the employee was last active on.
last_active_at_time	`Read Only`	string (time)	Last active on Date-Time Time The date the employee was last active on.
activated_at_date	`Read Only`	string (date)	Activated on Date-Time Date The date the employee was activated on.
activated_at_time	`Read Only`	string (time)	Activated on Date-Time Time The date the employee was activated on.
deactivated_at_date	`Read Only`	string (date)	Deactivated on Date-Time Date The date the employee was deactivated on.
deactivated_at_time	`Read Only`	string (time)	Deactivated on Date-Time Time The date the employee was deactivated on.
password_expires_at_date	`Read Only`	string (date)	Password expires at Date-Time Date The date when the employee password will expire.
password_expires_at_time	`Read Only`	string (time)	Password expires at Date-Time Time The date when the employee password will expire.

Relations

Name	Resource	Foreign Key	Description
externalStaffProvider	external-staff-providers	external-workers.external_staff_providers	External staff provider referenced by the worker.
employeeBusyDates	busy-dates	busy-dates.employee_id
employeeAssignments	assignments	assignments.employee_id
employeeWageProfile	wage-profiles	external-workers.wage_profile_id	Base wage profile of the employee
employeeWorkQuotaProfiles	work-quota-profiles	work-quota-profiles.employee_id
availability-requests	availability-requests	availability-requests.employee_id
availabilities	availability-requests-availabilities	availability-requests-availabilities.employee_id
employeeRatings	ratings	ratings.employee_id

Actions

Request	Description
`GET /external-workers`	Resource listing
`GET /external-workers/<id>`	Resource read
`POST /external-workers`	Resource create
`PUT /external-workers/<id>`	Resource update
`DELETE /external-workers/<id>`	Resource delete Note: this action is deprecated. In order to mark an employee as deleted or inactive you can use `PUT /external-workers/<id>/state/<statusId>` action where `statusId` can be `5` for inactive, or `6` for deleted
`GET /external-workers/<id>/active`	Get all active employees.
`PUT /external-workers/<id>/state`	Set the state of an employee.
`PUT /external-workers/<id>/forms`
`GET /external-workers/<id>/forms`	Get employee rendered through a given form.

Files

Schema

Files schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "path": {
            "label": "Path",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "mime": {
            "label": "Mime Type",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "user_id": {
            "label": "User ID",
            "editable": false,
            "type": "integer",
            "format": "int"
        },
        "status": {
            "label": "Status",
            "editable": true,
            "type": "integer",
            "enum": [
                0,
                1
            ],
            "valueMapping": [
                "Temporary",
                "Fix"
            ],
            "format": "int"
        },
        "public_url": {
            "label": "Public url",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "visibility": {
            "label": "Visibility",
            "editable": false,
            "type": "string",
            "enum": [
                "public",
                "private"
            ],
            "format": "string"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
path	`Read Only`	string (string)	Path
name	`Read Only`	string (string)	Name
mime	`Read Only`	string (string)	Mime Type
user_id	`Read Only`	integer (int)	User ID
status		integer (int)	Status
public_url	`Read Only`	string (string)	Public url
visibility	`Read Only`	string (string)	Visibility
created_at	`Read Only`	string (date-time)	Created Date-Time
created_at_date	`Read Only`	string (date)	Created Date-Time Date
created_at_time	`Read Only`	string (time)	Created Date-Time Time

Actions

Request	Description
`GET /files`	Resource listing
`GET /files/<id>`	Resource read
`POST /files`	Resource create
`PUT /files/<id>`	Resource update
`DELETE /files/<id>`	Resource delete

Forms

Schema

Forms schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "identifier": {
            "label": "Identifier",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "name": {
            "label": "Label",
            "type": "string",
            "editable": false,
            "format": "string"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
identifier	`Read Only`	string (string)	Identifier
name	`Read Only`	string (string)	Label

Actions

Request	Description
`GET /forms`	Resource listing
`GET /forms/<id>`	Resource read
`POST /forms`	Resource create
`PUT /forms/<id>`	Resource update
`DELETE /forms/<id>`	Resource delete

Functions

Schema

Functions schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "code": {
            "label": "Code",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "wage_profile_id": {
            "label": "Wage profile ID",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "wage_profile_name": {
            "label": "Wage profile name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "project_leader": {
            "label": "Team Leader At The Event Level",
            "editable": false,
            "type": "integer",
            "format": "bool",
            "description": "If true, the employees assigned to this function are set as team leaders at the event level."
        },
        "team_leader_at_project_level": {
            "label": "Team Leader At The Project Level",
            "editable": false,
            "type": "integer",
            "format": "bool",
            "description": "If true, the employees assigned to this function are set as team leaders at the project level."
        },
        "qualifications": {
            "label": "Qualifications",
            "editable": false,
            "type": "array",
            "format": "array"
        },
        "deleted": {
            "label": "Deleted",
            "editable": false,
            "type": "integer",
            "format": "bool",
            "description": "Whether the function is deleted or not."
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
name	`Read Only`	string (string)	Name
code	`Read Only`	string (string)	Code
wage_profile_id	`Read Only`	string (string)	Wage profile ID
wage_profile_name	`Read Only`	string (string)	Wage profile name
project_leader	`Read Only`	integer (bool)	Team Leader At The Event Level If true, the employees assigned to this function are set as team leaders at the event level.
team_leader_at_project_level	`Read Only`	integer (bool)	Team Leader At The Project Level If true, the employees assigned to this function are set as team leaders at the project level.
qualifications	`Read Only`	array (array)	Qualifications
deleted	`Read Only`	integer (bool)	Deleted Whether the function is deleted or not.

Actions

Request	Description
`GET /functions`	Resource listing
`GET /functions/<id>`	Resource read
`POST /functions`	Resource create
`PUT /functions/<id>`	Resource update
`DELETE /functions/<id>`	Resource delete

Languages

Schema

Languages schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "code": {
            "label": "Code",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "short": {
            "label": "Short",
            "editable": false,
            "type": "string",
            "format": "string"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
code	`Read Only`	string (string)	Code
name	`Read Only`	string (string)	Name
short	`Read Only`	string (string)	Short

Actions

Request	Description
`GET /languages`	Resource listing
`GET /languages/<id>`	Resource read
`POST /languages`	Resource create
`PUT /languages/<id>`	Resource update
`DELETE /languages/<id>`	Resource delete

Livestamps

Schema

Livestamps schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "assignment_id": {
            "label": "Assignment ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner ID",
            "editable": false,
            "description": "The ID of the planner who accepted\/rejected the livestamp",
            "type": "foreignKey",
            "format": "int"
        },
        "proposed_date_time": {
            "label": "Proposed Date-Time",
            "editable": true,
            "description": "The assignment livestamp proposed date and time.",
            "type": "string",
            "format": "date-time"
        },
        "latitude": {
            "label": "Latitude",
            "editable": true,
            "description": "The assignment livestamp latitude.",
            "type": "float",
            "format": "float"
        },
        "longitude": {
            "label": "Longitude",
            "editable": true,
            "description": "The assignment livestamp longitude.",
            "type": "float",
            "format": "float"
        },
        "remarks": {
            "label": "Remarks",
            "editable": true,
            "description": "The assignment livestamp remarks.",
            "type": "string",
            "format": "string"
        },
        "source": {
            "label": "Source",
            "editable": true,
            "description": "The assignment livestamp creation source.",
            "type": "string",
            "enum": [
                "employee_mobile_app",
                "employee_web_app"
            ],
            "format": "string"
        },
        "created_at": {
            "label": "Created at Date-Time",
            "editable": false,
            "description": "The date and time when the livestamp was created.",
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated at Date-Time",
            "editable": false,
            "description": "The date and time when the livestamp was last updated.",
            "type": "string",
            "format": "date-time"
        },
        "accepted_at": {
            "label": "Accepted at Date-Time",
            "editable": false,
            "description": "The date and time when the livestamp was accepted.",
            "type": "string",
            "format": "date-time"
        },
        "rejected_at": {
            "label": "Rejected at Date-Time",
            "editable": false,
            "description": "The date and time when the livestamp was rejected.",
            "type": "string",
            "format": "date-time"
        },
        "files_ids": {
            "label": "Livestamp files IDs (optional)",
            "editable": true,
            "description": "The IDs of the files to be added to the livestamp.",
            "type": "array",
            "format": "array"
        },
        "files": {
            "label": "Files",
            "editable": false,
            "description": "The assignment livestamp uploaded files.",
            "type": "array",
            "format": "array"
        },
        "proposed_date_time_date": {
            "label": "Proposed Date-Time Date",
            "editable": true,
            "description": "The assignment livestamp proposed date and time.",
            "type": "string",
            "format": "date",
            "source": "proposed_date_time"
        },
        "proposed_date_time_time": {
            "label": "Proposed Date-Time Time",
            "editable": true,
            "description": "The assignment livestamp proposed date and time.",
            "type": "string",
            "format": "time",
            "source": "proposed_date_time"
        },
        "created_at_date": {
            "label": "Created at Date-Time Date",
            "editable": false,
            "description": "The date and time when the livestamp was created.",
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created at Date-Time Time",
            "editable": false,
            "description": "The date and time when the livestamp was created.",
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated at Date-Time Date",
            "editable": false,
            "description": "The date and time when the livestamp was last updated.",
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated at Date-Time Time",
            "editable": false,
            "description": "The date and time when the livestamp was last updated.",
            "type": "string",
            "format": "time",
            "source": "updated_at"
        },
        "accepted_at_date": {
            "label": "Accepted at Date-Time Date",
            "editable": false,
            "description": "The date and time when the livestamp was accepted.",
            "type": "string",
            "format": "date",
            "source": "accepted_at"
        },
        "accepted_at_time": {
            "label": "Accepted at Date-Time Time",
            "editable": false,
            "description": "The date and time when the livestamp was accepted.",
            "type": "string",
            "format": "time",
            "source": "accepted_at"
        },
        "rejected_at_date": {
            "label": "Rejected at Date-Time Date",
            "editable": false,
            "description": "The date and time when the livestamp was rejected.",
            "type": "string",
            "format": "date",
            "source": "rejected_at"
        },
        "rejected_at_time": {
            "label": "Rejected at Date-Time Time",
            "editable": false,
            "description": "The date and time when the livestamp was rejected.",
            "type": "string",
            "format": "time",
            "source": "rejected_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
assignment_id	`Read Only`	foreignKey (int)	Assignment ID
planner_id	`Read Only`	foreignKey (int)	Planner ID The ID of the planner who accepted/rejected the livestamp
proposed_date_time		string (date-time)	Proposed Date-Time The assignment livestamp proposed date and time.
latitude		float (float)	Latitude The assignment livestamp latitude.
longitude		float (float)	Longitude The assignment livestamp longitude.
remarks		string (string)	Remarks The assignment livestamp remarks.
source		string (string)	Source The assignment livestamp creation source.
created_at	`Read Only`	string (date-time)	Created at Date-Time The date and time when the livestamp was created.
updated_at	`Read Only`	string (date-time)	Updated at Date-Time The date and time when the livestamp was last updated.
accepted_at	`Read Only`	string (date-time)	Accepted at Date-Time The date and time when the livestamp was accepted.
rejected_at	`Read Only`	string (date-time)	Rejected at Date-Time The date and time when the livestamp was rejected.
files_ids		array (array)	Livestamp files IDs (optional) The IDs of the files to be added to the livestamp.
files	`Read Only`	array (array)	Files The assignment livestamp uploaded files.
proposed_date_time_date		string (date)	Proposed Date-Time Date The assignment livestamp proposed date and time.
proposed_date_time_time		string (time)	Proposed Date-Time Time The assignment livestamp proposed date and time.
created_at_date	`Read Only`	string (date)	Created at Date-Time Date The date and time when the livestamp was created.
created_at_time	`Read Only`	string (time)	Created at Date-Time Time The date and time when the livestamp was created.
updated_at_date	`Read Only`	string (date)	Updated at Date-Time Date The date and time when the livestamp was last updated.
updated_at_time	`Read Only`	string (time)	Updated at Date-Time Time The date and time when the livestamp was last updated.
accepted_at_date	`Read Only`	string (date)	Accepted at Date-Time Date The date and time when the livestamp was accepted.
accepted_at_time	`Read Only`	string (time)	Accepted at Date-Time Time The date and time when the livestamp was accepted.
rejected_at_date	`Read Only`	string (date)	Rejected at Date-Time Date The date and time when the livestamp was rejected.
rejected_at_time	`Read Only`	string (time)	Rejected at Date-Time Time The date and time when the livestamp was rejected.

Relations

Name	Resource	Foreign Key	Description
livestampAssignment	assignments	livestamps.assignment_id
livestampPlanner	planners	livestamps.planner_id

Actions

Request	Description
`GET /livestamps`	Resource listing
`GET /livestamps/<id>`	Resource read
`POST /livestamps`	Resource create
`PUT /livestamps/<id>`	Resource update
`DELETE /livestamps/<id>`	Resource delete
`POST /livestamps/<id>/add-files`	Add new files to an assignment wage proposal.
`DELETE /livestamps/<id>/delete-files`	Delete files from an assignment wage proposal.
`PUT /livestamps/<id>/accept`	Accept an assignment wage proposal.
`PUT /livestamps/<id>/reject`	Reject an assignment wage proposal.

Locations

Schema

Locations schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "code": {
            "label": "Code",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "line_1": {
            "label": "Address line 1",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "line_2": {
            "label": "Address line 2",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "zip": {
            "label": "Zip",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "city": {
            "label": "City",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "country": {
            "label": "Country",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "county": {
            "label": "County",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "additional_information": {
            "label": "Additional information",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "deleted": {
            "label": "Deleted",
            "editable": false,
            "type": "integer",
            "format": "bool",
            "description": "Whether the location is deleted or not."
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
name	`Read Only`	string (string)	Name
code	`Read Only`	string (string)	Code
line_1	`Read Only`	string (string)	Address line 1
line_2	`Read Only`	string (string)	Address line 2
zip	`Read Only`	string (string)	Zip
city	`Read Only`	string (string)	City
country	`Read Only`	string (string)	Country
county	`Read Only`	string (string)	County
additional_information	`Read Only`	string (string)	Additional information
deleted	`Read Only`	integer (bool)	Deleted Whether the location is deleted or not.

Actions

Request	Description
`GET /locations`	Resource listing
`GET /locations/<id>`	Resource read
`POST /locations`	Resource create
`PUT /locations/<id>`	Resource update
`DELETE /locations/<id>`	Resource delete

Messages

Schema

Messages schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "conversation_identifier": {
            "label": "Conversation identifier",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "subject": {
            "label": "Subject",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "text": {
            "label": "Text",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "plain_text": {
            "label": "Plain text",
            "description": "Returned only when using the flag `with-plain-text` set to `1`",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "attachments": {
            "label": "Attachments",
            "editable": false,
            "type": "array"
        },
        "is_read": {
            "label": "Message was read",
            "editable": false,
            "type": "integer",
            "format": "bool"
        },
        "created_at": {
            "label": "Created at Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "type": {
            "label": "Message type",
            "editable": false,
            "type": "string",
            "enum": [
                "notification",
                "message"
            ]
        },
        "hasAttachments": {
            "label": "Message has attachments",
            "editable": false,
            "type": "int",
            "format": "bool"
        },
        "payload": {
            "label": "Payload",
            "editable": false,
            "type": "object"
        },
        "from": {
            "label": "From",
            "editable": false,
            "type": "object"
        },
        "to": {
            "label": "To",
            "editable": false,
            "type": "object"
        },
        "conversation_message_count": {
            "label": "Conversation messages count",
            "editable": false,
            "type": "int",
            "format": "int"
        },
        "created_at_date": {
            "label": "Created at Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created at Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
conversation_identifier	`Read Only`	string (string)	Conversation identifier
subject	`Read Only`	string (string)	Subject
text	`Read Only`	string (string)	Text
plain_text	`Read Only`	string (string)	Plain text Returned only when using the flag `with-plain-text` set to `1`
attachments	`Read Only`	array	Attachments
is_read	`Read Only`	integer (bool)	Message was read
created_at	`Read Only`	string (date-time)	Created at Date-Time
type	`Read Only`	string	Message type
hasAttachments	`Read Only`	int (bool)	Message has attachments
payload	`Read Only`	object	Payload
from	`Read Only`	object	From
to	`Read Only`	object	To
conversation_message_count	`Read Only`	int (int)	Conversation messages count
created_at_date	`Read Only`	string (date)	Created at Date-Time Date
created_at_time	`Read Only`	string (time)	Created at Date-Time Time

Actions

Request	Description
`GET /messages`	Resource listing
`GET /messages/<id>`	Resource read
`POST /messages`	Resource create
`PUT /messages/<id>`	Resource update
`DELETE /messages/<id>`	Resource delete
`GET /messages/<id>/conversations`	Fetch all conversations including most recent message.
`GET /messages/<id>/conversations`	Fetch messages for a conversation.
`PUT /messages/<id>/conversations`	Update a conversation.
`DELETE /messages/<id>/conversations`	Delete a conversation thread
`POST /messages/<id>/send`	Send or reply to a message.
`GET /messages/<id>/mark-all-as-read`	Mark all the messages of the given type as read.

Notifications

Schema

Notifications schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "subject": {
            "label": "Subject",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "text": {
            "label": "Text",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "plain_text": {
            "label": "Plain text",
            "description": "Returned only when using the flag `with-plain-text` set to `1`",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "is_read": {
            "label": "Message was read",
            "editable": false,
            "type": "integer",
            "format": "bool"
        },
        "created_at": {
            "label": "Created at Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "payload": {
            "label": "Payload",
            "editable": false,
            "type": "object"
        },
        "to": {
            "label": "To",
            "editable": false,
            "type": "object"
        },
        "created_at_date": {
            "label": "Created at Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created at Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
subject	`Read Only`	string (string)	Subject
text	`Read Only`	string (string)	Text
plain_text	`Read Only`	string (string)	Plain text Returned only when using the flag `with-plain-text` set to `1`
is_read	`Read Only`	integer (bool)	Message was read
created_at	`Read Only`	string (date-time)	Created at Date-Time
payload	`Read Only`	object	Payload
to	`Read Only`	object	To
created_at_date	`Read Only`	string (date)	Created at Date-Time Date
created_at_time	`Read Only`	string (time)	Created at Date-Time Time

Actions

Request	Description
`GET /notifications`	Resource listing
`GET /notifications/<id>`	Resource read
`POST /notifications`	Resource create
`PUT /notifications/<id>`	Resource update
`DELETE /notifications/<id>`	Resource delete

Pay lines

Schema

Pay-lines schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "pay_run_id": {
            "label": "Pay Run Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "assignment_id": {
            "label": "Assignment Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "wage_type_id": {
            "label": "Wage Type Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "event_function_id": {
            "label": "Event Function Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "event_id": {
            "label": "Event Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "project_id": {
            "label": "Project Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "client_id": {
            "label": "Client Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "contact_id": {
            "label": "Contact Id",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "rate": {
            "label": "Pay rate (if any)",
            "editable": false,
            "type": "float"
        },
        "quantity": {
            "label": "Pay quantity (if any)",
            "editable": false,
            "type": "float"
        },
        "amount": {
            "label": "Total Payable Amount",
            "editable": false,
            "type": "float"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": true,
            "type": "string",
            "format": "date-time"
        },
        "created_by_planner_id": {
            "label": "Id of the planner that created the pay line.",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "pay_run.identifier": {
            "label": "Pay Run Identifier",
            "editable": false,
            "type": "string"
        },
        "pay_run.name": {
            "label": "Pay Run Name",
            "editable": false,
            "type": "string"
        },
        "pay_run.description": {
            "label": "Pay Run Description",
            "editable": false,
            "type": "string"
        },
        "wage_type.type": {
            "label": "Wage Type",
            "editable": false,
            "type": "string"
        },
        "wage_type.name": {
            "label": "Wage Type Name",
            "editable": false,
            "type": "string"
        },
        "wage_type.external_id": {
            "label": "Wage Type Identifier",
            "editable": false,
            "type": "string"
        },
        "wage_type.currency_format": {
            "label": "Wage Type Currency Format",
            "editable": false,
            "type": "string"
        },
        "employee.first_name": {
            "label": "Employee First Name",
            "editable": false,
            "type": "string"
        },
        "employee.last_name": {
            "label": "Employee Last Name",
            "editable": false,
            "type": "string"
        },
        "employee.email": {
            "label": "Employee Email",
            "editable": false,
            "type": "string"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": true,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": true,
            "type": "string",
            "format": "time",
            "source": "created_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
pay_run_id	`Read Only`	foreignKey (int)	Pay Run Id
assignment_id	`Read Only`	foreignKey (int)	Assignment Id
wage_type_id	`Read Only`	foreignKey (int)	Wage Type Id
employee_id	`Read Only`	foreignKey (int)	Employee Id
event_function_id	`Read Only`	foreignKey (int)	Event Function Id
event_id	`Read Only`	foreignKey (int)	Event Id
project_id	`Read Only`	foreignKey (int)	Project Id
client_id	`Read Only`	foreignKey (int)	Client Id
contact_id	`Read Only`	foreignKey (int)	Contact Id
rate	`Read Only`	float	Pay rate (if any)
quantity	`Read Only`	float	Pay quantity (if any)
amount	`Read Only`	float	Total Payable Amount
created_at		string (date-time)	Created Date-Time
created_by_planner_id	`Read Only`	foreignKey (int)	Id of the planner that created the pay line.
pay_run.identifier	`Read Only`	string	Pay Run Identifier
pay_run.name	`Read Only`	string	Pay Run Name
pay_run.description	`Read Only`	string	Pay Run Description
wage_type.type	`Read Only`	string	Wage Type
wage_type.name	`Read Only`	string	Wage Type Name
wage_type.external_id	`Read Only`	string	Wage Type Identifier
wage_type.currency_format	`Read Only`	string	Wage Type Currency Format
employee.first_name	`Read Only`	string	Employee First Name
employee.last_name	`Read Only`	string	Employee Last Name
employee.email	`Read Only`	string	Employee Email
created_at_date		string (date)	Created Date-Time Date
created_at_time		string (time)	Created Date-Time Time

Relations

Name	Resource	Foreign Key
payLinePayRun	pay-runs	pay-runs.pay_run_id
payLineEmployee	employees	pay-lines.employee_id
payLineAssignment	assignments	pay-lines.assignment_id
payLineEventFunction	event-functions	pay-lines.event_function_id
payLineEvent	events	pay-lines.event_id
payLineProject	projects	pay-lines.project_id
payLineClient	clients	pay-lines.client_id
payLineContact	contacts	pay-lines.contact_id

Actions

Request	Description
`GET /pay-lines`	Resource listing
`GET /pay-lines/<id>`	Resource read
`POST /pay-lines`	Resource create
`PUT /pay-lines/<id>`	Resource update
`DELETE /pay-lines/<id>`	Resource delete

Pay runs

Schema

Pay-runs schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "identifier": {
            "label": "Identifier",
            "type": "string",
            "editable": true,
            "format": "string"
        },
        "name": {
            "label": "Name",
            "type": "string",
            "editable": true,
            "format": "string"
        },
        "description": {
            "label": "Description",
            "type": "string",
            "editable": true,
            "format": "string"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": true,
            "type": "string",
            "format": "date-time"
        },
        "exported_at": {
            "label": "Exported Date-Time",
            "editable": true,
            "type": "string",
            "format": "date-time"
        },
        "paid_at": {
            "label": "Pay Date-Time",
            "editable": true,
            "type": "string",
            "format": "date-time"
        },
        "created_by_planner_id": {
            "label": "Id of the planner that created the pay run.",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "exported_by_planner_id": {
            "label": "Id of the planner that exported the pay run.",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "paid_by_planner_id": {
            "label": "Id of the planner that paid the pay run.",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "pay_lines": {
            "label": "Pay lines for this pay run.",
            "editable": false,
            "type": "object"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": true,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": true,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "exported_at_date": {
            "label": "Exported Date-Time Date",
            "editable": true,
            "type": "string",
            "format": "date",
            "source": "exported_at"
        },
        "exported_at_time": {
            "label": "Exported Date-Time Time",
            "editable": true,
            "type": "string",
            "format": "time",
            "source": "exported_at"
        },
        "paid_at_date": {
            "label": "Pay Date-Time Date",
            "editable": true,
            "type": "string",
            "format": "date",
            "source": "paid_at"
        },
        "paid_at_time": {
            "label": "Pay Date-Time Time",
            "editable": true,
            "type": "string",
            "format": "time",
            "source": "paid_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
identifier		string (string)	Identifier
name		string (string)	Name
description		string (string)	Description
created_at		string (date-time)	Created Date-Time
exported_at		string (date-time)	Exported Date-Time
paid_at		string (date-time)	Pay Date-Time
created_by_planner_id	`Read Only`	foreignKey (int)	Id of the planner that created the pay run.
exported_by_planner_id	`Read Only`	foreignKey (int)	Id of the planner that exported the pay run.
paid_by_planner_id	`Read Only`	foreignKey (int)	Id of the planner that paid the pay run.
pay_lines	`Read Only`	object	Pay lines for this pay run.
created_at_date		string (date)	Created Date-Time Date
created_at_time		string (time)	Created Date-Time Time
exported_at_date		string (date)	Exported Date-Time Date
exported_at_time		string (time)	Exported Date-Time Time
paid_at_date		string (date)	Pay Date-Time Date
paid_at_time		string (time)	Pay Date-Time Time

Relations

Name	Resource	Foreign Key	Description
payRunPayLines	pay-lines	pay-runs.pay_run_id
payslips	payslips	pay-runs.pay_run_id

Actions

Request	Description
`GET /pay-runs`	Resource listing
`GET /pay-runs/<id>`	Resource read
`POST /pay-runs`	Resource create
`PUT /pay-runs/<id>`	Resource update
`DELETE /pay-runs/<id>`	Resource delete
`GET /pay-runs/<id>/payslips`	Get pay run payslips.

Paysheets

Schema

Paysheets schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "assignment_id": {
            "label": "Assignment ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "is_approved": {
            "label": "Paysheet Approved",
            "editable": false,
            "type": "integer",
            "format": "boolean"
        },
        "wages": {
            "label": "Paysheet wages",
            "editable": false,
            "type": "object"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
assignment_id	`Read Only`	foreignKey (int)	Assignment ID
is_approved	`Read Only`	integer (boolean)	Paysheet Approved
wages	`Read Only`	object	Paysheet wages

Relations

Name	Resource	Foreign Key	Description
paysheetAssignment	assignments	paysheets.assignment_id

Actions

Request	Description
`GET /paysheets`	Resource listing
`GET /paysheets/<id>`	Resource read
`POST /paysheets`	Resource create
`PUT /paysheets/<id>`	Resource update
`DELETE /paysheets/<id>`	Resource delete

Payslips

Schema

Payslips schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee ID",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "employee_name": {
            "label": "Employee name",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "pay_run_id": {
            "label": "Pay run ID",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "pay_run_name": {
            "label": "Pay Run Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "pay_run_start": {
            "label": "Pay Run Start",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "pay_run_end": {
            "label": "Pay Run End",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "projects": {
            "label": "Projects separated by comma",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "amount": {
            "label": "Amount",
            "editable": false,
            "type": "float",
            "format": "float"
        },
        "currency_format": {
            "label": "Currency format",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "file_id": {
            "label": "Payslip file ID",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "file_name": {
            "label": "Payslip file name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "file_public_url": {
            "label": "Payslip file public URL",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "file_mime": {
            "label": "Payslip file mime type",
            "editable": false,
            "type": "string",
            "format": "string"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id		foreignKey (int)	Employee ID
employee_name	`Read Only`	string (string)	Employee name
pay_run_id		foreignKey (int)	Pay run ID
pay_run_name	`Read Only`	string (string)	Pay Run Name
pay_run_start	`Read Only`	string (string)	Pay Run Start
pay_run_end	`Read Only`	string (string)	Pay Run End
projects	`Read Only`	string (string)	Projects separated by comma
amount	`Read Only`	float (float)	Amount
currency_format	`Read Only`	string (string)	Currency format
file_id		foreignKey (int)	Payslip file ID
file_name	`Read Only`	string (string)	Payslip file name
file_public_url	`Read Only`	string (string)	Payslip file public URL
file_mime	`Read Only`	string (string)	Payslip file mime type

Relations

Name	Resource	Foreign Key	Description
employee	employees	payslips.employee_id
pay-run	pay-runs	pay-runs.pay_run_id

Actions

Request	Description
`GET /payslips`	Resource listing
`GET /payslips/<id>`	Resource read
`POST /payslips`	Resource create
`PUT /payslips/<id>`	Resource update
`DELETE /payslips/<id>`	Resource delete

Planners

This resource uses dynamic fields.

Schema

Planners schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "username": {
            "label": "Username",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "first_name": {
            "label": "Planner first name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "last_name": {
            "label": "Planner last name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "password_expires_at": {
            "label": "Password expires at Date-Time",
            "editable": false,
            "description": "The date when the planner password will expire.",
            "type": "string",
            "format": "date-time"
        },
        "firstname": {
            "label": "First name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 21,
            "input_type": "text"
        },
        "lastname": {
            "label": "Last name",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 22,
            "input_type": "text"
        },
        "email": {
            "label": "Email address",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 23,
            "input_type": "email"
        },
        "mobile": {
            "label": "Mobile number",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 24,
            "input_type": "phone"
        },
        "password_expires_at_date": {
            "label": "Password expires at Date-Time Date",
            "editable": false,
            "description": "The date when the planner password will expire.",
            "type": "string",
            "format": "date",
            "source": "password_expires_at"
        },
        "password_expires_at_time": {
            "label": "Password expires at Date-Time Time",
            "editable": false,
            "description": "The date when the planner password will expire.",
            "type": "string",
            "format": "time",
            "source": "password_expires_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
username		string (string)	Username
first_name	`Read Only`	string (string)	Planner first name
last_name	`Read Only`	string (string)	Planner last name
password_expires_at	`Read Only`	string (date-time)	Password expires at Date-Time The date when the planner password will expire.
firstname	`Dynamic Field`		First name
lastname	`Dynamic Field`		Last name
email	`Dynamic Field`		Email address
mobile	`Dynamic Field`		Mobile number
password_expires_at_date	`Read Only`	string (date)	Password expires at Date-Time Date The date when the planner password will expire.
password_expires_at_time	`Read Only`	string (time)	Password expires at Date-Time Time The date when the planner password will expire.

Actions

Request	Description
`GET /planners`	Resource listing
`GET /planners/<id>`	Resource read
`POST /planners`	Resource create
`PUT /planners/<id>`	Resource update
`DELETE /planners/<id>`	Resource delete

Pre checkins

Schema

Pre-checkins schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField"
        },
        "assignment_id": {
            "label": "Assignment ID",
            "type": "foreignKey",
            "editable": false
        },
        "response": {
            "label": "Response",
            "editable": false,
            "type": "string",
            "enum": [
                "empty",
                "no_show",
                "late",
                "on_time"
            ],
            "valueMapping": {
                "empty": "Empty",
                "no_show": "No show",
                "late": "Late",
                "on_time": "On time"
            }
        },
        "late_minutes": {
            "label": "Late minutes",
            "editable": false,
            "type": "string"
        },
        "responded_at": {
            "label": "Responded at",
            "editable": false
        },
        "created_at": {
            "label": "Created at",
            "editable": false
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField	ID
assignment_id	`Read Only`	foreignKey	Assignment ID
response	`Read Only`	string	Response
late_minutes	`Read Only`	string	Late minutes
responded_at	`Read Only`		Responded at
created_at	`Read Only`		Created at

Relations

Name	Resource	Foreign Key	Description
preCheckInAssignment	assignments	pre-checkins.assignment_id

Actions

Request	Description
`GET /pre-checkins`	Resource listing
`GET /pre-checkins/<id>`	Resource read
`POST /pre-checkins`	Resource create
`PUT /pre-checkins/<id>`	Resource update
`DELETE /pre-checkins/<id>`	Resource delete
`POST /pre-checkins/<id>/respond`	Respond to a pre-check-in for an assignment.

Projects

This resource uses dynamic fields.

Schema

Projects schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "relation_id": {
            "label": "Relation ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "client_id": {
            "label": "Client ID",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner ID",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "contact_id": {
            "label": "Contact ID",
            "editable": true,
            "type": "foreignKey",
            "format": "int"
        },
        "name": {
            "label": "Project name",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "project_tags": {
            "label": "Tags",
            "editable": false,
            "type": "array",
            "format": "array"
        },
        "dynamic_field_56": {
            "label": "Data upload",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 56,
            "input_type": "file"
        },
        "dynamic_field_57": {
            "label": "Project details",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 57,
            "input_type": "text_area"
        },
        "dynamic_field_58": {
            "label": "Data upload",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 58,
            "input_type": "file"
        },
        "dynamic_field_109": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 109,
            "input_type": "multi_select"
        },
        "dynamic_field_110": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 110,
            "input_type": "select"
        },
        "dynamic_field_117": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 117,
            "input_type": "multi_select"
        },
        "dynamic_field_129": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 129,
            "input_type": "text"
        },
        "dynamic_field_133": {
            "label": "",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 133,
            "input_type": "url"
        },
        "dynamic_field_144": {
            "label": "Dress code",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 144,
            "input_type": "multi_select"
        },
        "dynamic_field_165": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 165,
            "input_type": "phone"
        },
        "dynamic_field_170": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 170,
            "input_type": "text"
        },
        "dynamic_field_173": {
            "label": "List of Materials",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 173,
            "input_type": "level_select"
        },
        "dynamic_field_174": {
            "label": "[missing translation]",
            "description": "",
            "editable": false,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 174,
            "input_type": "index",
            "format": "int"
        },
        "dynamic_field_175": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 175,
            "input_type": "text_area"
        },
        "dynamic_field_176": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 176,
            "input_type": "file"
        },
        "dynamic_field_177": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 177,
            "input_type": "file"
        },
        "dynamic_field_181": {
            "label": "Contact info",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 181,
            "input_type": "phone"
        },
        "dynamic_field_182": {
            "label": "Direct contact",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 182,
            "input_type": "wysiwyg"
        },
        "dynamic_field_185": {
            "label": "Materials needed?",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 185,
            "input_type": "select"
        },
        "dynamic_field_194": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 194,
            "input_type": "text"
        },
        "dynamic_field_211": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 211,
            "input_type": "number",
            "format": "formatted-number"
        },
        "dynamic_field_228": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 228,
            "input_type": "text"
        },
        "dynamic_field_229": {
            "label": "[missing translation]",
            "description": "",
            "editable": true,
            "dynamicField": true,
            "fieldType": "dynamicAttribute",
            "attributeId": 229,
            "input_type": "boolean"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
relation_id	`Read Only`	foreignKey (int)	Relation ID
client_id		foreignKey (int)	Client ID
planner_id		foreignKey (int)	Planner ID
contact_id		foreignKey (int)	Contact ID
name		string (string)	Project name
created_at	`Read Only`	string (date-time)	Created Date-Time
updated_at	`Read Only`	string (date-time)	Updated Date-Time
project_tags	`Read Only`	array (array)	Tags
dynamic_field_56	`Dynamic Field`		Data upload
dynamic_field_57	`Dynamic Field`		Project details
dynamic_field_58	`Dynamic Field`		Data upload
dynamic_field_109	`Dynamic Field`
dynamic_field_110	`Dynamic Field`
dynamic_field_117	`Dynamic Field`
dynamic_field_129	`Dynamic Field`
dynamic_field_133	`Dynamic Field`
dynamic_field_144	`Dynamic Field`		Dress code
dynamic_field_165	`Dynamic Field`		[missing translation]
dynamic_field_170	`Dynamic Field`		[missing translation]
dynamic_field_173	`Dynamic Field`		List of Materials
dynamic_field_174	`Read Only` `Dynamic Field`	(int)	[missing translation]
dynamic_field_175	`Dynamic Field`		[missing translation]
dynamic_field_176	`Dynamic Field`		[missing translation]
dynamic_field_177	`Dynamic Field`		[missing translation]
dynamic_field_181	`Dynamic Field`		Contact info
dynamic_field_182	`Dynamic Field`		Direct contact
dynamic_field_185	`Dynamic Field`		Materials needed?
dynamic_field_194	`Dynamic Field`		[missing translation]
dynamic_field_211	`Dynamic Field`	(formatted-number)	[missing translation]
dynamic_field_228	`Dynamic Field`		[missing translation]
dynamic_field_229	`Dynamic Field`		[missing translation]
created_at_date	`Read Only`	string (date)	Created Date-Time Date
created_at_time	`Read Only`	string (time)	Created Date-Time Time
updated_at_date	`Read Only`	string (date)	Updated Date-Time Date
updated_at_time	`Read Only`	string (time)	Updated Date-Time Time

Relations

Name	Resource	Foreign Key
projectClient	clients	projects.client_id
projectContact	contacts	projects.contact_id
projectEvents	events	events.project_id
projectPlanner	planners	projects.planner_id

Actions

Request	Description
`GET /projects`	Resource listing
`GET /projects/<id>`	Resource read
`POST /projects`	Resource create
`PUT /projects/<id>`	Resource update
`DELETE /projects/<id>`	Resource delete
`GET /projects/<id>/forms`	Get project rendered through a given form.
`GET /projects/<id>/reporting-forms`	Get reporting forms attached to a particular project.
`GET /projects/<id>/reporting-forms`	Get reporting forms for indicated projects

Ratings

Schema

Ratings schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "employee_id": {
            "label": "Employee ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "rater_id": {
            "label": "Rater ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "project_id": {
            "label": "Project ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "event_id": {
            "label": "Event ID",
            "type": "foreignKey",
            "editable": false,
            "format": "int"
        },
        "score": {
            "label": "Score",
            "type": "float",
            "editable": false,
            "format": "float"
        },
        "remarks": {
            "label": "Remarks",
            "type": "string",
            "editable": false
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "updated_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id	`Read Only`	foreignKey (int)	Employee ID
rater_id	`Read Only`	foreignKey (int)	Rater ID
project_id	`Read Only`	foreignKey (int)	Project ID
event_id	`Read Only`	foreignKey (int)	Event ID
score	`Read Only`	float (float)	Score
remarks	`Read Only`	string	Remarks
created_at	`Read Only`	string (date-time)	Created Date-Time
updated_at	`Read Only`	string (date-time)	Updated Date-Time
created_at_date	`Read Only`	string (date)	Created Date-Time Date
created_at_time	`Read Only`	string (time)	Created Date-Time Time
updated_at_date	`Read Only`	string (date)	Updated Date-Time Date
updated_at_time	`Read Only`	string (time)	Updated Date-Time Time

Relations

Name	Resource	Foreign Key	Description
employee	employees	ratings.employee_id

Actions

Request	Description
`GET /ratings`	Resource listing
`GET /ratings/<id>`	Resource read
`POST /ratings`	Resource create
`PUT /ratings/<id>`	Resource update
`DELETE /ratings/<id>`	Resource delete

Settings

Schema

Settings schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "identifier": {
            "label": "Identifier",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "type_id": {
            "label": "Setting type ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "value_type_id": {
            "label": "Setting value type ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "section_id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "collection_id": {
            "label": "ID",
            "editable": false,
            "type": "integer",
            "format": "int"
        },
        "collection": {
            "label": "ID",
            "editable": false,
            "type": "object"
        },
        "name": {
            "label": "Name",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "description": {
            "label": "Description",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "validators": {
            "label": "Setting validators",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "value": {
            "label": "Setting value",
            "editable": false,
            "type": "object"
        },
        "setting_type": {
            "label": "Setting type",
            "editable": false,
            "type": "object"
        },
        "setting_section": {
            "label": "Setting section",
            "editable": false,
            "type": "object"
        },
        "data_type": {
            "label": "Data type",
            "editable": false,
            "type": "object"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
identifier	`Read Only`	string (string)	Identifier
type_id	`Read Only`	foreignKey (int)	Setting type ID
value_type_id	`Read Only`	foreignKey (int)	Setting value type ID
section_id	`Read Only`	identityField (int)	ID
collection_id	`Read Only`	integer (int)	ID
collection	`Read Only`	object	ID
name	`Read Only`	string (string)	Name
description	`Read Only`	string (string)	Description
validators	`Read Only`	string (string)	Setting validators
value	`Read Only`	object	Setting value
setting_type	`Read Only`	object	Setting type
setting_section	`Read Only`	object	Setting section
data_type	`Read Only`	object	Data type

Relations

Name	Resource	Foreign Key	Description
settingCollection	collections	settings.collection_id

Actions

Request	Description
`GET /settings`	Resource listing
`GET /settings/<id>`	Resource read
`POST /settings`	Resource create
`PUT /settings/<id>`	Resource update
`DELETE /settings/<id>`	Resource delete

Special dates

Schema

Special-dates schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "name": {
            "label": "Name",
            "editable": true,
            "type": "string",
            "format": "string"
        },
        "description": {
            "label": "Description",
            "editable": false,
            "type": "string",
            "format": "string"
        },
        "date": {
            "label": "Date-Time",
            "editable": true,
            "type": "string",
            "format": "date-time"
        },
        "location_id": {
            "label": "Location Id",
            "editable": false,
            "type": "integer",
            "format": "int"
        },
        "date_date": {
            "label": "Date-Time Date",
            "editable": true,
            "type": "string",
            "format": "date",
            "source": "date"
        },
        "date_time": {
            "label": "Date-Time Time",
            "editable": true,
            "type": "string",
            "format": "time",
            "source": "date"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
name		string (string)	Name
description	`Read Only`	string (string)	Description
date		string (date-time)	Date-Time
location_id	`Read Only`	integer (int)	Location Id
date_date		string (date)	Date-Time Date
date_time		string (time)	Date-Time Time

Actions

Request	Description
`GET /special-dates`	Resource listing
`GET /special-dates/<id>`	Resource read
`POST /special-dates`	Resource create
`PUT /special-dates/<id>`	Resource update
`DELETE /special-dates/<id>`	Resource delete

Time slots

Schema

Time-slots schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "time_slot_category_id": {
            "label": "Category ID",
            "type": "int",
            "format": "int",
            "editable": false
        },
        "name": {
            "label": "Label",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "week_days": {
            "label": "Week days",
            "type": "array",
            "editable": false,
            "format": "array"
        },
        "from": {
            "label": "Valid From",
            "type": "string",
            "format": "time",
            "editable": false
        },
        "to": {
            "label": "Valid To",
            "type": "string",
            "format": "time",
            "editable": false
        },
        "archived_at": {
            "label": "Archived at",
            "type": "string",
            "format": "time",
            "editable": false
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
time_slot_category_id	`Read Only`	int (int)	Category ID
name	`Read Only`	string (string)	Label
week_days	`Read Only`	array (array)	Week days
from	`Read Only`	string (time)	Valid From
to	`Read Only`	string (time)	Valid To
archived_at	`Read Only`	string (time)	Archived at

Relations

Name	Resource	Foreign Key	Description
employeeAvailability	employee-availability	time-slots.time_slot_id

Actions

Request	Description
`GET /time-slots`	Resource listing
`GET /time-slots/<id>`	Resource read
`POST /time-slots`	Resource create
`PUT /time-slots/<id>`	Resource update
`DELETE /time-slots/<id>`	Resource delete

Wage profiles

Schema

Wage-profiles schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "identifier": {
            "label": "Identifier",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "name": {
            "label": "Label",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "status": {
            "label": "Status",
            "type": "integer",
            "editable": true,
            "enum": [
                1,
                2
            ],
            "valueMapping": {
                "1": "Active",
                "2": "Archived"
            },
            "format": "int"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
identifier	`Read Only`	string (string)	Identifier
name	`Read Only`	string (string)	Label
status		integer (int)	Status

Relations

Name	Resource	Foreign Key	Description
profileWageTypes	wage-types

Actions

Request	Description
`GET /wage-profiles`	Resource listing
`GET /wage-profiles/<id>`	Resource read
`POST /wage-profiles`	Resource create
`PUT /wage-profiles/<id>`	Resource update
`DELETE /wage-profiles/<id>`	Resource delete

Wage proposals

Schema

Wage-proposals schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "assignment_id": {
            "label": "Assignment ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner ID",
            "description": "The ID of the planner who accepted\/rejected the proposal",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "remarks": {
            "label": "Remarks",
            "editable": true,
            "description": "The assignment proposal remarks.",
            "type": "string",
            "format": "string"
        },
        "requested_updates": {
            "label": "Requested updates",
            "editable": false,
            "description": "The assignment proposal requested updates.",
            "type": "string",
            "format": "string"
        },
        "source": {
            "label": "Source",
            "editable": true,
            "description": "The assignment proposal creation source.",
            "type": "string",
            "enum": [
                "employee_mobile_app",
                "employee_web_app",
                "tla"
            ],
            "format": "string"
        },
        "created_at": {
            "label": "Created at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was created.",
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was last updated.",
            "type": "string",
            "format": "date-time"
        },
        "accepted_at": {
            "label": "Accepted at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was accepted.",
            "type": "string",
            "format": "date-time"
        },
        "rejected_at": {
            "label": "Rejected at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was rejected.",
            "type": "string",
            "format": "date-time"
        },
        "proposed_wage_type_values": {
            "label": "Proposed wage type values (optional)",
            "editable": true,
            "description": "The proposed wage type values.",
            "type": "array",
            "format": "array"
        },
        "files_ids": {
            "label": "Proposal files IDs (optional)",
            "editable": true,
            "description": "The IDs of the files to be added to the proposal.",
            "type": "array",
            "format": "array"
        },
        "files": {
            "label": "Files",
            "editable": false,
            "description": "The assignment proposal uploaded files.",
            "type": "array",
            "format": "array"
        },
        "created_at_date": {
            "label": "Created at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was created.",
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was created.",
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was last updated.",
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was last updated.",
            "type": "string",
            "format": "time",
            "source": "updated_at"
        },
        "accepted_at_date": {
            "label": "Accepted at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was accepted.",
            "type": "string",
            "format": "date",
            "source": "accepted_at"
        },
        "accepted_at_time": {
            "label": "Accepted at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was accepted.",
            "type": "string",
            "format": "time",
            "source": "accepted_at"
        },
        "rejected_at_date": {
            "label": "Rejected at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was rejected.",
            "type": "string",
            "format": "date",
            "source": "rejected_at"
        },
        "rejected_at_time": {
            "label": "Rejected at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was rejected.",
            "type": "string",
            "format": "time",
            "source": "rejected_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
assignment_id	`Read Only`	foreignKey (int)	Assignment ID
planner_id	`Read Only`	foreignKey (int)	Planner ID The ID of the planner who accepted/rejected the proposal
remarks		string (string)	Remarks The assignment proposal remarks.
requested_updates	`Read Only`	string (string)	Requested updates The assignment proposal requested updates.
source		string (string)	Source The assignment proposal creation source.
created_at	`Read Only`	string (date-time)	Created at Date-Time The date and time when the proposal was created.
updated_at	`Read Only`	string (date-time)	Updated at Date-Time The date and time when the proposal was last updated.
accepted_at	`Read Only`	string (date-time)	Accepted at Date-Time The date and time when the proposal was accepted.
rejected_at	`Read Only`	string (date-time)	Rejected at Date-Time The date and time when the proposal was rejected.
proposed_wage_type_values		array (array)	Proposed wage type values (optional) The proposed wage type values.
files_ids		array (array)	Proposal files IDs (optional) The IDs of the files to be added to the proposal.
files	`Read Only`	array (array)	Files The assignment proposal uploaded files.
created_at_date	`Read Only`	string (date)	Created at Date-Time Date The date and time when the proposal was created.
created_at_time	`Read Only`	string (time)	Created at Date-Time Time The date and time when the proposal was created.
updated_at_date	`Read Only`	string (date)	Updated at Date-Time Date The date and time when the proposal was last updated.
updated_at_time	`Read Only`	string (time)	Updated at Date-Time Time The date and time when the proposal was last updated.
accepted_at_date	`Read Only`	string (date)	Accepted at Date-Time Date The date and time when the proposal was accepted.
accepted_at_time	`Read Only`	string (time)	Accepted at Date-Time Time The date and time when the proposal was accepted.
rejected_at_date	`Read Only`	string (date)	Rejected at Date-Time Date The date and time when the proposal was rejected.
rejected_at_time	`Read Only`	string (time)	Rejected at Date-Time Time The date and time when the proposal was rejected.

Relations

Name	Resource	Foreign Key	Description
wageProposalAssignment	assignments	wage-proposals.assignment_id
wageProposalPlanner	planners	wage-proposals.planner_id

Actions

Request	Description
`GET /wage-proposals`	Resource listing
`GET /wage-proposals/<id>`	Resource read
`POST /wage-proposals`	Resource create
`PUT /wage-proposals/<id>`	Resource update
`DELETE /wage-proposals/<id>`	Resource delete
`GET /wage-proposals/<id>/proposable-wage-types`	Get the proposable wage types.
`POST /wage-proposals/<id>/add-files`	Add new files to an assignment wage proposal.
`DELETE /wage-proposals/<id>/delete-files`	Delete files from an assignment wage proposal.
`PUT /wage-proposals/<id>/accept`	Accept an assignment wage proposal.
`PUT /wage-proposals/<id>/reject`	Reject an assignment wage proposal.
`POST /wage-proposals/<id>/request-updates`	Request updates for an assignment wage proposal.

Wage types

Schema

Wage-types schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "name": {
            "label": "Name",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "external_id": {
            "label": "External ID",
            "type": "string",
            "editable": false,
            "format": "string"
        },
        "external_cost": {
            "label": "External cost",
            "editable": true,
            "format": "string"
        },
        "type": {
            "label": "Payment Type",
            "type": "string",
            "enum": [
                "rated",
                "fixed"
            ],
            "valueMapping": {
                "rated": "Rated",
                "fixed": "Permanent"
            },
            "editable": false
        },
        "base_type": {
            "label": "Base Value Type",
            "type": "string",
            "enum": [
                "predefined",
                "adjustable"
            ],
            "valueMapping": {
                "predefined": "Predefined (by wage type)",
                "adjustable": "Adjustable (by assignment)"
            },
            "editable": false
        },
        "rate_base": {
            "label": "Rate Base",
            "type": "string",
            "enum": [
                "work hours",
                "distance",
                "distance round-trip"
            ],
            "valueMapping": {
                "work hours": "Work hours (h)",
                "distance": "Distance (km)",
                "distance round-trip": "Distance round-trip (km)"
            },
            "editable": false
        },
        "amount": {
            "label": "Permanent Payment - Amount",
            "description": "For payments of type permanent (fixed) this represents the pay amount.",
            "type": "float",
            "format": "float",
            "editable": false
        },
        "rate": {
            "label": "Rated Payment - Pay Rate",
            "description": "For payments of type rated this represents the payment rate.",
            "type": "float",
            "format": "float",
            "editable": false
        },
        "day_types": {
            "label": "Valid on Weekdays",
            "description": "The wage type only applies on week days specified here. If no day is specified it`s valid on all days. 1 is Monday, 7 is Sunday",
            "type": "object",
            "editable": false
        },
        "is_controllable": {
            "label": "Is Controllable",
            "description": "Can be enabled or disabled per assignment",
            "type": "int",
            "format": "bool",
            "editable": false
        },
        "is_active": {
            "label": "Is Activated by Default",
            "description": "For controllable wages: determines the default state, enabled or disabled.",
            "type": "int",
            "format": "bool",
            "editable": false
        },
        "is_proposable": {
            "label": "Is Proposable",
            "description": "Wage type can be selected when submitting work data.",
            "type": "int",
            "format": "bool",
            "editable": false
        },
        "is_dynamic": {
            "label": "Is Dynamic",
            "description": "Wage value is determined by a conditional attribute.",
            "type": "int",
            "format": "bool",
            "editable": false
        },
        "is_quota_relevant": {
            "label": "Is Quota Relevant",
            "description": "This wage type counts as a work quota.",
            "type": "int",
            "format": "bool",
            "editable": false
        },
        "is_factor_editable": {
            "label": "Is rate factor editable",
            "description": "For rated wages, allows the factor to be edited manually.",
            "type": "int",
            "format": "bool",
            "editable": false
        },
        "valid_from": {
            "label": "Valid From Time",
            "description": "The wage type is valid starting with this time.",
            "type": "string",
            "format": "time",
            "editable": false
        },
        "valid_to": {
            "label": "Valid To Time",
            "description": "The wage type is valid until this time.",
            "type": "string",
            "format": "time",
            "editable": false
        },
        "currency_format": {
            "label": "Currency Format",
            "type": "string",
            "format": "string",
            "editable": false
        },
        "wage_type_values": {
            "label": "Wage values",
            "description": "This can contain one value object if the wage is not dynamic or multiple value object together with the conditions they apply for if this is a dynamic wage type.",
            "type": "object",
            "editable": false,
            "properties": {
                "id": {
                    "label": "ID",
                    "editable": false,
                    "type": "identityField",
                    "format": "int"
                },
                "amount": {
                    "label": "Permanent Payment - Amount",
                    "description": "For payments of type permanent (fixed) this represents the pay amount.",
                    "editable": false,
                    "type": "float",
                    "format": "float"
                },
                "rate": {
                    "label": "Rated Payment - Pay Rate",
                    "description": "For payments of type rated this represents the payment rate.",
                    "editable": false,
                    "type": "float",
                    "format": "float"
                },
                "rate_base": {
                    "label": "Rated Payment - Pay Rate Base",
                    "description": "For payments of type rated this represents rate base. (worked hours, traveled distance, etc)",
                    "editable": false,
                    "type": "string",
                    "format": "string"
                },
                "unit": {
                    "label": "Rated Payment - Pay Rate Unit",
                    "description": "For payments of type rated this represents rate unit. (hours, km, etc)",
                    "editable": false,
                    "type": "string",
                    "format": "string"
                },
                "wage_type_condition": {
                    "label": "For dynamic wages - the conditions that apply for this wage.",
                    "description": "The conditions that apply for this wage.",
                    "type": "object",
                    "editable": false,
                    "properties": {
                        "attribute_id": {
                            "label": "Conditioning attribute ID",
                            "description": "The attribute that provides the value used as a basis for this condition.",
                            "editable": false,
                            "type": "int",
                            "format": "int"
                        },
                        "operator": {
                            "label": "Condition operator",
                            "description": "The operator used to compare the value provided by the conditioning attribute and the reference value(s)",
                            "editable": false,
                            "type": "int",
                            "format": "int"
                        },
                        "value": {
                            "label": "Reference value for the condition",
                            "description": "This is the value we compare the attribute value with.",
                            "editable": false,
                            "type": "float",
                            "format": "float"
                        },
                        "value_second": {
                            "label": "Second reference value for the condition.",
                            "description": "Only necessary for operators that require two values, like \"between\"",
                            "editable": false,
                            "type": "float",
                            "format": "float"
                        },
                        "options": {
                            "label": "Additional options",
                            "description": "Can contain some additional option pertaining to the current condition.",
                            "editable": false,
                            "type": "object"
                        }
                    }
                }
            }
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
name	`Read Only`	string (string)	Name
external_id	`Read Only`	string (string)	External ID
external_cost		(string)	External cost
type	`Read Only`	string	Payment Type
base_type	`Read Only`	string	Base Value Type
rate_base	`Read Only`	string	Rate Base
amount	`Read Only`	float (float)	Permanent Payment - Amount For payments of type permanent (fixed) this represents the pay amount.
rate	`Read Only`	float (float)	Rated Payment - Pay Rate For payments of type rated this represents the payment rate.
day_types	`Read Only`	object	Valid on Weekdays The wage type only applies on week days specified here. If no day is specified it`s valid on all days. 1 is Monday, 7 is Sunday
is_controllable	`Read Only`	int (bool)	Is Controllable Can be enabled or disabled per assignment
is_active	`Read Only`	int (bool)	Is Activated by Default For controllable wages: determines the default state, enabled or disabled.
is_proposable	`Read Only`	int (bool)	Is Proposable Wage type can be selected when submitting work data.
is_dynamic	`Read Only`	int (bool)	Is Dynamic Wage value is determined by a conditional attribute.
is_quota_relevant	`Read Only`	int (bool)	Is Quota Relevant This wage type counts as a work quota.
is_factor_editable	`Read Only`	int (bool)	Is rate factor editable For rated wages, allows the factor to be edited manually.
valid_from	`Read Only`	string (time)	Valid From Time The wage type is valid starting with this time.
valid_to	`Read Only`	string (time)	Valid To Time The wage type is valid until this time.
currency_format	`Read Only`	string (string)	Currency Format
wage_type_values	`Read Only`	object	Wage values This can contain one value object if the wage is not dynamic or multiple value object together with the conditions they apply for if this is a dynamic wage type.

Relations

Name	Resource	Foreign Key	Description
wageTypeProfiles	wage-profiles

Actions

Request	Description
`GET /wage-types`	Resource listing
`GET /wage-types/<id>`	Resource read
`POST /wage-types`	Resource create
`PUT /wage-types/<id>`	Resource update
`DELETE /wage-types/<id>`	Resource delete

Webhooks

Schema

Webhooks schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "trigger": {
            "label": "Trigger",
            "editable": true,
            "type": "object",
            "format": "object"
        },
        "webhook": {
            "label": "Webhook",
            "editable": true,
            "type": "object",
            "format": "object"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
trigger		object (object)	Trigger
webhook		object (object)	Webhook

Actions

Request	Description
`GET /webhooks`	Resource listing
`GET /webhooks/<id>`	Resource read
`POST /webhooks`	Resource create
`PUT /webhooks/<id>`	Resource update
`DELETE /webhooks/<id>`	Resource delete

Work quota profiles

Schema

Work-quota-profiles schema

{
    "properties": {
        "id": {
            "label": "ID",
            "type": "identityField",
            "format": "int",
            "editable": false
        },
        "employee_id": {
            "label": "Employee Id",
            "type": "foreignKey",
            "format": "int",
            "editable": false
        },
        "work_quota_profile_id": {
            "label": "Work Quota Profile ID",
            "type": "foreignKey",
            "format": "int",
            "editable": false
        },
        "name": {
            "label": "Name",
            "type": "string",
            "format": "string",
            "editable": false
        },
        "valid_from": {
            "label": "Valid From",
            "type": "string",
            "format": "datetime",
            "editable": false
        },
        "valid_to": {
            "label": "Valid To",
            "type": "string",
            "format": "datetime",
            "editable": false
        },
        "valid_from_date": {
            "label": "Valid From Date",
            "type": "string",
            "format": "date",
            "editable": false,
            "source": "valid_from"
        },
        "valid_from_time": {
            "label": "Valid From Time",
            "type": "string",
            "format": "time",
            "editable": false,
            "source": "valid_from"
        },
        "valid_to_date": {
            "label": "Valid To Date",
            "type": "string",
            "format": "date",
            "editable": false,
            "source": "valid_to"
        },
        "valid_to_time": {
            "label": "Valid To Time",
            "type": "string",
            "format": "time",
            "editable": false,
            "source": "valid_to"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
employee_id	`Read Only`	foreignKey (int)	Employee Id
work_quota_profile_id	`Read Only`	foreignKey (int)	Work Quota Profile ID
name	`Read Only`	string (string)	Name
valid_from	`Read Only`	string (datetime)	Valid From
valid_to	`Read Only`	string (datetime)	Valid To
valid_from_date	`Read Only`	string (date)	Valid From Date
valid_from_time	`Read Only`	string (time)	Valid From Time
valid_to_date	`Read Only`	string (date)	Valid To Date
valid_to_time	`Read Only`	string (time)	Valid To Time

Relations

Name	Resource	Foreign Key	Description
workQuotaProfilesEmployee	employees	work-quota-profiles.employee_id

Actions

Request	Description
`GET /work-quota-profiles`	Resource listing
`GET /work-quota-profiles/<id>`	Resource read
`POST /work-quota-profiles`	Resource create
`PUT /work-quota-profiles/<id>`	Resource update
`DELETE /work-quota-profiles/<id>`	Resource delete

Work time proposals

Schema

Work-time-proposals schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "assignment_id": {
            "label": "Assignment ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "planner_id": {
            "label": "Planner ID",
            "description": "The ID of the planner who accepted\/rejected the proposal",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "start": {
            "label": "Start Date-Time",
            "editable": true,
            "description": "The proposed assignment start time.",
            "type": "string",
            "format": "date-time"
        },
        "end": {
            "label": "End Date-Time",
            "editable": true,
            "description": "The proposed assignment end time.",
            "type": "string",
            "format": "date-time"
        },
        "break_start": {
            "label": "Break Start Date-Time",
            "editable": true,
            "description": "The proposed assignment break start time.",
            "type": "string",
            "format": "date-time"
        },
        "break_end": {
            "label": "Break End Date-Time",
            "editable": true,
            "description": "The proposed assignment break end time.",
            "type": "string",
            "format": "date-time"
        },
        "remarks": {
            "label": "Remarks",
            "editable": true,
            "description": "The assignment proposal remarks.",
            "type": "string",
            "format": "string"
        },
        "requested_updates": {
            "label": "Requested updates",
            "editable": false,
            "description": "The assignment proposal requested updates.",
            "type": "string",
            "format": "string"
        },
        "source": {
            "label": "Source",
            "editable": true,
            "description": "The assignment proposal creation source.",
            "type": "string",
            "enum": [
                "employee_mobile_app",
                "employee_web_app",
                "tla"
            ],
            "format": "string"
        },
        "created_at": {
            "label": "Created at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was created.",
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was last updated.",
            "type": "string",
            "format": "date-time"
        },
        "accepted_at": {
            "label": "Accepted at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was accepted.",
            "type": "string",
            "format": "date-time"
        },
        "rejected_at": {
            "label": "Rejected at Date-Time",
            "editable": false,
            "description": "The date and time when the proposal was rejected.",
            "type": "string",
            "format": "date-time"
        },
        "rejected": {
            "label": "Rejected",
            "editable": false,
            "description": "Contains the times which were rejected when the proposal was accepted.",
            "type": "array",
            "format": "array"
        },
        "start_date": {
            "label": "Start Date-Time Date",
            "editable": true,
            "description": "The proposed assignment start time.",
            "type": "string",
            "format": "date",
            "source": "start"
        },
        "start_time": {
            "label": "Start Date-Time Time",
            "editable": true,
            "description": "The proposed assignment start time.",
            "type": "string",
            "format": "time",
            "source": "start"
        },
        "end_date": {
            "label": "End Date-Time Date",
            "editable": true,
            "description": "The proposed assignment end time.",
            "type": "string",
            "format": "date",
            "source": "end"
        },
        "end_time": {
            "label": "End Date-Time Time",
            "editable": true,
            "description": "The proposed assignment end time.",
            "type": "string",
            "format": "time",
            "source": "end"
        },
        "break_start_date": {
            "label": "Break Start Date-Time Date",
            "editable": true,
            "description": "The proposed assignment break start time.",
            "type": "string",
            "format": "date",
            "source": "break_start"
        },
        "break_start_time": {
            "label": "Break Start Date-Time Time",
            "editable": true,
            "description": "The proposed assignment break start time.",
            "type": "string",
            "format": "time",
            "source": "break_start"
        },
        "break_end_date": {
            "label": "Break End Date-Time Date",
            "editable": true,
            "description": "The proposed assignment break end time.",
            "type": "string",
            "format": "date",
            "source": "break_end"
        },
        "break_end_time": {
            "label": "Break End Date-Time Time",
            "editable": true,
            "description": "The proposed assignment break end time.",
            "type": "string",
            "format": "time",
            "source": "break_end"
        },
        "created_at_date": {
            "label": "Created at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was created.",
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was created.",
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was last updated.",
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was last updated.",
            "type": "string",
            "format": "time",
            "source": "updated_at"
        },
        "accepted_at_date": {
            "label": "Accepted at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was accepted.",
            "type": "string",
            "format": "date",
            "source": "accepted_at"
        },
        "accepted_at_time": {
            "label": "Accepted at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was accepted.",
            "type": "string",
            "format": "time",
            "source": "accepted_at"
        },
        "rejected_at_date": {
            "label": "Rejected at Date-Time Date",
            "editable": false,
            "description": "The date and time when the proposal was rejected.",
            "type": "string",
            "format": "date",
            "source": "rejected_at"
        },
        "rejected_at_time": {
            "label": "Rejected at Date-Time Time",
            "editable": false,
            "description": "The date and time when the proposal was rejected.",
            "type": "string",
            "format": "time",
            "source": "rejected_at"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
assignment_id	`Read Only`	foreignKey (int)	Assignment ID
planner_id	`Read Only`	foreignKey (int)	Planner ID The ID of the planner who accepted/rejected the proposal
start		string (date-time)	Start Date-Time The proposed assignment start time.
end		string (date-time)	End Date-Time The proposed assignment end time.
break_start		string (date-time)	Break Start Date-Time The proposed assignment break start time.
break_end		string (date-time)	Break End Date-Time The proposed assignment break end time.
remarks		string (string)	Remarks The assignment proposal remarks.
requested_updates	`Read Only`	string (string)	Requested updates The assignment proposal requested updates.
source		string (string)	Source The assignment proposal creation source.
created_at	`Read Only`	string (date-time)	Created at Date-Time The date and time when the proposal was created.
updated_at	`Read Only`	string (date-time)	Updated at Date-Time The date and time when the proposal was last updated.
accepted_at	`Read Only`	string (date-time)	Accepted at Date-Time The date and time when the proposal was accepted.
rejected_at	`Read Only`	string (date-time)	Rejected at Date-Time The date and time when the proposal was rejected.
rejected	`Read Only`	array (array)	Rejected Contains the times which were rejected when the proposal was accepted.
start_date		string (date)	Start Date-Time Date The proposed assignment start time.
start_time		string (time)	Start Date-Time Time The proposed assignment start time.
end_date		string (date)	End Date-Time Date The proposed assignment end time.
end_time		string (time)	End Date-Time Time The proposed assignment end time.
break_start_date		string (date)	Break Start Date-Time Date The proposed assignment break start time.
break_start_time		string (time)	Break Start Date-Time Time The proposed assignment break start time.
break_end_date		string (date)	Break End Date-Time Date The proposed assignment break end time.
break_end_time		string (time)	Break End Date-Time Time The proposed assignment break end time.
created_at_date	`Read Only`	string (date)	Created at Date-Time Date The date and time when the proposal was created.
created_at_time	`Read Only`	string (time)	Created at Date-Time Time The date and time when the proposal was created.
updated_at_date	`Read Only`	string (date)	Updated at Date-Time Date The date and time when the proposal was last updated.
updated_at_time	`Read Only`	string (time)	Updated at Date-Time Time The date and time when the proposal was last updated.
accepted_at_date	`Read Only`	string (date)	Accepted at Date-Time Date The date and time when the proposal was accepted.
accepted_at_time	`Read Only`	string (time)	Accepted at Date-Time Time The date and time when the proposal was accepted.
rejected_at_date	`Read Only`	string (date)	Rejected at Date-Time Date The date and time when the proposal was rejected.
rejected_at_time	`Read Only`	string (time)	Rejected at Date-Time Time The date and time when the proposal was rejected.

Relations

Name	Resource	Foreign Key	Description
workTimeProposalAssignment	assignments	work-time-proposals.assignment_id
workTimeProposalPlanner	planners	work-time-proposals.planner_id

Actions

Request	Description
`GET /work-time-proposals`	Resource listing
`GET /work-time-proposals/<id>`	Resource read
`POST /work-time-proposals`	Resource create
`PUT /work-time-proposals/<id>`	Resource update
`DELETE /work-time-proposals/<id>`	Resource delete
`PUT /work-time-proposals/<id>/accept`	Accept an assignment work time proposal.
`PUT /work-time-proposals/<id>/reject`	Reject an assignment work time proposal.
`POST /work-time-proposals/<id>/request-updates`	Request updates for an assignment work time proposal.

Work times

Schema

Work-times schema

{
    "properties": {
        "id": {
            "label": "ID",
            "editable": false,
            "type": "identityField",
            "format": "int"
        },
        "event_function_employee_id": {
            "label": "Assignment ID",
            "editable": false,
            "type": "foreignKey",
            "format": "int"
        },
        "start": {
            "label": "Work Start Date-Time",
            "editable": false,
            "description": "The assignments work start time.",
            "type": "string",
            "format": "date-time"
        },
        "end": {
            "label": "Work End Date-Time",
            "editable": false,
            "description": "The assignments work end time.",
            "type": "string",
            "format": "date-time"
        },
        "work_time": {
            "label": "Work Time including breaks",
            "editable": false,
            "description": "The assignments work time including breaks.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "work_time_without_break": {
            "label": "Work Time excluding breaks",
            "editable": false,
            "description": "The assignments work time excluding breaks.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "break_start": {
            "label": "Break Start Date-Time",
            "editable": false,
            "description": "The assignments break start time.",
            "type": "string",
            "format": "date-time"
        },
        "break_end": {
            "label": "Break End Date-Time",
            "editable": false,
            "description": "The assignments break end time.",
            "type": "string",
            "format": "date-time"
        },
        "break_time": {
            "label": "Break Time",
            "editable": false,
            "description": "The assignments break time.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "remarks": {
            "label": "Work Times Remarks",
            "editable": false,
            "description": "Optional remarks for the work times.",
            "type": "string"
        },
        "is_approved": {
            "label": "Is Approved",
            "editable": false,
            "description": "Whether the work times were approved or not.",
            "type": "int",
            "format": "bool"
        },
        "approved_on": {
            "label": "Approved On Date-Time",
            "editable": false,
            "description": "The date and time when the work times were approved.",
            "type": "string",
            "format": "date-time"
        },
        "approved_by_planner_id": {
            "label": "Approved By Planner ID",
            "editable": false,
            "description": "The ID of the planner that approved the work times.",
            "type": "int"
        },
        "created_at": {
            "label": "Created Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "updated_at": {
            "label": "Updated Date-Time",
            "editable": false,
            "type": "string",
            "format": "date-time"
        },
        "proposal_work_start": {
            "label": "Proposed Work Start Date-Time",
            "editable": false,
            "description": "The proposed work start time.",
            "type": "string",
            "format": "date-time"
        },
        "proposal_work_end": {
            "label": "Proposed Work End Date-Time",
            "editable": false,
            "description": "The proposed work end time.",
            "type": "string",
            "format": "date-time"
        },
        "proposal_work_time": {
            "label": "Proposed Work Time",
            "editable": false,
            "description": "The proposed work time.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "proposal_break_start": {
            "label": "Proposed Break Start Date-Time",
            "editable": false,
            "description": "The proposed break start time.",
            "type": "string",
            "format": "date-time"
        },
        "proposal_break_end": {
            "label": "Proposed Break End Date-Time",
            "editable": false,
            "description": "The proposed break end time.",
            "type": "string",
            "format": "date-time"
        },
        "proposal_break_time": {
            "label": "Proposed Break Time",
            "editable": false,
            "description": "The proposed break time.",
            "type": "string",
            "format": "fromHoursIntervalToHumans"
        },
        "employee_remarks": {
            "label": "Employee Remarks",
            "editable": false,
            "description": "Remarks submitted by the employee when sending work data.",
            "type": "string"
        },
        "start_date": {
            "label": "Work Start Date-Time Date",
            "editable": false,
            "description": "The assignments work start time.",
            "type": "string",
            "format": "date",
            "source": "start"
        },
        "start_time": {
            "label": "Work Start Date-Time Time",
            "editable": false,
            "description": "The assignments work start time.",
            "type": "string",
            "format": "time",
            "source": "start"
        },
        "end_date": {
            "label": "Work End Date-Time Date",
            "editable": false,
            "description": "The assignments work end time.",
            "type": "string",
            "format": "date",
            "source": "end"
        },
        "end_time": {
            "label": "Work End Date-Time Time",
            "editable": false,
            "description": "The assignments work end time.",
            "type": "string",
            "format": "time",
            "source": "end"
        },
        "break_start_date": {
            "label": "Break Start Date-Time Date",
            "editable": false,
            "description": "The assignments break start time.",
            "type": "string",
            "format": "date",
            "source": "break_start"
        },
        "break_start_time": {
            "label": "Break Start Date-Time Time",
            "editable": false,
            "description": "The assignments break start time.",
            "type": "string",
            "format": "time",
            "source": "break_start"
        },
        "break_end_date": {
            "label": "Break End Date-Time Date",
            "editable": false,
            "description": "The assignments break end time.",
            "type": "string",
            "format": "date",
            "source": "break_end"
        },
        "break_end_time": {
            "label": "Break End Date-Time Time",
            "editable": false,
            "description": "The assignments break end time.",
            "type": "string",
            "format": "time",
            "source": "break_end"
        },
        "approved_on_date": {
            "label": "Approved On Date-Time Date",
            "editable": false,
            "description": "The date and time when the work times were approved.",
            "type": "string",
            "format": "date",
            "source": "approved_on"
        },
        "approved_on_time": {
            "label": "Approved On Date-Time Time",
            "editable": false,
            "description": "The date and time when the work times were approved.",
            "type": "string",
            "format": "time",
            "source": "approved_on"
        },
        "created_at_date": {
            "label": "Created Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "created_at"
        },
        "created_at_time": {
            "label": "Created Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "created_at"
        },
        "updated_at_date": {
            "label": "Updated Date-Time Date",
            "editable": false,
            "type": "string",
            "format": "date",
            "source": "updated_at"
        },
        "updated_at_time": {
            "label": "Updated Date-Time Time",
            "editable": false,
            "type": "string",
            "format": "time",
            "source": "updated_at"
        },
        "proposal_work_start_date": {
            "label": "Proposed Work Start Date-Time Date",
            "editable": false,
            "description": "The proposed work start time.",
            "type": "string",
            "format": "date",
            "source": "proposal_work_start"
        },
        "proposal_work_start_time": {
            "label": "Proposed Work Start Date-Time Time",
            "editable": false,
            "description": "The proposed work start time.",
            "type": "string",
            "format": "time",
            "source": "proposal_work_start"
        },
        "proposal_work_end_date": {
            "label": "Proposed Work End Date-Time Date",
            "editable": false,
            "description": "The proposed work end time.",
            "type": "string",
            "format": "date",
            "source": "proposal_work_end"
        },
        "proposal_work_end_time": {
            "label": "Proposed Work End Date-Time Time",
            "editable": false,
            "description": "The proposed work end time.",
            "type": "string",
            "format": "time",
            "source": "proposal_work_end"
        },
        "proposal_break_start_date": {
            "label": "Proposed Break Start Date-Time Date",
            "editable": false,
            "description": "The proposed break start time.",
            "type": "string",
            "format": "date",
            "source": "proposal_break_start"
        },
        "proposal_break_start_time": {
            "label": "Proposed Break Start Date-Time Time",
            "editable": false,
            "description": "The proposed break start time.",
            "type": "string",
            "format": "time",
            "source": "proposal_break_start"
        },
        "proposal_break_end_date": {
            "label": "Proposed Break End Date-Time Date",
            "editable": false,
            "description": "The proposed break end time.",
            "type": "string",
            "format": "date",
            "source": "proposal_break_end"
        },
        "proposal_break_end_time": {
            "label": "Proposed Break End Date-Time Time",
            "editable": false,
            "description": "The proposed break end time.",
            "type": "string",
            "format": "time",
            "source": "proposal_break_end"
        }
    }
}

Fields

Name	Properties	Type	Description
id	`Read Only`	identityField (int)	ID
event_function_employee_id	`Read Only`	foreignKey (int)	Assignment ID
start	`Read Only`	string (date-time)	Work Start Date-Time The assignments work start time.
end	`Read Only`	string (date-time)	Work End Date-Time The assignments work end time.
work_time	`Read Only`	string (fromHoursIntervalToHumans)	Work Time including breaks The assignments work time including breaks.
work_time_without_break	`Read Only`	string (fromHoursIntervalToHumans)	Work Time excluding breaks The assignments work time excluding breaks.
break_start	`Read Only`	string (date-time)	Break Start Date-Time The assignments break start time.
break_end	`Read Only`	string (date-time)	Break End Date-Time The assignments break end time.
break_time	`Read Only`	string (fromHoursIntervalToHumans)	Break Time The assignments break time.
remarks	`Read Only`	string	Work Times Remarks Optional remarks for the work times.
is_approved	`Read Only`	int (bool)	Is Approved Whether the work times were approved or not.
approved_on	`Read Only`	string (date-time)	Approved On Date-Time The date and time when the work times were approved.
approved_by_planner_id	`Read Only`	int	Approved By Planner ID The ID of the planner that approved the work times.
created_at	`Read Only`	string (date-time)	Created Date-Time
updated_at	`Read Only`	string (date-time)	Updated Date-Time
proposal_work_start	`Read Only`	string (date-time)	Proposed Work Start Date-Time The proposed work start time.
proposal_work_end	`Read Only`	string (date-time)	Proposed Work End Date-Time The proposed work end time.
proposal_work_time	`Read Only`	string (fromHoursIntervalToHumans)	Proposed Work Time The proposed work time.
proposal_break_start	`Read Only`	string (date-time)	Proposed Break Start Date-Time The proposed break start time.
proposal_break_end	`Read Only`	string (date-time)	Proposed Break End Date-Time The proposed break end time.
proposal_break_time	`Read Only`	string (fromHoursIntervalToHumans)	Proposed Break Time The proposed break time.
employee_remarks	`Read Only`	string	Employee Remarks Remarks submitted by the employee when sending work data.
start_date	`Read Only`	string (date)	Work Start Date-Time Date The assignments work start time.
start_time	`Read Only`	string (time)	Work Start Date-Time Time The assignments work start time.
end_date	`Read Only`	string (date)	Work End Date-Time Date The assignments work end time.
end_time	`Read Only`	string (time)	Work End Date-Time Time The assignments work end time.
break_start_date	`Read Only`	string (date)	Break Start Date-Time Date The assignments break start time.
break_start_time	`Read Only`	string (time)	Break Start Date-Time Time The assignments break start time.
break_end_date	`Read Only`	string (date)	Break End Date-Time Date The assignments break end time.
break_end_time	`Read Only`	string (time)	Break End Date-Time Time The assignments break end time.
approved_on_date	`Read Only`	string (date)	Approved On Date-Time Date The date and time when the work times were approved.
approved_on_time	`Read Only`	string (time)	Approved On Date-Time Time The date and time when the work times were approved.
created_at_date	`Read Only`	string (date)	Created Date-Time Date
created_at_time	`Read Only`	string (time)	Created Date-Time Time
updated_at_date	`Read Only`	string (date)	Updated Date-Time Date
updated_at_time	`Read Only`	string (time)	Updated Date-Time Time
proposal_work_start_date	`Read Only`	string (date)	Proposed Work Start Date-Time Date The proposed work start time.
proposal_work_start_time	`Read Only`	string (time)	Proposed Work Start Date-Time Time The proposed work start time.
proposal_work_end_date	`Read Only`	string (date)	Proposed Work End Date-Time Date The proposed work end time.
proposal_work_end_time	`Read Only`	string (time)	Proposed Work End Date-Time Time The proposed work end time.
proposal_break_start_date	`Read Only`	string (date)	Proposed Break Start Date-Time Date The proposed break start time.
proposal_break_start_time	`Read Only`	string (time)	Proposed Break Start Date-Time Time The proposed break start time.
proposal_break_end_date	`Read Only`	string (date)	Proposed Break End Date-Time Date The proposed break end time.
proposal_break_end_time	`Read Only`	string (time)	Proposed Break End Date-Time Time The proposed break end time.

Relations

Name	Resource	Foreign Key	Description
workTimesAssignment	assignments	work-times.event_function_employee_id

Actions

Request	Description
`GET /work-times`	Resource listing
`GET /work-times/<id>`	Resource read
`POST /work-times`	Resource create
`PUT /work-times/<id>`	Resource update
`DELETE /work-times/<id>`	Resource delete