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": "<any>",
    "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",
      "l2Updated": false,
      "comment": "Special instructions for weekend work",
      "commentRequired": false,
      "sign": false,
      "documentIds": [
        "507f1f77bcf86cd799439015",
        "507f1f77bcf86cd799439016"
      ],
      "billing": {
        "type": "MANUAL",
        "": [
          {
            "": "INVOICE_POSITION",
            "quantity": 2.5,
            "unit": "hours",
            "price": 32.5,
            "tax": 0.19,
            "taxRate": {
              "_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>"
              },
              "type": "VAT",
              "rate": 0.19,
              "description": "Regelsteuersatz",
              "bookingAccountNumber": "8400",
              "skontoBookingAccountNumber": "8405",
              "default": false
            },
            "title": "Cleaning Service",
            "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": "<any>",
    "masterJobId": "<string>",
    "needsJobTemplate": "<any>",
    "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",
        "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
      }
    ],
    "regionId": "<string>",
    "isCommitment": true,
    "splitId": "<string>",
    "acceptedStatus": "<any>",
    "jobComment": "<string>",
    "teamId": "<string>",
    "activityType": {
      "_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>"
      },
      "name": "Unterhaltsreinigung",
      "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": "<any>"
      }
    ],
    "absences": [
      {
        "_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>"
        },
        "absenceId": "<string>",
        "dtStart": "2023-11-07T05:31:56Z",
        "dtEnd": "2023-11-07T05:31:56Z",
        "calculationType": "<string>"
      }
    ],
    "documentIds": [
      "<string>"
    ]
  }
]

Authorizations

x-API-Key
string
header
required

Body

application/json

Time frame and optional filters

The body is of type object.

Response

200
application/json

Jobs retrieved successfully

The response is of type Job · object[].