Skip to main content
GET
List Salary

Authorizations

x-API-Key
string
header
required

Query Parameters

limit
integer
default:100

Maximum number of items to return

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0
sort
string

JSON-encoded sort object with "by" (field path) and "direction" (1 for asc, -1 for desc)

Example:

"{\"by\":\"number\",\"direction\":1}"

objectName
string

Filter something (e.g. equipment) by the objects name or number

Response

List of Salary items

_id
string<objectid>

Unique identifier of the entity

number
integer

Unique number of the entity, used for identification

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Entity Status information

chatId
string<objectid> | null

ID of the chat associated with this entity

userId
string<objectid>

User ID who earned this salary

timeTrackingId
string<objectid>

Time tracking entry ID this salary is based on

type
string

Type of salary (regular, overtime, etc.)

objectId
string<objectid>

Object ID where the work was performed

workingTime
integer

Actual working time in seconds

targetTime
integer

Target working time in seconds

reason
string

Reason or description for this salary entry

approvedByUserId
string<objectid>

User ID who approved this salary

updatedByUserId
string<objectid>

User ID who last updated this salary

from
string<date-time>

Start date/time for this salary period

to
string<date-time>

End date/time for this salary period

break
integer

Break time in seconds

minBreakTime
integer

Minimum break time required in seconds

absenceId
string<objectid>

Only set when type = Salary Absence

jobId
string<objectid>

Job ID this salary is associated with

trackingJobDate
string<date-time>

Date/time when job tracking was started

ignoreDoubleSalaries
boolean

Whether to ignore double salary checks

roundedUp
boolean

Whether working time was rounded up

roundUpSeconds
integer

Seconds that were rounded up

payType
string

Pay type classification

nightWorkingTime
integer
deprecated

Total working time during night hours in seconds (deprecated - use surcharges)

sundayWorkingTime
integer
deprecated

Total working time on Sunday in seconds (deprecated - use surcharges)

publicHolidayWorkingTime
integer
deprecated

Total working time on public holidays in seconds (deprecated - use surcharges)

surcharges
Surcharge on Salary · object[]

Array of salary surcharges for special work conditions (night, weekend, holiday, etc.)

workloadSurcharges
Surcharge on Salary · object[] | null

Array of workload-based surcharges (calculated from daily/weekly hour thresholds)

drivingTime
integer

Total driving time in seconds

drivingTimeFrame
object | null

Clock time of the drive as tracked in the app, only set when the driving time was tracked

payTypeId
string<objectid> | null

Resolved pay type ID (snapshot from creation)

payTypeSource
enum<string> | null

Source of resolved pay type

Available options:
user_default,
activity_type
assignmentId
string<objectid>

Assignment ID this salary belongs to

activityTypeId
string<objectid>

Activity type ID for categorizing work

releasedBySystem
boolean | null

Indicates if this salary was released by the system

locked
boolean | null

Indicates if this salary is locked and cannot be changed or deleted