The fixed-item resource

A fixed remuneration item

integer<int32>

Unique identifier of the fixed remuneration item

amount

number<double>

The amount of the fixed remuneration item. Depending on the nature of the fixed item, the amount can be either a quantity or a monetary value.

startsOn

string<date>

The first day on which the fixed remuneration item applies.

endsOn

string<date> | null

The last day on which the fixed remuneration item applies.

comment

string | null

You can attach a comment to explain or justify the variable item

Example:

"First-half salary increase"

natureId

integer<int32>

The nature id of the fixed remuneration item

nature

object

The nature of the fixed remuneration item

Show child attributes

nature.id

integer<int32>

An unique identifier for the fixed nature

nature.name

string

The display name

Required string length: 1 - 50

Example:

"Basic salary"

nature.category

object

Fixed nature category

Show child attributes

nature.category.id

integer<int32>

An unique identifier for the fixed nature category

nature.category.code

string | null

An internal unique code identifying the category

Example:

"BASIC_SALARY"

nature.establishments

object[] | null

Establishments linked to the fixed nature

Show child attributes

nature.establishments.id

integer<int32>

An unique identifier for the establishment

nature.establishments.name

string

The display name

Example:

"Lucca FR"

nature.establishments.currencyCode

string

Currency code used in this establishment

Example:

"EUR"

nature.establishments.currencySymbol

string

Currency symbol used in this establishment

Example:

"€"

workContractId

integer<int32>

A fixed item must be linked to a work contract.

workContract

object

The work contract linked to the fixed item.

Show child attributes

workContract.workContractId

integer<int32>

An amended work contract is defined both by the work contract and the amendment This is the identifier of the work contract part

workContract.amendmentId

integer<int32>

An amended work contract is defined both by the work contract and the amendment This is the identifier of the amendment part

workContract.ownerId

integer<int32>

The identifier of the employee who owns the contract

workContract.owner

object

The employee who owns the work contract

Show child attributes

workContract.owner.id

integer<int32>

required

Unique identifier of the user

workContract.owner.firstName

string

required

First name of the user

workContract.owner.lastName

string

required

Last name of the user

workContract.owner.name

string

required

Full name of the user

workContract.owner.displayName

string

required

Display name of the user

workContract.startsOn

string<date>

Start date of the contract

workContract.endsOn

string<date> | null

End date of the contract

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

The fixed-item resource