Time Management

These endpoints let you manage time management features in the system. It consists of various sub-modules related to attendance, shifts, workday configurations, and more.

Get Attendance Recapitulation Detail

get

Search Query

Supported Keys

Supported Operators

Notes

employee.id

Equal to

date

> <

Greater than or equal to Less than or equal to

attendances.type

Equal to, supported values: ABSENT, ANNUAL_LEAVE, COMPENSATORY_LEAVE, PRESENT

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/attendance-recapitulations/details

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/attendance-recapitulations/details" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "employee": {
        "id": "c8dec69f-8452-4832-bb6a-d73eb4b20b4d",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "date": "2017-01-01",
      "shift": {
        "id": "9a1bedac-e984-41ab-97db-988bf2468b7a",
        "code": "1",
        "name": "Shift 1",
        "timeIn": "08:00:00",
        "timeInUtc": 28800000,
        "timeOut": "17:00:00",
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#010101"
      },
      "overtime": {
        "requested": 3600000,
        "paid": 3600000,
        "description": "Extra hours for project deadline"
      },
      "attendances": [
        {
          "type": "ANNUAL_LEAVE",
          "code": "",
          "timeIn": "",
          "timeOut": "",
          "description": "DESCRIPTION"
        }
      ]
    },
    {
      "employee": {
        "id": "c8dec69f-8452-4832-bb6a-d73eb4b20b4d",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "date": "2017-01-02",
      "shift": {
        "id": "9a1bedac-e984-41ab-97db-988bf2468b7a",
        "code": "1",
        "name": "Shift 1",
        "timeIn": "08:00:00",
        "timeInUtc": 28800000,
        "timeOut": "17:00:00",
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#010101"
      },
      "overtime": {
        "requested": 3600000,
        "paid": 3600000,
        "description": "Extra hours for project deadline"
      },
      "attendances": [
        {
          "type": "PRESENT",
          "code": "HDR",
          "timeIn": "2017-01-02T08:00:00+07:00",
          "timeOut": "2017-01-02T12:00:00+07:00",
          "description": "DESCRIPTION"
        },
        {
          "type": "ANNUAL_LEAVE",
          "code": "",
          "timeIn": "2017-01-02T13:00:00+07:00",
          "timeOut": "2017-01-02T17:00:00+07:00",
          "description": "DESCRIPTION"
        }
      ]
    },
    {
      "employee": {
        "id": "c8dec69f-8452-4832-bb6a-d73eb4b20b4d",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "date": "2017-01-03",
      "shift": {
        "id": "9a1bedac-e984-41ab-97db-988bf2468b7a",
        "code": "1",
        "name": "Shift 1",
        "timeIn": "08:00:00",
        "timeInUtc": 28800000,
        "timeOut": "17:00:00",
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#010101"
      },
      "overtime": {
        "requested": 7200000,
        "paid": 7200000,
        "description": "DESCRIPTION"
      },
      "attendances": [
        {
          "type": "PRESENT",
          "code": "HDR",
          "timeIn": "2017-01-03T07:00:00+07:00",
          "timeOut": "2017-01-03T18:00:00+07:00",
          "description": "DESCRIPTION"
        }
      ]
    }
  ],
  "number": 0,
  "size": 10,
  "totalElements": 3,
  "totalPages": 1,
  "first": true,
  "last": true,
  "numberOfElements": 3,
  "pageable": {
    "sort": [
      {
        "direction": "ASC",
        "property": "id"
      }
    ],
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 10,
    "paged": true,
    "unpaged": false
  },
  "empty": false
}

Get Attendances

get

Search Query

Supported Keys

Supported Operators

Notes

employee.identificationNumber

date

> <

Greater than or equal to Less than or equal to

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/attendances

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/attendances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "38c3edb6-6f12-4c27-8299-04aeaf125216",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "date": "2021-02-05",
      "timeIn": "2021-02-05T08:00:00+07:00",
      "timeOut": "",
      "attendanceStatusIn": {
        "id": "c5b989ea-39df-4fd5-9161-d86480908684",
        "code": "HDR",
        "name": "Hadir",
        "attendanceType": "PRESENT"
      }
    },
    {
      "id": "21e4aac6-00c7-41ed-909d-14adda2d752c",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "date": "2021-02-02",
      "timeIn": "2021-02-02T08:00:00Z",
      "timeOut": "",
      "attendanceStatusIn": {
        "id": "c5b989ea-39df-4fd5-9161-d86480908684",
        "code": "HDR",
        "name": "Hadir",
        "attendanceType": "PRESENT"
      }
    },
    {
      "id": "10e817cb-fed5-431e-9338-25c0aba10d22",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "date": "2021-02-04",
      "timeIn": "2021-02-04T08:00:00+07:00",
      "timeOut": "2021-02-04T17:00:00+07:00",
      "attendanceStatusIn": {
        "id": "c5b989ea-39df-4fd5-9161-d86480908684",
        "code": "HDR",
        "name": "Hadir",
        "attendanceType": "PRESENT"
      }
    },
    {
      "id": "08550f93-f580-43a9-8277-cce29c245fe2",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "date": "2021-02-01",
      "timeIn": "2021-02-01T08:00:00Z",
      "timeOut": "2021-02-01T17:00:00Z",
      "attendanceStatusIn": {
        "id": "c5b989ea-39df-4fd5-9161-d86480908684",
        "code": "HDR",
        "name": "Hadir",
        "attendanceType": "PRESENT"
      }
    }
  ],
  "number": 0,
  "size": 10,
  "totalElements": 4,
  "totalPages": 1,
  "first": true,
  "last": true,
  "numberOfElements": 4,
  "pageable": {
    "sort": [
      {
        "direction": "ASC",
        "property": "id"
      }
    ],
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 10,
    "paged": true,
    "unpaged": false
  },
  "empty": false
}

Get Absence Entries

get

Search Query

Supported Keys

Supported Operators

Notes

employee.identificationNumber

approvalStatus

Equal

startDate

> <

Greater than or equal to Less than or equal to

endDate

> <

Greater than or equal to Less than or equal to

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/absence-entries

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/absence-entries" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "38c3edb6-6f12-4c27-8299-04aeaf125216",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "startDate": "2021-02-05",
      "endDate": "2021-02-05",
      "description": "description",
      "approvalStatus": "WAITING_FOR_APPROVAL",
      "rejectionReason": "",
      "attendanceStatus": {
        "id": "c5b989ea-39df-4fd5-9161-d86480908684",
        "code": "SL",
        "name": "Sick Leave",
        "attendanceType": "ABSENT"
      }
    },
    {
      "id": "21e4aac6-00c7-41ed-909d-14adda2d752c",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "startDate": "2021-03-01",
      "endDate": "2021-03-05",
      "description": "description",
      "approvalStatus": "APPROVED",
      "rejectionReason": "",
      "attendanceStatus": {
        "id": "a5b989ea-39df-4fd5-9161-d86480908684",
        "code": "UL",
        "name": "Unpaid Leave",
        "attendanceType": "ABSENT"
      }
    },
    {
      "id": "10e817cb-fed5-431e-9338-25c0aba10d22",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "startDate": "2021-01-05",
      "endDate": "2021-01-05",
      "description": "description",
      "approvalStatus": "WAITING_FOR_APPROVAL",
      "rejectionReason": "",
      "attendanceStatus": {
        "id": "b5b989ea-39df-4fd5-9161-d86480908684",
        "code": "WFH",
        "name": "Work From Home",
        "attendanceType": "ABSENT"
      }
    }
  ],
  "number": 0,
  "size": 10,
  "totalElements": 4,
  "totalPages": 1,
  "first": true,
  "last": true,
  "numberOfElements": 4,
  "pageable": {
    "sort": [
      {
        "direction": "ASC",
        "property": "id"
      }
    ],
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 10,
    "paged": true,
    "unpaged": false
  },
  "empty": false
}

Get Attendance Cancellations

get

Search Query

Supported Keys

Supported Operators

Notes

employee.identificationNumber

approvalStatus

Equal

startDate

> <

Greater than or equal to Less than or equal to

endDate

> <

Greater than or equal to Less than or equal to

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/attendance-cancellations

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/attendance-cancellations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "38c3edb6-6f12-4c27-8299-04aeaf125216",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "createdDate": "2021-02-05",
      "startDate": "2021-02-05",
      "endDate": "2021-02-05",
      "description": "description",
      "approvalStatus": "WAITING_FOR_APPROVAL",
      "rejectionReason": "",
      "attendanceStatus": {
        "id": "c5b989ea-39df-4fd5-9161-d86480908684",
        "code": "SL",
        "name": "Sick Leave",
        "attendanceType": "ABSENT"
      }
    },
    {
      "id": "21e4aac6-00c7-41ed-909d-14adda2d752c",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "createdDate": "2021-03-01",
      "startDate": "2021-03-01",
      "endDate": "2021-03-05",
      "description": "description",
      "approvalStatus": "APPROVED",
      "rejectionReason": "",
      "attendanceStatus": {
        "id": "a5b989ea-39df-4fd5-9161-d86480908684",
        "code": "AL",
        "name": "Annual Leave",
        "attendanceType": "ABSENT"
      }
    },
    {
      "id": "10e817cb-fed5-431e-9338-25c0aba10d22",
      "employee": {
        "id": "0c4b9627-10ad-4886-8299-d838b47097b0",
        "identificationNumber": "1",
        "name": "Employee 1"
      },
      "createdDate": "2021-01-05",
      "startDate": "2021-01-05",
      "endDate": "2021-01-05",
      "description": "description",
      "approvalStatus": "WAITING_FOR_APPROVAL",
      "rejectionReason": "",
      "attendanceStatus": {
        "id": "b5b989ea-39df-4fd5-9161-d86480908684",
        "code": "HDR",
        "name": "Hadir",
        "attendanceType": "PRESENT"
      }
    }
  ],
  "number": 0,
  "size": 10,
  "totalElements": 4,
  "totalPages": 1,
  "first": true,
  "last": true,
  "numberOfElements": 4,
  "pageable": {
    "sort": [
      {
        "direction": "ASC",
        "property": "id"
      }
    ],
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 10,
    "paged": true,
    "unpaged": false
  },
  "empty": false
}

Get Employee Workday Configurations

get

Search Query

Supported Keys

Supported Operators

Notes

startDate

> <

Greater than or equal to Less than or equal to

endDate

> <

Greater than or equal to Less than or equal to

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/employee-workday-configurations

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/employee-workday-configurations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "",
      "startDate": "2021-04-05",
      "endDate": "2021-04-05",
      "shiftPatternTemplate": {
        "id": "",
        "name": "Template 1"
      },
      "workdayConfigurationDetails": [],
      "startSequence": 1,
      "startShift": {
        "id": "",
        "code": "1",
        "name": "Shift 1",
        "timeInUtc": 28800000,
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "includeHoliday": false,
      "includeMissingShift": false,
      "employee": {
        "id": "",
        "identificationNumber": "1",
        "name": "Employee 1"
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Employee Roster Configuration

post

Create an employee roster configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

startDatestringRequired

endDatestringRequired

startSequencenumberRequired

includeHolidaybooleanRequired

includeMissingShiftbooleanRequired

Responses

201

application/json

400

Bad Request

post

/timemanagement/v1/employee-workday-configurations

curl -X POST \
  "https://api.catapa.com/timemanagement/v1/employee-workday-configurations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2017-01-01",
  "endDate": "2017-01-06",
  "shiftPatternTemplate": {
    "id": "34b1cd5e-366a-43d0-8bbe-443cc531b220"
  },
  "startSequence": 1,
  "includeHoliday": false,
  "includeMissingShift": false,
  "employee": {
    "id": "09cf7051-4ac9-4a21-912d-bbeeb05ff97b"
  }
}'

{
  "id": "1c4f157c-903a-427b-8399-1efd4e5dfa84",
  "shiftPatternTemplate": {
    "id": "34b1cd5e-366a-43d0-8bbe-443cc531b220",
    "name": "Pattern Template 1"
  },
  "workdayConfigurationDetails": [
    {
      "shift": {
        "id": "ced2860c-7457-4d07-be16-2e1642173dc0",
        "code": "Shift 1",
        "name": "Shift 1",
        "timeIn": "08:00:00",
        "timeInUtc": 28800000,
        "timeOut": "17:00:00",
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#010101"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift",
        "timeIn": "08:00",
        "timeOut": "17:00"
      },
      "sequence": 1
    }
  ],
  "startDate": "2017-01-01",
  "endDate": "2017-01-06",
  "includeHoliday": false,
  "startSequence": 1,
  "employee": {
    "id": "09cf7051-4ac9-4a21-912d-bbeeb05ff97b",
    "identificationNumber": "EMP001",
    "name": "John Doe"
  },
  "includeMissingShift": false
}

Get Employee Roster Configuration by Id

get

Return the employee roster configuration by Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

idstringOptional

startDatestringOptional

endDatestringOptional

startSequencenumberOptional

includeHolidaybooleanOptional

includeMissingShiftbooleanOptional

400

Bad Request

get

/timemanagement/v1/employee-workday-configurations/{id}

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/employee-workday-configurations/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "",
  "startDate": "2021-04-05",
  "endDate": "2021-04-05",
  "shiftPatternTemplate": {
    "id": "",
    "name": "Template 1"
  },
  "workdayConfigurationDetails": [
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "",
        "code": "1",
        "name": "Shift 1",
        "timeInUtc": 28800000,
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "sequence": 1
    }
  ],
  "startSequence": 0,
  "startShift": {
    "id": "",
    "code": "1",
    "name": "Shift 1",
    "timeInUtc": 28800000,
    "timeOutUtc": 61200000,
    "breakStartUtc": 43200000,
    "breakEndUtc": 46800000,
    "color": "#00c983"
  },
  "includeHoliday": false,
  "includeMissingShift": false,
  "employee": {
    "id": "",
    "identificationNumber": "1",
    "name": "Employee 1"
  }
}

Update Employee Roster Configuration

put

Update the employee roster configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

startDatestringRequired

endDatestringRequired

startSequencenumberRequired

includeHolidaybooleanRequired

includeMissingShiftbooleanRequired

Responses

200

application/json

idstringOptional

startDatestringOptional

endDatestringOptional

startSequencenumberOptional

includeHolidaybooleanOptional

includeMissingShiftbooleanOptional

400

Bad Request

put

/timemanagement/v1/employee-workday-configurations/{id}

curl -X PUT \
  "https://api.catapa.com/timemanagement/v1/employee-workday-configurations/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2021-04-05",
  "endDate": "2021-04-05",
  "shiftPatternTemplate": {
    "id": ""
  },
  "startSequence": 0,
  "includeHoliday": false,
  "includeMissingShift": false,
  "employee": {
    "id": ""
  }
}'

{
  "id": "",
  "startDate": "2021-04-05",
  "endDate": "2021-04-05",
  "shiftPatternTemplate": {
    "id": "",
    "name": "Template 1"
  },
  "workdayConfigurationDetails": [
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "",
        "code": "1",
        "name": "Shift 1",
        "timeInUtc": 28800000,
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "sequence": 1
    }
  ],
  "startSequence": 0,
  "startShift": {
    "id": "",
    "code": "1",
    "name": "Shift 1",
    "timeInUtc": 28800000,
    "timeOutUtc": 61200000,
    "breakStartUtc": 43200000,
    "breakEndUtc": 46800000,
    "color": "#00c983"
  },
  "includeHoliday": false,
  "includeMissingShift": false,
  "employee": {
    "id": "",
    "identificationNumber": "1",
    "name": "Employee 1"
  }
}

Delete Employee Roster Configuration

delete

Delete the employee roster configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

anyOptional

400

Bad Request

delete

/timemanagement/v1/employee-workday-configurations/{id}

curl -X DELETE \
  "https://api.catapa.com/timemanagement/v1/employee-workday-configurations/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{}

Create Attendance Machine Data

post

Create attendance machine data.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

identificationNumberstringRequired

timestringRequired

Responses

200

application/json

400

Bad Request

post

/timemanagement/v1/fingerprints

curl -X POST \
  "https://api.catapa.com/timemanagement/v1/fingerprints" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "identificationNumber": "1",
    "time": "2021-04-05T07:50:00+07:00"
  },
  {
    "identificationNumber": "2",
    "time": "2021-04-05T07:55:00+07:00"
  }
]'

{
  "successes": [
    {
      "identificationNumber": "1",
      "time": "2021-04-05T07:50:00+07:00",
      "date": "2021-04-05"
    }
  ],
  "failures": [
    {
      "code": "COM-EMPLOYEE_NOT_FOUND_WITH_EMPLOYEE_ID",
      "message": "Employee with employee ID 2 is not found",
      "params": {
        "identificationNumber": "2"
      }
    }
  ]
}

Get Holidays

get

Search Query

Supported Keys

Supported Operators

Notes

holidayDate

> <

Greater than or equal to Less than or equal to

name

Equal Operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/holidays

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/holidays" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "holidayDate": "2019-05-01",
      "name": "Hari Buruh"
    },
    {
      "holidayDate": "2019-04-19",
      "name": "Tahun Baru Masehi"
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 2,
  "totalElements": 2,
  "last": true,
  "sort": [],
  "first": true,
  "empty": false
}

Get Leave Balances

get

Search Query

Supported Keys

Supported Operators

Notes

employee.identificationNumber

year

: > <

Equal Greater than or equal to Less than or equal to

active

Equal

extended

Equal

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/leave-balances

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/leave-balances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "6cad89ed-4d93-43de-a2a7-89cf01673248",
      "year": 2017,
      "accrualFrequencyType": "YEARLY",
      "monthlyAccrualIncludeBonus": false,
      "givenDate": "2017-01-01",
      "startDate": "2017-01-01",
      "endDate": "2017-12-31",
      "expectedBalance": 12,
      "balance": 12,
      "bonus": 0,
      "debt": 0,
      "extended": false,
      "maximumExtendedDuration": 0,
      "maximumExtendedBalance": 0,
      "extendedBalanceIncludeBonus": false,
      "totalBalance": 12,
      "usedLeave": 0,
      "active": false,
      "employee": {
        "id": "709a3d31-f7e8-4a8d-a7bf-bb4ad23fba9d",
        "identificationNumber": "LBA-01",
        "name": "Leave Balance Api 1"
      },
      "approvedLeave": 0,
      "pendingLeave": 0,
      "collectiveLeave": 0,
      "remaining": 12,
      "extendedDate": "2017-12-31",
      "extendedBalance": 0,
      "extendedUsedLeave": 0,
      "extendedCollectiveLeave": 0,
      "extendedAvailable": 0,
      "extendedRemaining": 0,
      "extendedApprovedLeave": 0,
      "extendedPendingLeave": 0
    },
    {
      "id": "4973ba60-0e33-43ab-8810-e533491cbbbc",
      "year": 2021,
      "accrualFrequencyType": "YEARLY",
      "monthlyAccrualIncludeBonus": false,
      "givenDate": "2021-01-01",
      "startDate": "2021-01-01",
      "endDate": "2021-12-31",
      "expectedBalance": 12,
      "balance": 12,
      "bonus": 0,
      "debt": 0,
      "extended": false,
      "maximumExtendedDuration": 0,
      "maximumExtendedBalance": 0,
      "extendedBalanceIncludeBonus": false,
      "totalBalance": 12,
      "usedLeave": 0.75,
      "active": false,
      "employee": {
        "id": "709a3d31-f7e8-4a8d-a7bf-bb4ad23fba9d",
        "identificationNumber": "LBA-01",
        "name": "Leave Balance Api 1"
      },
      "approvedLeave": 0.5,
      "pendingLeave": 0.25,
      "collectiveLeave": 0,
      "remaining": 11.25,
      "extendedDate": "2021-12-31",
      "extendedBalance": 0,
      "extendedUsedLeave": 0,
      "extendedCollectiveLeave": 0,
      "extendedAvailable": 0,
      "extendedRemaining": 0,
      "extendedApprovedLeave": 0,
      "extendedPendingLeave": 0
    }
  ],
  "number": 0,
  "size": 10,
  "totalElements": 2,
  "totalPages": 1,
  "first": true,
  "last": true,
  "numberOfElements": 2,
  "pageable": {
    "sort": [
      {
        "direction": "ASC",
        "property": "id"
      }
    ],
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 10,
    "paged": true,
    "unpaged": false
  },
  "empty": false
}

Create Leave Balance

post

Create a leave balance.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

identificationNumberstringRequired

yearnumberRequired

accrualFrequencyTypestringRequired

monthlyAccrualIncludeBonusbooleanRequired

givenDatestringRequired

startDatestringRequired

endDatestringRequired

balancenumberRequired

bonusnumberRequired

debtnumberRequired

extendedbooleanRequired

maximumExtendedDurationnumberRequired

maximumExtendedBalancenumberRequired

extendedBalanceIncludeBonusbooleanRequired

Responses

200

application/json

idstringOptional

yearnumberOptional

accrualFrequencyTypestringOptional

monthlyAccrualIncludeBonusbooleanOptional

givenDatestringOptional

startDatestringOptional

endDatestringOptional

expectedBalancenumberOptional

balancenumberOptional

bonusnumberOptional

debtnumberOptional

extendedbooleanOptional

maximumExtendedDurationnumberOptional

maximumExtendedBalancenumberOptional

extendedBalanceIncludeBonusbooleanOptional

totalBalancenumberOptional

usedLeavenumberOptional

activebooleanOptional

approvedLeavenumberOptional

pendingLeavenumberOptional

collectiveLeavenumberOptional

remainingnumberOptional

extendedDatestringOptional

extendedBalancenumberOptional

extendedUsedLeavenumberOptional

extendedCollectiveLeavenumberOptional

extendedAvailablenumberOptional

extendedRemainingnumberOptional

extendedApprovedLeavenumberOptional

extendedPendingLeavenumberOptional

400

Bad Request

post

/timemanagement/v1/leave-balances

curl -X POST \
  "https://api.catapa.com/timemanagement/v1/leave-balances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "identificationNumber": "NIK",
  "year": 2021,
  "accrualFrequencyType": "YEARLY",
  "monthlyAccrualIncludeBonus": false,
  "givenDate": "2021-01-01",
  "startDate": "2021-01-01",
  "endDate": "2021-12-31",
  "balance": 12,
  "bonus": 0,
  "debt": 0,
  "extended": false,
  "maximumExtendedDuration": 0,
  "maximumExtendedBalance": 0,
  "extendedBalanceIncludeBonus": false
}'

{
  "id": "9f434479-136f-4303-ab20-bd389598c0a2",
  "employee": {
    "id": "185906ae-108f-456d-a7e2-4782be11fac3",
    "identificationNumber": "NIK",
    "name": "NIK"
  },
  "year": 2021,
  "accrualFrequencyType": "YEARLY",
  "monthlyAccrualIncludeBonus": false,
  "givenDate": "2021-01-01",
  "startDate": "2021-01-01",
  "endDate": "2021-12-31",
  "expectedBalance": 12,
  "balance": 12,
  "bonus": 0,
  "debt": 0,
  "extended": false,
  "maximumExtendedDuration": 0,
  "maximumExtendedBalance": 0,
  "extendedBalanceIncludeBonus": false,
  "totalBalance": 12,
  "usedLeave": 0,
  "approvedLeave": 0,
  "pendingLeave": 0,
  "collectiveLeave": 0,
  "remaining": 0,
  "extendedDate": "2021-12-31",
  "extendedBalance": 0,
  "extendedUsedLeave": 0,
  "extendedCollectiveLeave": 0,
  "extendedAvailable": 0,
  "extendedRemaining": 0,
  "extendedApprovedLeave": 0,
  "extendedPendingLeave": 0,
  "active": true
}

Get Other Leave Balances

get

Search Query

Supported Keys

Supported Operators

Notes

employee.id

Equal

employee.identificationNumber

Equal

year

Equal

otherLeaveStatus.code

Equal

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/other-leave-balances

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/other-leave-balances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "77901633-2ba8-497b-a0f6-370399c6e123",
      "employee": {
        "id": "e2537fca-2f8b-4631-a60f-cc05aa4fbbbe",
        "identificationNumber": "2322222222",
        "name": "ah-sub02"
      },
      "otherLeaveStatus": {
        "code": "CBSR",
        "name": "Cuti Besar",
        "description": "Cuti Besar yang diberikan selama 5 tahun sekali"
      },
      "year": 2022,
      "givenDate": "2022-01-01",
      "startDate": "2022-01-01",
      "endDate": "2022-12-31",
      "balance": 12,
      "usedBalance": 2,
      "pendingBalance": 2,
      "approvedBalance": 0,
      "remaining": 8,
      "minLeaveDate": "2022-04-01",
      "maxLeaveDate": "2022-04-04",
      "active": true
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Create Other Leave Balance

post

Create an other leave balance.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

identificationNumberstringRequired

otherLeaveStatusCodestringRequired

yearnumberRequired

balancenumberRequired

givenDatestringRequired

startDatestringRequired

endDatestringRequired

Responses

200

application/json

idstringOptional

yearnumberOptional

givenDatestringOptional

startDatestringOptional

endDatestringOptional

balancenumberOptional

400

Bad Request

post

/timemanagement/v1/other-leave-balances

curl -X POST \
  "https://api.catapa.com/timemanagement/v1/other-leave-balances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "identificationNumber": "otherleave1",
  "otherLeaveStatusCode": "CBSR",
  "year": 2011,
  "balance": 15,
  "givenDate": "2017-01-01",
  "startDate": "2017-01-01",
  "endDate": "2025-12-01"
}'

{
  "id": "592309f9-89ff-4fb3-8435-aeb54e0847d2",
  "employee": {
    "id": "9647a60d-55db-44fb-8b23-55f610675eb8",
    "identificationNumber": "otherleave1",
    "name": "otherleave1"
  },
  "otherLeaveStatus": {
    "code": "CBSR",
    "name": "Cuti Besar",
    "description": "Cuti Besar yang diberikan selama 5 tahun sekali"
  },
  "year": 2011,
  "givenDate": "2017-01-01",
  "startDate": "2017-01-01",
  "endDate": "2025-12-01",
  "balance": 15
}

Get Shift Pattern Templates

get

Search Query

Supported Keys

Supported Operators

Notes

name

Like operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/shift-pattern-templates

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/shift-pattern-templates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "34b1cd5e-366a-43d0-8bbe-443cc531b220",
      "name": "Pattern test 1",
      "shiftPatternTemplateDetails": []
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 1,
  "totalElements": 1,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}

Create Shift Pattern Template

post

Create a shift pattern template.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

Responses

201

application/json

400

Bad Request

post

/timemanagement/v1/shift-pattern-templates

curl -X POST \
  "https://api.catapa.com/timemanagement/v1/shift-pattern-templates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pattern test 3",
  "shiftPatternTemplateDetails": [
    {
      "shift": {
        "id": "ced2860c-7457-4d07-be16-2e1642173dc0"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-002",
        "name": "Evening Shift"
      },
      "sequence": 1
    }
  ]
}'

{
  "id": "b09a38f9-ae86-4e1b-a52a-5f1b3ec6b919",
  "name": "Pattern test 3",
  "shiftPatternTemplateDetails": [
    {
      "shift": {
        "id": "ced2860c-7457-4d07-be16-2e1642173dc0",
        "code": "1",
        "name": "Shift 1",
        "timeIn": "08:00:00",
        "timeInUtc": 28800000,
        "timeOut": "17:00:00",
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 1
    }
  ]
}

Get Shift Pattern Template by Id

get

Return the shift pattern template by Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

idstringOptional

namestringOptional

400

Bad Request

get

/timemanagement/v1/shift-pattern-templates/{id}

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/shift-pattern-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "",
      "name": "Template 1",
      "shiftPatternTemplateDetails": [
        {
          "shift": {
            "id": "12345678-1234-1234-1234-123456789012",
            "code": "SHIFT-001",
            "name": "Morning Shift"
          },
          "sequence": 0
        },
        {
          "shift": {
            "id": "",
            "code": "1",
            "name": "Shift 1",
            "timeInUtc": 28800000,
            "timeOutUtc": 61200000,
            "breakStartUtc": 43200000,
            "breakEndUtc": 46800000,
            "color": "#00c983"
          },
          "sequence": 1
        }
      ]
    }
  ]
}

Update Shift Pattern Template

put

Update the shift pattern template.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

namestringRequired

Responses

200

application/json

idstringOptional

namestringOptional

400

Bad Request

put

/timemanagement/v1/shift-pattern-templates/{id}

curl -X PUT \
  "https://api.catapa.com/timemanagement/v1/shift-pattern-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Template 1",
  "shiftPatternTemplateDetails": [
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": ""
      },
      "sequence": 1
    }
  ]
}'

{
  "id": "",
  "name": "Template 1",
  "shiftPatternTemplateDetails": [
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "",
        "code": "1",
        "name": "Shift 1",
        "timeInUtc": 28800000,
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "sequence": 1
    }
  ]
}

Delete Shift Pattern Template

delete

Delete the shift pattern template.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

anyOptional

400

Bad Request

delete

/timemanagement/v1/shift-pattern-templates/{id}

curl -X DELETE \
  "https://api.catapa.com/timemanagement/v1/shift-pattern-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{}

Get Workgroup Workday Configurations

get

Search Query

Supported Keys

Supported Operators

Notes

startDate

> <

Greater than or equal to Less than or equal to

endDate

> <

Greater than or equal to Less than or equal to

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/timemanagement/v1/workgroup-workday-configurations

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/workgroup-workday-configurations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "",
      "startDate": "2021-04-05",
      "endDate": "2021-04-05",
      "shiftPatternTemplate": {
        "id": "",
        "name": "Template 1"
      },
      "workdayConfigurationDetails": [],
      "startSequence": 1,
      "startShift": {
        "id": "",
        "code": "1",
        "name": "Shift 1",
        "timeInUtc": 28800000,
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "includeHoliday": false,
      "workgroup": {
        "id": "",
        "code": "1",
        "name": "Workgroup 1"
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Workgroup Roster Configuration

post

Create a workgroup roster configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

startDatestringRequired

endDatestringRequired

includeHolidaybooleanRequired

startSequencenumberRequired

Responses

201

application/json

400

Bad Request

post

/timemanagement/v1/workgroup-workday-configurations

curl -X POST \
  "https://api.catapa.com/timemanagement/v1/workgroup-workday-configurations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "shiftPatternTemplate": {
    "id": "34b1cd5e-366a-43d0-8bbe-443cc531b220"
  },
  "startDate": "2017-01-01",
  "endDate": "2017-01-06",
  "includeHoliday": false,
  "startSequence": 1,
  "workgroup": {
    "id": "09cf7051-4ac9-4a21-912d-bbeeb05ff97b"
  }
}'

{
  "id": "a0e1b4fb-b973-4347-ac54-b37aebbd1195",
  "shiftPatternTemplate": {
    "id": "34b1cd5e-366a-43d0-8bbe-443cc531b220",
    "name": "Pattern Template 1"
  },
  "workdayConfigurationDetails": [
    {
      "shift": {
        "id": "ced2860c-7457-4d07-be16-2e1642173dc0",
        "code": "Shift 1",
        "name": "Shift 1",
        "timeIn": "08:00:00",
        "timeInUtc": 28800000,
        "timeOut": "17:00:00",
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#010101"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 1
    }
  ],
  "startDate": "2017-01-01",
  "endDate": "2017-01-06",
  "includeHoliday": false,
  "startSequence": 1,
  "startShift": {
    "id": "12345678-1234-1234-1234-123456789012",
    "code": "SHIFT-001",
    "name": "Morning Shift"
  },
  "workgroup": {
    "id": "09cf7051-4ac9-4a21-912d-bbeeb05ff97b",
    "code": "WG001",
    "name": "Workgroup Alpha"
  }
}

Get Workgroup Roster Configuration by Id

get

Get Workgroup Roster Configuration by Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

idstringOptional

startDatestringOptional

endDatestringOptional

startSequencenumberOptional

includeHolidaybooleanOptional

400

Bad Request

get

/timemanagement/v1/workgroup-workday-configurations/{id}

curl -X GET \
  "https://api.catapa.com/timemanagement/v1/workgroup-workday-configurations/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "",
  "startDate": "2021-04-05",
  "endDate": "2021-04-05",
  "shiftPatternTemplate": {
    "id": "12345678-1234-1234-1234-123456789012",
    "name": "Template 1"
  },
  "workdayConfigurationDetails": [
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "1",
        "name": "Shift 1",
        "timeInUtc": 28800000,
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "sequence": 1
    }
  ],
  "startSequence": 0,
  "startShift": {
    "id": "12345678-1234-1234-1234-123456789012",
    "code": "SHIFT-001",
    "name": "Morning Shift"
  },
  "includeHoliday": false,
  "workgroup": {
    "id": "12345678-1234-1234-1234-123456789012",
    "code": "1",
    "name": "Workgroup 1"
  }
}

Update Workgroup Roster Configuration

put

Update Workgroup Roster Configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

startDatestringRequired

endDatestringRequired

includeHolidaybooleanRequired

startSequencenumberRequired

Responses

200

application/json

idstringOptional

startDatestringOptional

endDatestringOptional

startSequencenumberOptional

includeHolidaybooleanOptional

400

Bad Request

put

/timemanagement/v1/workgroup-workday-configurations/{id}

curl -X PUT \
  "https://api.catapa.com/timemanagement/v1/workgroup-workday-configurations/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "shiftPatternTemplate": {
    "id": ""
  },
  "startDate": "2021-04-05",
  "endDate": "2021-04-05",
  "includeHoliday": false,
  "startSequence": 0,
  "workgroup": {
    "id": ""
  }
}'

{
  "id": "",
  "startDate": "2021-04-05",
  "endDate": "2021-04-05",
  "shiftPatternTemplate": {
    "id": "",
    "name": "Template 1"
  },
  "workdayConfigurationDetails": [
    {
      "shift": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "SHIFT-001",
        "name": "Morning Shift"
      },
      "sequence": 0
    },
    {
      "shift": {
        "id": "",
        "code": "1",
        "name": "Shift 1",
        "timeInUtc": 28800000,
        "timeOutUtc": 61200000,
        "breakStartUtc": 43200000,
        "breakEndUtc": 46800000,
        "color": "#00c983"
      },
      "sequence": 1
    }
  ],
  "startSequence": 0,
  "startShift": {
    "id": "12345678-1234-1234-1234-123456789012",
    "code": "SHIFT-001",
    "name": "Morning Shift"
  },
  "includeHoliday": false,
  "workgroup": {
    "id": "",
    "code": "1",
    "name": "Workgroup 1"
  }
}

Delete Workgroup Roster Configuration

delete

Delete Workgroup Roster Configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

anyOptional

400

Bad Request

delete

/timemanagement/v1/workgroup-workday-configurations/{id}

curl -X DELETE \
  "https://api.catapa.com/timemanagement/v1/workgroup-workday-configurations/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{}

Last updated 16 days ago

hashtagGet Attendance Recapitulation Detail

hashtagSearch Query

hashtagGet Attendances

hashtagSearch Query

hashtagGet Absence Entries

hashtagSearch Query

hashtagGet Attendance Cancellations

hashtagSearch Query

hashtagGet Employee Workday Configurations

hashtagSearch Query

hashtagCreate Employee Roster Configuration

hashtagGet Employee Roster Configuration by Id

hashtagUpdate Employee Roster Configuration

hashtagDelete Employee Roster Configuration

hashtagCreate Attendance Machine Data

hashtagGet Holidays

hashtagSearch Query

hashtagGet Leave Balances

hashtagSearch Query

hashtagCreate Leave Balance

hashtagGet Other Leave Balances

hashtagSearch Query

hashtagCreate Other Leave Balance

hashtagGet Shift Pattern Templates

hashtagSearch Query

hashtagCreate Shift Pattern Template

hashtagGet Shift Pattern Template by Id

hashtagUpdate Shift Pattern Template

hashtagDelete Shift Pattern Template

hashtagGet Workgroup Workday Configurations

hashtagSearch Query

hashtagCreate Workgroup Roster Configuration

hashtagGet Workgroup Roster Configuration by Id

hashtagUpdate Workgroup Roster Configuration

hashtagDelete Workgroup Roster Configuration

Get Attendance Recapitulation Detail

Search Query

Get Attendances

Search Query

Get Absence Entries

Search Query

Get Attendance Cancellations

Search Query

Get Employee Workday Configurations

Search Query

Create Employee Roster Configuration

Get Employee Roster Configuration by Id

Update Employee Roster Configuration

Delete Employee Roster Configuration

Create Attendance Machine Data

Get Holidays

Search Query

Get Leave Balances

Search Query

Create Leave Balance

Get Other Leave Balances

Search Query

Create Other Leave Balance

Get Shift Pattern Templates

Search Query

Create Shift Pattern Template

Get Shift Pattern Template by Id

Update Shift Pattern Template

Delete Shift Pattern Template

Get Workgroup Workday Configurations

Search Query

Create Workgroup Roster Configuration

Get Workgroup Roster Configuration by Id

Update Workgroup Roster Configuration

Delete Workgroup Roster Configuration