Update a job

curl --request PATCH \
  --url https://cloud-api.pland.app/v2/jobs/{id}/v2 \
  --header 'Content-Type: application/json' \
  --header 'x-API-Key: <api-key>' \
  --data '
{
  "job": {
    "targetTime": 3600,
    "iCalendar": {
      "frequency": "WEEKLY",
      "interval": 1,
      "dtstart": "1793865600000",
      "byDay": [
        "MO"
      ]
    }
  },
  "userIds": [
    "665f1c2e9b1e8a0012345678"
  ],
  "type": "FUTURE"
}
'

import requests

url = "https://cloud-api.pland.app/v2/jobs/{id}/v2"

payload = {
    "job": {
        "targetTime": 3600,
        "iCalendar": {
            "frequency": "WEEKLY",
            "interval": 1,
            "dtstart": "1793865600000",
            "byDay": ["MO"]
        }
    },
    "userIds": ["665f1c2e9b1e8a0012345678"],
    "type": "FUTURE"
}
headers = {
    "x-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    job: {
      targetTime: 3600,
      iCalendar: {frequency: 'WEEKLY', interval: 1, dtstart: '1793865600000', byDay: ['MO']}
    },
    userIds: ['665f1c2e9b1e8a0012345678'],
    type: 'FUTURE'
  })
};

fetch('https://cloud-api.pland.app/v2/jobs/{id}/v2', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.pland.app/v2/jobs/{id}/v2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'job' => [
        'targetTime' => 3600,
        'iCalendar' => [
                'frequency' => 'WEEKLY',
                'interval' => 1,
                'dtstart' => '1793865600000',
                'byDay' => [
                                'MO'
                ]
        ]
    ],
    'userIds' => [
        '665f1c2e9b1e8a0012345678'
    ],
    'type' => 'FUTURE'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud-api.pland.app/v2/jobs/{id}/v2"

	payload := strings.NewReader("{\n  \"job\": {\n    \"targetTime\": 3600,\n    \"iCalendar\": {\n      \"frequency\": \"WEEKLY\",\n      \"interval\": 1,\n      \"dtstart\": \"1793865600000\",\n      \"byDay\": [\n        \"MO\"\n      ]\n    }\n  },\n  \"userIds\": [\n    \"665f1c2e9b1e8a0012345678\"\n  ],\n  \"type\": \"FUTURE\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://cloud-api.pland.app/v2/jobs/{id}/v2")
  .header("x-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"job\": {\n    \"targetTime\": 3600,\n    \"iCalendar\": {\n      \"frequency\": \"WEEKLY\",\n      \"interval\": 1,\n      \"dtstart\": \"1793865600000\",\n      \"byDay\": [\n        \"MO\"\n      ]\n    }\n  },\n  \"userIds\": [\n    \"665f1c2e9b1e8a0012345678\"\n  ],\n  \"type\": \"FUTURE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud-api.pland.app/v2/jobs/{id}/v2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"job\": {\n    \"targetTime\": 3600,\n    \"iCalendar\": {\n      \"frequency\": \"WEEKLY\",\n      \"interval\": 1,\n      \"dtstart\": \"1793865600000\",\n      \"byDay\": [\n        \"MO\"\n      ]\n    }\n  },\n  \"userIds\": [\n    \"665f1c2e9b1e8a0012345678\"\n  ],\n  \"type\": \"FUTURE\"\n}"

response = http.request(request)
puts response.read_body

{
  "_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>",
    "agentId": "<string>",
    "assistantId": "<string>"
  },
  "chatId": "<string>",
  "assignmentId": "<string>",
  "targetTime": 123,
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "userId": "<string>",
  "wrapperId": "<string>",
  "absenceId": "<string>",
  "iCalendar": {
    "frequency": "<string>",
    "tzid": "<string>",
    "interval": 123,
    "rrule": "<string>",
    "bySetPos": 123,
    "byDay": [
      "<string>"
    ],
    "byMonthDay": "<string>",
    "byMonth": [
      123
    ],
    "dtstart": "1793865600000",
    "dtend": "1796457600000",
    "exDate": [
      123
    ]
  },
  "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>",
      "agentId": "<string>",
      "assistantId": "<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": "1793865600000",
      "dtend": "1796457600000",
      "exDate": [
        123
      ]
    },
    "material": [
      {
        "productId": "507f1f77bcf86cd799439013",
        "quantity": 2
      }
    ],
    "activityTypeId": "507f1f77bcf86cd799439014",
    "comment": "Special instructions for weekend work",
    "documentIds": [
      "507f1f77bcf86cd799439015",
      "507f1f77bcf86cd799439016"
    ],
    "billing": {
      "type": "MANUAL",
      "positions": [
        {
          "quantity": 2.5,
          "unit": "hours",
          "price": 32.5,
          "tax": 0.19,
          "title": "Cleaning Service",
          "type": "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>",
              "agentId": "<string>",
              "assistantId": "<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",
          "assignmentId": "<string>"
        }
      ],
      "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",
    "useUserPayTypeOnly": true,
    "linkedCache": [
      {}
    ]
  },
  "masterJobId": "<string>",
  "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>",
        "agentId": "<string>",
        "assistantId": "<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>",
        "agentId": "<string>",
        "assistantId": "<string>"
      },
      "chatId": "<string>",
      "userId": "<string>",
      "timeTrackingId": "<string>",
      "type": "<string>",
      "objectId": "<string>",
      "workingTime": 123,
      "targetTime": 123,
      "reason": "<string>",
      "approvedByUserId": "<string>",
      "updatedByUserId": "<string>",
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "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>",
            "agentId": "<string>",
            "assistantId": "<string>"
          },
          "surchargeId": "<string>",
          "name": "<string>",
          "surcharge": 123,
          "surchargeType": "percent",
          "wage": 123,
          "taxFreeType": "none",
          "taxFreeNumber": 123,
          "activeOn": {},
          "userId": "<string>",
          "date": "2023-12-25",
          "activeTimeFrames": [
            {
              "from": "2023-11-07T05:31:56Z",
              "to": "2023-11-07T05:31:56Z"
            }
          ],
          "_cash": 0
        }
      ],
      "workloadSurcharges": [
        {
          "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>",
            "agentId": "<string>",
            "assistantId": "<string>"
          },
          "surchargeId": "<string>",
          "name": "<string>",
          "surcharge": 123,
          "surchargeType": "percent",
          "wage": 123,
          "taxFreeType": "none",
          "taxFreeNumber": 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,
      "drivingTimeFrame": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "payTypeId": "<string>",
      "payTypeSource": "user_default",
      "assignmentId": "<string>",
      "activityTypeId": "<string>",
      "releasedBySystem": true,
      "locked": true
    }
  ],
  "splitId": "<string>",
  "acceptedStatus": "<string>",
  "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>",
      "agentId": "<string>",
      "assistantId": "<string>"
    },
    "hexCode": "#34c759",
    "description": "Regular maintenance cleaning activities",
    "payTypeId": "<string>"
  },
  "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>",
        "agentId": "<string>",
        "assistantId": "<string>"
      }
    }
  ],
  "documentIds": [
    "<string>"
  ],
  "serviceReportId": "<string>"
}

Jobs

Update a Job

Update a job (v2). The job fields go into the job object, the edit options next to it.

Warning: only use this endpoint if you know exactly what it does. It applies the same logic as the PlanD planner: with type FUTURE it can split a recurring series, with THIS it detaches a single occurrence, and userIds replaces the assigned users (omitting it unassigns all current users). A wrong request changes the schedule of your employees. Try your requests against the sandbox server first.

PATCH

jobs

{id}

Update a job

curl --request PATCH \
  --url https://cloud-api.pland.app/v2/jobs/{id}/v2 \
  --header 'Content-Type: application/json' \
  --header 'x-API-Key: <api-key>' \
  --data '
{
  "job": {
    "targetTime": 3600,
    "iCalendar": {
      "frequency": "WEEKLY",
      "interval": 1,
      "dtstart": "1793865600000",
      "byDay": [
        "MO"
      ]
    }
  },
  "userIds": [
    "665f1c2e9b1e8a0012345678"
  ],
  "type": "FUTURE"
}
'

import requests

url = "https://cloud-api.pland.app/v2/jobs/{id}/v2"

payload = {
    "job": {
        "targetTime": 3600,
        "iCalendar": {
            "frequency": "WEEKLY",
            "interval": 1,
            "dtstart": "1793865600000",
            "byDay": ["MO"]
        }
    },
    "userIds": ["665f1c2e9b1e8a0012345678"],
    "type": "FUTURE"
}
headers = {
    "x-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    job: {
      targetTime: 3600,
      iCalendar: {frequency: 'WEEKLY', interval: 1, dtstart: '1793865600000', byDay: ['MO']}
    },
    userIds: ['665f1c2e9b1e8a0012345678'],
    type: 'FUTURE'
  })
};

fetch('https://cloud-api.pland.app/v2/jobs/{id}/v2', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.pland.app/v2/jobs/{id}/v2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'job' => [
        'targetTime' => 3600,
        'iCalendar' => [
                'frequency' => 'WEEKLY',
                'interval' => 1,
                'dtstart' => '1793865600000',
                'byDay' => [
                                'MO'
                ]
        ]
    ],
    'userIds' => [
        '665f1c2e9b1e8a0012345678'
    ],
    'type' => 'FUTURE'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud-api.pland.app/v2/jobs/{id}/v2"

	payload := strings.NewReader("{\n  \"job\": {\n    \"targetTime\": 3600,\n    \"iCalendar\": {\n      \"frequency\": \"WEEKLY\",\n      \"interval\": 1,\n      \"dtstart\": \"1793865600000\",\n      \"byDay\": [\n        \"MO\"\n      ]\n    }\n  },\n  \"userIds\": [\n    \"665f1c2e9b1e8a0012345678\"\n  ],\n  \"type\": \"FUTURE\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://cloud-api.pland.app/v2/jobs/{id}/v2")
  .header("x-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"job\": {\n    \"targetTime\": 3600,\n    \"iCalendar\": {\n      \"frequency\": \"WEEKLY\",\n      \"interval\": 1,\n      \"dtstart\": \"1793865600000\",\n      \"byDay\": [\n        \"MO\"\n      ]\n    }\n  },\n  \"userIds\": [\n    \"665f1c2e9b1e8a0012345678\"\n  ],\n  \"type\": \"FUTURE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud-api.pland.app/v2/jobs/{id}/v2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"job\": {\n    \"targetTime\": 3600,\n    \"iCalendar\": {\n      \"frequency\": \"WEEKLY\",\n      \"interval\": 1,\n      \"dtstart\": \"1793865600000\",\n      \"byDay\": [\n        \"MO\"\n      ]\n    }\n  },\n  \"userIds\": [\n    \"665f1c2e9b1e8a0012345678\"\n  ],\n  \"type\": \"FUTURE\"\n}"

response = http.request(request)
puts response.read_body

{
  "_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>",
    "agentId": "<string>",
    "assistantId": "<string>"
  },
  "chatId": "<string>",
  "assignmentId": "<string>",
  "targetTime": 123,
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "userId": "<string>",
  "wrapperId": "<string>",
  "absenceId": "<string>",
  "iCalendar": {
    "frequency": "<string>",
    "tzid": "<string>",
    "interval": 123,
    "rrule": "<string>",
    "bySetPos": 123,
    "byDay": [
      "<string>"
    ],
    "byMonthDay": "<string>",
    "byMonth": [
      123
    ],
    "dtstart": "1793865600000",
    "dtend": "1796457600000",
    "exDate": [
      123
    ]
  },
  "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>",
      "agentId": "<string>",
      "assistantId": "<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": "1793865600000",
      "dtend": "1796457600000",
      "exDate": [
        123
      ]
    },
    "material": [
      {
        "productId": "507f1f77bcf86cd799439013",
        "quantity": 2
      }
    ],
    "activityTypeId": "507f1f77bcf86cd799439014",
    "comment": "Special instructions for weekend work",
    "documentIds": [
      "507f1f77bcf86cd799439015",
      "507f1f77bcf86cd799439016"
    ],
    "billing": {
      "type": "MANUAL",
      "positions": [
        {
          "quantity": 2.5,
          "unit": "hours",
          "price": 32.5,
          "tax": 0.19,
          "title": "Cleaning Service",
          "type": "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>",
              "agentId": "<string>",
              "assistantId": "<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",
          "assignmentId": "<string>"
        }
      ],
      "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",
    "useUserPayTypeOnly": true,
    "linkedCache": [
      {}
    ]
  },
  "masterJobId": "<string>",
  "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>",
        "agentId": "<string>",
        "assistantId": "<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>",
        "agentId": "<string>",
        "assistantId": "<string>"
      },
      "chatId": "<string>",
      "userId": "<string>",
      "timeTrackingId": "<string>",
      "type": "<string>",
      "objectId": "<string>",
      "workingTime": 123,
      "targetTime": 123,
      "reason": "<string>",
      "approvedByUserId": "<string>",
      "updatedByUserId": "<string>",
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "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>",
            "agentId": "<string>",
            "assistantId": "<string>"
          },
          "surchargeId": "<string>",
          "name": "<string>",
          "surcharge": 123,
          "surchargeType": "percent",
          "wage": 123,
          "taxFreeType": "none",
          "taxFreeNumber": 123,
          "activeOn": {},
          "userId": "<string>",
          "date": "2023-12-25",
          "activeTimeFrames": [
            {
              "from": "2023-11-07T05:31:56Z",
              "to": "2023-11-07T05:31:56Z"
            }
          ],
          "_cash": 0
        }
      ],
      "workloadSurcharges": [
        {
          "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>",
            "agentId": "<string>",
            "assistantId": "<string>"
          },
          "surchargeId": "<string>",
          "name": "<string>",
          "surcharge": 123,
          "surchargeType": "percent",
          "wage": 123,
          "taxFreeType": "none",
          "taxFreeNumber": 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,
      "drivingTimeFrame": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "payTypeId": "<string>",
      "payTypeSource": "user_default",
      "assignmentId": "<string>",
      "activityTypeId": "<string>",
      "releasedBySystem": true,
      "locked": true
    }
  ],
  "splitId": "<string>",
  "acceptedStatus": "<string>",
  "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>",
      "agentId": "<string>",
      "assistantId": "<string>"
    },
    "hexCode": "#34c759",
    "description": "Regular maintenance cleaning activities",
    "payTypeId": "<string>"
  },
  "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>",
        "agentId": "<string>",
        "assistantId": "<string>"
      }
    }
  ],
  "documentIds": [
    "<string>"
  ],
  "serviceReportId": "<string>"
}

Authorizations

x-API-Key

string

header

required

Path Parameters

string<objectid>

required

Job ID

Query Parameters

updateTeam

enum<string>

Apply the update to all jobs of the team

Available options:

true,

false

Body

application/json

job

Job · object

required

The job fields to set. targetTime (seconds) and iCalendar are required.

Show child attributes

userIds

string<objectid>[]

The full set of assigned users after the update. Omitting it unassigns the current users.

type

enum<string>

Edit only this occurrence or this and all future ones. Default: FUTURE

Available options:

THIS,

FUTURE

splitDate

integer<int64>

Occurrence date where the series is split (epoch ms)

exDate

integer<int64>

Occurrence date to exclude from the series (epoch ms)

changedFrom

integer<int64>

Date the occurrence was moved from (epoch ms)

changedTo

integer<int64>

Date the occurrence was moved to (epoch ms)

unset

string[]

Job fields to remove

Response

Job updated

A job assigned to a user or object, with scheduling, assignment, and status information. Inherits common fields from ChatableEntityModel.

_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

Show child attributes

chatId

string<objectid> | null

ID of the chat associated with this entity

assignmentId

string<objectid>

Assignment ID

targetTime

number<float>

Target time for the job in seconds (at most 86400)

from

string<date-time>

Start time of the job

string<date-time>

End time of the job

userId

string<objectid>

ID of the user

wrapperId

string<objectid> | null

Wrapper ID

absenceId

string<objectid>

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

iCalendar

object

Represents a structured iCalendar object with recurrence rules

Show child attributes

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.

Show child attributes

masterJobId

string<objectid>

Master job ID if this is a replacement job

timeTrackings

Time Tracking Entry · object[]

Time tracking entries for the job

Show child attributes

salaries

Salary · object[]

Salaries for the job

Show child attributes

splitId

string<objected> | null

Split job ID

acceptedStatus

string

Accepted status

jobComment

string

Comment for the job

teamId

string<objectid> | null

Team ID

activityType

Activity Type · object | null

Activity type for the job

Show child attributes

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

Show child attributes

absences

JobAbsencesStruct · object[]

Absences related to the job

Show child attributes

documentIds

string<objectid>[]

Document IDs related to the job

serviceReportId

string<objectid> | null

Service Report ID if job is linked to a service report

Getting Started

Users

Salaries

Jobs

Time Tracking

Objects

Customers

Equipment

Articles

Tasks

Task Types

Absences

Material Orders

Quality Control

Documents

Logbuch

Webhooks

Update a Job

Authorizations

Path Parameters

Query Parameters

Body

Response