List SickLeaveCertificates

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

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

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

api

sickLeaveCertificates

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/sickLeaveCertificates

{
  "data": {
    "items": [
      {
        "id": 123,
        "leavePeriodId": 123,
        "leaveAccountId": 123,
        "authorId": 123,
        "creationDate": "2023-11-07T05:31:56Z",
        "isActive": true,
        "cancellationDate": "2023-11-07T05:31:56Z",
        "cancellationUserId": 123,
        "subrogation": true,
        "subrogationStartDate": "2023-11-07T05:31:56Z",
        "subrogationEndDate": "<string>",
        "lastWorkingDay": "2023-11-07T05:31:56Z",
        "numberOfWaitingPeriodDays": 1,
        "numberOfCompensatedDays": 1,
        "partTimeNature": 0,
        "partTimeActivityRate": 123,
        "partTimeReturnType": 0,
        "earlyReturn": true,
        "extension": true,
        "comments": "<string>",
        "originalLeavePeriodId": 123,
        "accidentDate": "<string>",
        "accidentPlace": 0,
        "firstObservationDate": "2023-11-07T05:31:56Z",
        "childArrivalScheduledDate": "<string>",
        "childArrivalEffectiveDate": "<string>",
        "childArrivalType": 0,
        "isSingleChild": true,
        "childAdoptionDistribution": 0,
        "paternityLeavePartType": 0,
        "compensationRate": 123,
        "longLastingAffection": true
      }
    ]
  }
}

Query Parameters

paging

string

required

{offset},{limit}. Defaults to 0,1000.

leavePeriod.ownerId

integer[]

Filter out results on the related employee ID.

leavePeriod.owner.departmentId

integer[]

Filter out results on the related employee department ID.

leavePeriod.owner.legalEntityId

integer[]

Filter out results on the related employee legalEntity (ie business-establishment) ID.

creationDate

string

Filter out results on their creation date.

Response

200 - application/json

data

object

data.items

object[]

data.items.id

integer

data.items.leavePeriodId

integer

data.items.leaveAccountId

integer

ID of the related LeaveAccount.

data.items.authorId

integer

ID of the user who created this object.

data.items.creationDate

string

Non UTC date-time when this object was created.

data.items.isActive

boolean

Whether this SickLeaveCertificate was cancelled (equivalent to deleted).

data.items.cancellationDate

string | null

Non UTC date-time when this SickLeaveCertificate was cancelled / deleted. Null when not cancelled.

data.items.cancellationUserId

integer | null

ID of the user who cancelled / deleted this SickLeaveCertificate. Null when not cancelled.

data.items.subrogation

boolean

When true, the company maintains the employee salary and will itself be compensated by Social Security.

data.items.subrogationStartDate

string | null

Start of subrogation.

data.items.subrogationEndDate

string | null

Last day (included) of subrogation.

data.items.lastWorkingDay

string

Last day (included) this employee worked before being on sick leave.

data.items.numberOfWaitingPeriodDays

integer

Number of days the employee will have to wait before being compensated.

Required range: x > 0

data.items.numberOfCompensatedDays

integer

Total number of days the employee will be compensated for.

Required range: x > 0

data.items.partTimeNature

enum<integer> | null

0: Other
1: Work accident
2: Commute accident
3: Sickness
4: Occupational disease
5: Maternity
6: Paternity
7: Therapeutic part-time

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8

data.items.partTimeActivityRate

number | null

When the employee returns part-time: the actual part-time percentage.

data.items.partTimeReturnType

enum<integer>

0: Employee returns in full-time.
1: Employee returns in part-time for therapeutic reasons.
2: Employee returns in part-time for personal undisclosed reasons.

Available options:

0,

1,

2

data.items.earlyReturn

boolean

Whether the employee will actually return to work before the expected leave end date.

data.items.extension

boolean

Is this SickLeaveCertificate an extension of a previous one?

data.items.comments

string | null

Comments left when creating this SickLeaveCertificate.

data.items.originalLeavePeriodId

integer

ID of the previous SickLeaveCertificate.LeavePeriod when this one is an extension or an early return to work.

data.items.accidentDate

string | null

When due to a work commuting accident, the date when the accident occurred.

data.items.accidentPlace

enum<integer> | null

0: outward trip
1: return trip
2: lunch place

Available options:

0,

1,

2

data.items.firstObservationDate

string | null

When were the first symptoms observed.

data.items.childArrivalScheduledDate

string | null

On maternity leaves, the date when the child is expected to arrive (birth or adoption).

data.items.childArrivalEffectiveDate

string | null

On maternity leaves, the date when the child actually arrived (birth or adoption).

data.items.childArrivalType

enum<integer> | null

0: Birth
1: Adoption

Available options:

0,

1

data.items.isSingleChild

boolean | null

On maternity leaves, whether there are one or several children expected.

data.items.childAdoptionDistribution

enum<integer> | null

0: single parent
1: split between both parents

Available options:

0,

1

data.items.paternityLeavePartType

enum<integer> | null

0: First part
1: Splittable part

Available options:

0,

1

data.items.compensationRate

number | null

Percentage of compensation.

data.items.longLastingAffection

boolean | null

Long-lasting conditions are severe enough and/or have a chronic nature that requires prolonged treatment.

Was this page helpful?

The SickLeaveCertificate resource Get a SickLeaveCertificate

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/sickLeaveCertificates

{
  "data": {
    "items": [
      {
        "id": 123,
        "leavePeriodId": 123,
        "leaveAccountId": 123,
        "authorId": 123,
        "creationDate": "2023-11-07T05:31:56Z",
        "isActive": true,
        "cancellationDate": "2023-11-07T05:31:56Z",
        "cancellationUserId": 123,
        "subrogation": true,
        "subrogationStartDate": "2023-11-07T05:31:56Z",
        "subrogationEndDate": "<string>",
        "lastWorkingDay": "2023-11-07T05:31:56Z",
        "numberOfWaitingPeriodDays": 1,
        "numberOfCompensatedDays": 1,
        "partTimeNature": 0,
        "partTimeActivityRate": 123,
        "partTimeReturnType": 0,
        "earlyReturn": true,
        "extension": true,
        "comments": "<string>",
        "originalLeavePeriodId": 123,
        "accidentDate": "<string>",
        "accidentPlace": 0,
        "firstObservationDate": "2023-11-07T05:31:56Z",
        "childArrivalScheduledDate": "<string>",
        "childArrivalEffectiveDate": "<string>",
        "childArrivalType": 0,
        "isSingleChild": true,
        "childAdoptionDistribution": 0,
        "paternityLeavePartType": 0,
        "compensationRate": 123,
        "longLastingAffection": true
      }
    ]
  }
}