List Working Time Arrangements.

Status

Introduction

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

Timmi Timesheet API

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

GET

timmi-settings

api

working-time-arrangements

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-settings/api/working-time-arrangements

{
  "items": [
    {
      "id": 1,
      "name": "<string>",
      "description": "<string>",
      "unit": "day",
      "referencePeriod": {
        "frequencyType": "week",
        "firstDayOfWeek": "monday"
      },
      "contractWorkingTimeDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      },
      "referenceWorkingTimeDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      },
      "fullTimeEquivalent": 0.5,
      "fullDayAbsenceDurationInHours": 1,
      "publicHolidaysCalendar": {
        "id": 1,
        "name": "<string>"
      },
      "isPartTime": true,
      "isArchived": true,
      "isScheduleValid": true,
      "currentAssignmentsCount": 123,
      "timesheetRegulation": {
        "id": 1,
        "name": "<string>"
      },
      "currentSchedulePatternSummary": {
        "shape": "singleWeek",
        "days": [
          {
            "dayOffType": "off",
            "workPosition": "firstHalf",
            "workDuration": 1
          }
        ]
      },
      "authorizedCommands": [
        "create"
      ],
      "": "<string>"
    }
  ]
}

Query Parameters

string

Find a working time arrangement based on its name.

isPartTime

boolean

When true, only returns part-time working time arrangements.

unit

enum<string>

Filter working time arrangements on their unit.

Available options:

day,

hour,

time

isArchived

boolean

Filter Working Time Arrangements on their archival status. If omitted, both archived and non-archived ones are retrieved.

currentlyAssignedOnly

boolean

Filter Working Time Arrangements assigned to a current work contract and thus to a user

sort

enum<string>

Sort items by property.

Available options:

id,

-id

page

string

Next page token

Example:

"next_token&fields.root=next"

limit

integer

default:10

Number of items per page

Required range: 0 <= x <= 100

fields.root

enum<string>

Include collection properties.

Available options:

count

Response

200

application/json

items

object[]

A working time arrangement is an object aimed at drawing employees populations regarding time management rules.

It is attached to employees through their work contract and essentially dictates:

their contractual working time, ie how many hours / days they are paid for each week / year.
a full time equivalent based on the the ratio between this contractual work duration and a "full time work duration".
a succession of Collective Schedules that describe their usual working hours.
the applicable regulation in Timmi Timesheet.

items.id

integer

required

The unique identifier of this Working Time Arrangement.

Required range: x >= 0

items.name

string

required

The unique name for this Working Time Arrangement.

Required string length: 3 - 1000

items.description

string | null

required

An optional description.

Maximum length: 5000

items.unit

enum<string>

required

An event can be set in:

Day: "I worked for a half day last Monday".
Hour: "I worked for 2 hours last Monday".
Time: "I worked between 10:00 AM and 12:00 AM last Monday".

Available options:

day,

hour,

time

items.fullTimeEquivalent

number

required

By default, equal to the ratio between the Contract Working Time Duration and the Reference Working Time Duration.

Required range: 0 <= x <= 1Must be a multiple of 0.0001

items.publicHolidaysCalendar

object

required

Unique identifier of the Public Holidays Calendar applicable to these employees.

items.isPartTime

boolean

required

True whenever the Full Time Equivalent is below 1 (eg <100%).

items.isArchived

boolean

required

True whenever this Working Time Arrangement should no longer be given to employees.

items.isScheduleValid

boolean

required

False if there is not at least one Collective Schedule. In this case, the Working Time Arrangement can't be given to any employee through his Work Contract.

items.authorizedCommands

enum<string>[]

required

The actions the current authenticated User can make on this Working Time Arrangement. Depends on his permissions.

Available options:

create,

update,

delete,

archive,

unarchive

items.referencePeriod

object | null

The period the Contract Working Time Duration applies over.

items.contractWorkingTimeDuration

object

How many hours / days these employees are paid for every Reference Period?

items.referenceWorkingTimeDuration

object

The number of hours / days for a full-time employee over the same Reference Period.

items.fullDayAbsenceDurationInHours

number | null

Duration in hours of a full day of absence. When left null, is equal to the number of hours indicated on the given day in the applicable Collective Schedule.

Required range: x >= 0Must be a multiple of 0.0001

items.currentAssignmentsCount

integer

items.timesheetRegulation

object

The applicable Timmi Timesheet regulation, which contains all rules regarding time tracking management in this application.

items.currentSchedulePatternSummary

object

A summary of the expected working hours, given the currently ongoing Schedule Pattern.

Was this page helpful?

The working-time-arrangement resource Get a Working Time Arrangement by id.

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-settings/api/working-time-arrangements

{
  "items": [
    {
      "id": 1,
      "name": "<string>",
      "description": "<string>",
      "unit": "day",
      "referencePeriod": {
        "frequencyType": "week",
        "firstDayOfWeek": "monday"
      },
      "contractWorkingTimeDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      },
      "referenceWorkingTimeDuration": {
        "value": 1,
        "iso": "<string>",
        "unit": "days"
      },
      "fullTimeEquivalent": 0.5,
      "fullDayAbsenceDurationInHours": 1,
      "publicHolidaysCalendar": {
        "id": 1,
        "name": "<string>"
      },
      "isPartTime": true,
      "isArchived": true,
      "isScheduleValid": true,
      "currentAssignmentsCount": 123,
      "timesheetRegulation": {
        "id": 1,
        "name": "<string>"
      },
      "currentSchedulePatternSummary": {
        "shape": "singleWeek",
        "days": [
          {
            "dayOffType": "off",
            "workPosition": "firstHalf",
            "workDuration": 1
          }
        ]
      },
      "authorizedCommands": [
        "create"
      ],
      "": "<string>"
    }
  ]
}