GET
/
salaries
/
List salaries
curl --request GET \
  --url http:localhost:3000/v2/salaries/ \
  --header 'x-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "chatId": "<string>",
    "userId": "<string>",
    "timeTrackingId": "<string>",
    "billed": true,
    "type": "<string>",
    "objectId": "<string>",
    "workingTime": 123,
    "targetTime": 123,
    "salaryPerHour": 123,
    "salary": 123,
    "reason": "<string>",
    "approvedByUserId": "<string>",
    "updatedByUserId": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "leistung": {},
    "addedTime": 123,
    "break": 123,
    "minBreakTime": 123,
    "absenceId": "<string>",
    "jobId": "<string>",
    "trackingJobDate": "2023-11-07T05:31:56Z",
    "ignoreDoubleSalaries": true,
    "roundedUp": true,
    "roundUpSeconds": 123,
    "payType": "<string>",
    "nightWorkingTime": 123,
    "sundayWorkingTime": 123,
    "publicHolidayWorkingTime": 123,
    "surcharges": [
      {
        "_id": "<string>",
        "number": 123,
        "companyId": "<string>",
        "status": {
          "status": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "createdBy": "<string>",
          "lastModifiedAt": "2023-11-07T05:31:56Z",
          "lastModifiedBy": "<string>"
        },
        "surchargeId": "<string>",
        "name": "<string>",
        "surcharge": 123,
        "activeOn": {},
        "userId": "<string>",
        "date": "2023-12-25",
        "seconds": 1,
        "activeTimeFrames": [
          {
            "from": "2023-11-07T05:31:56Z",
            "to": "2023-11-07T05:31:56Z"
          }
        ],
        "_cash": 0
      }
    ],
    "drivingTime": 123,
    "assignmentId": "<string>",
    "activityTypeId": "<string>",
    "releasedBySystem": true
  }
]

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

Sort field and direction (e.g. from:1, createdAt:-1)

​
status
string

Filter by status (single value or comma-separated list)

​
ids
string<objectid>[]

Filter by IDs (array of objectIds)

​
user
string<objectid>

Filter by user ID

​
from
integer

Filter by creation date from (timestamp)

​
to
integer

Filter by creation date to (timestamp)

​
object
string<objectid>

Filter by object ID

​
objectIds
string<objectid>[]

Filter by object IDs

​
objectsByName
object

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

​
fromWithIncludedTrackingDate
integer[]

Filter by date range including tracking date - searches across from, timeStart, and trackingJobDate fields

Required array length: 2 elements
​
activityTypeId
string<objectId>[]

Filter to search jobs by activity type IDs. It can handle multiple activity type IDs and also includes checks for assignments, jobs, and salaries.

Activity Type ID to filter by

​
jobIds
string<objectid>[]

Filter by job IDs

​
trackingJobDate
string

Filter by tracking job date range - accepts TimeFrame JSON object with from/to timestamps

​
generalField
object

A dynamic filter that allows filtering on any field with various operators. Supports string, number, boolean, date, and objectid field types.

Response

200
application/json

List of salary records

The response is of type Salary · object[].