v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Employee Tables

Creates a new salary entry for a given employee.

post/people/{id}/salaries

Path parameters

idstring required

Employee backend-id.

Request body

canBeDeletedboolean

internal flag

workChangeTypestring

The type of the change that was performed for this work entry. This will contain the ID of the value from the Change Type list.

payFrequencystring

Represents the frequency the salary is paid. This can be one of: Monthly, Semi Monthly, Weekly, or Bi-Weekly.

creationDatestring date

The date this entry was created.

isCurrentboolean

Is 'true' when this is the effective entry which is currently active.

modificationDatestring date

The date this entry was modified.

idinteger

The id of the entry.

endEffectiveDatestring date

For entries that are not active - this is the date this entry became not effective.

activeEffectiveDatestring date

The active effective date for this entry.

customColumnsobject

If the table has custom columns, they will appear here.

payPeriodstring required

Represents the period for this salary entry. This can be one of: Annual, Hourly, Daily, Weekly, Monthly.

effectiveDatestring date

The date this entry becomes effective. This is a mandatory field for a work entry.

Response

Entry added successfully.