Skip to main content
POST
/
jobs
/
jobsInTimeFrame
Get jobs in a specific time frame
curl --request POST \
  --url http://localhost:3000/v2/jobs/jobsInTimeFrame \
  --header 'Content-Type: application/json' \
  --header 'x-API-Key: <api-key>' \
  --data '
{
  "from": "1704067200000",
  "to": "1704153600000",
  "includeUsersInResponse": true,
  "status": "<string>",
  "ids": [
    "<string>"
  ],
  "jobTemplateId": "<string>",
  "originalId": {},
  "absenceId": {},
  "notAccepted": {},
  "objectId": "<string>",
  "objectIds": [
    "<string>"
  ],
  "teamId": {},
  "userIds": [
    "<string>"
  ],
  "activityTypeId": [
    "<string>"
  ],
  "currentlyWorking": true,
  "liveJobs": true,
  "assignmentIds": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}
'
[
  {
    "_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>",
    "type": "<unknown>",
    "assignmentId": "<string>",
    "targetTime": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "userId": "<string>",
    "absenceId": "<string>",
    "assignment": {
      "_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>",
      "objectId": "507f1f77bcf86cd799439011",
      "customerId": "507f1f77bcf86cd799439012",
      "title": "Monthly Cleaning Service",
      "iCalendar": {
        "frequency": "<string>",
        "tzid": "<string>",
        "interval": 123,
        "rrule": "<string>",
        "bySetPos": 123,
        "byDay": [
          "<string>"
        ],
        "byMonthDay": "<string>",
        "byMonth": [
          123
        ],
        "dtstart": "<string>",
        "dtend": "<string>",
        "exDate": [
          "<string>"
        ]
      },
      "material": [
        {
          "productId": "507f1f77bcf86cd799439013",
          "quantity": 2
        }
      ],
      "weeklyTimeBudget": 8.5,
      "type": "normal",
      "activityTypeId": "507f1f77bcf86cd799439014",
      "comment": "Special instructions for weekend work",
      "commentRequired": false,
      "sign": false,
      "documentIds": [
        "507f1f77bcf86cd799439015",
        "507f1f77bcf86cd799439016"
      ],
      "billing": {
        "type": "MANUAL",
        "": [
          {
            "quantity": 2.5,
            "unit": "hours",
            "price": 32.5,
            "tax": 0.19,
            "title": "Cleaning Service",
            "": "INVOICE_POSITION",
            "taxRate": {
              "type": "VAT",
              "rate": 0.19,
              "_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>"
              },
              "description": "Regelsteuersatz",
              "bookingAccountNumber": "8400",
              "skontoBookingAccountNumber": "8405",
              "default": false
            },
            "description": "Detailed description of the cleaning service",
            "discount": 0.1,
            "productId": "550e8400-e29b-41d4-a716-446655440000",
            "includedWageCostFactor": 0.95,
            "isOptional": false,
            "bookingAccountNumber": "ACC-123456",
            "skontoBookingAccountNumber": "SKONTO-123456"
          }
        ],
        "lastInvoiceDate": "2023-11-07T05:31:56Z",
        "defaultInvoiceTemplateId": "<string>"
      },
      "quota": {
        "enabled": true,
        "quotaCalculation": "once",
        "total": 123,
        "billingRateEnabled": true,
        "billingRateCalculation": "hourly",
        "billingRateAmount": 123,
        "expectedMargin": 123
      },
      "autoGenerateInvoiceError": {},
      "costUnit": "<string>",
      "jobChatId": "507f1f77bcf86cd799439017",
      "linkedCache": [
        {}
      ]
    },
    "notifyObjectManager": "<unknown>",
    "masterJobId": "<string>",
    "needsJobTemplate": "<unknown>",
    "timeTrackings": [
      {
        "_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>",
        "jobId": "<string>",
        "objectId": "<string>",
        "timeStart": "2023-11-07T05:31:56Z",
        "timeEnd": "2023-11-07T05:31:56Z",
        "workingTime": 1,
        "targetTime": 1,
        "break": 1,
        "requiredBreakTime": 1,
        "type": "default",
        "location": {
          "latitude": 123,
          "longitude": 123
        },
        "logOutLocation": {
          "latitude": 123,
          "longitude": 123
        },
        "approved": true,
        "cancelled": true,
        "offline": true,
        "generatedByUser": true,
        "editedByManager": true,
        "trackingJobDate": "2023-11-07T05:31:56Z",
        "comment": "<string>",
        "reason": "<string>",
        "errors": [
          "<string>"
        ],
        "allFoundErrors": [
          "<string>"
        ],
        "salaryIds": [
          "<string>"
        ],
        "objectManagerId": "<string>",
        "signingId": "<string>",
        "activityTypeId": "<string>",
        "assignmentId": "<string>"
      }
    ],
    "salaries": [
      {
        "_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",
        "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": [
          {
            "seconds": 1,
            "_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",
            "activeTimeFrames": [
              {
                "from": "2023-11-07T05:31:56Z",
                "to": "2023-11-07T05:31:56Z"
              }
            ],
            "_cash": 0
          }
        ],
        "drivingTime": 123,
        "assignmentId": "<string>",
        "activityTypeId": "<string>",
        "releasedBySystem": true
      }
    ],
    "regionId": "<string>",
    "splitId": "<string>",
    "acceptedStatus": "<unknown>",
    "jobComment": "<string>",
    "teamId": "<string>",
    "activityType": {
      "name": "Unterhaltsreinigung",
      "_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>"
      },
      "hexCode": "#34c759",
      "description": "Regular maintenance cleaning activities"
    },
    "exceptionJobId": "<string>",
    "title": "<string>",
    "requiredDrivingTime": 123,
    "requiredBreakTime": 123,
    "started": [
      {
        "trackingJobDate": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "time": "2023-11-07T05:31:56Z",
        "isLive": true,
        "wasAddedManually": true,
        "salaryId": "<unknown>"
      }
    ],
    "absences": [
      {
        "absenceId": "<string>",
        "dtStart": "2023-11-07T05:31:56Z",
        "dtEnd": "2023-11-07T05:31:56Z",
        "calculationType": "<string>",
        "_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>"
        }
      }
    ],
    "documentIds": [
      "<string>"
    ]
  }
]

Authorizations

​
x-API-Key
string
header
required

Body

application/json

Time frame and optional filters

​
from
string<epoch-millis>
required

Start of the time frame

Example:

"1704067200000"

​
to
string<epoch-millis>
required

End of the time frame

Example:

"1704153600000"

​
includeUsersInResponse
boolean

Whether to include users in the response

​
status
string

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

​
ids
string<objectid>[]

Filter by IDs (array of objectIds)

​
jobTemplateId
string<objectid>

Filter by job template ID

​
originalId
Filter for Job Original ID · object

Filter to search jobs by their original ID after they have been moved

​
absenceId
Filter for Job Absence ID · object

Filter to search jobs by their absence ID

​
notAccepted
Filter for Not Accepted Jobs · object

Filter to search jobs that are not accepted

​
objectId
string<objectid>

Filter by object ID

​
objectIds
string<objectid>[]

Filter by object IDs

​
teamId
Filter for Team ID · object

Filter to search for jobs by team ID. Jobs with multiple users share the same team ID.

​
userIds
string<objectId>[]

Filter to search jobs by user IDs. If the user ID is "unassigned_jobs", it will search for jobs without a user ID.

User ID to filter jobs by. If "unassigned_jobs" is included, it will also search for jobs without a user ID.

​
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

​
currentlyWorking
boolean

Filter to search for users who are currently working on active jobs.

​
liveJobs
boolean

Filter to search jobs that are currently live, started within the last 12 hours.

​
assignmentIds
string<objectId>[]

Filter to search for entities by assignment IDs. This filter allows you to find entities that are associated with specific assignments.

​
tags
string[]

Filter by tags

Response

Jobs retrieved successfully

​
_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

​
type
any

Type of the job

​
assignmentId
string<objectid>

Assignment ID

​
targetTime
string<float>

Target time for the job in minutes

​
from
string<date-time>

Start time of the job

​
to
string<date-time>

End time of the job

​
userId
string<objectid>

ID of the user

​
absenceId
string<objectid>

Absence Id, if this job is connected to an absence (if it needs a replacement)

​
assignment
Assignment · object

An Assignment acts as the overall structure for jobs. They contain information about what kind of work should be done, where it should be done and how it should be billed. Assignments can be used to track the time spent on a job, the materials used and the costs incurred.

​
notifyObjectManager
any

Whether to notify the object manager

​
masterJobId
string<objectid>

Master job ID if this is a replacement job

​
needsJobTemplate
any

Whether the job needs a template

​
timeTrackings
Time Tracking Entry · object[]

Time tracking entries for the job

​
salaries
Salary · object[]

Salaries for the job

​
regionId
string<objectid> | null

Region ID

​
splitId
string<objected> | null

Split job ID

​
acceptedStatus
any

Accepted status

​
jobComment
string

Comment for the job

​
teamId
string<objectid> | null

Team ID

​
activityType
Activity Type · object

Activity type for the job

​
exceptionJobId
string<objectid> | null

Exception job ID

​
title
string

Title of the job

​
requiredDrivingTime
integer<float>

Required driving time in minutes

​
requiredBreakTime
integer<float>

Required break time in minutes

​
started
JobStartedStruct · object[]

Job started entries

​
absences
JobAbsencesStruct · object[]

Absences related to the job

​
documentIds
string<objectid>[]

Document IDs related to the job