{"openapi":"3.0.0","info":{"title":"geoCapture API","description":"\u003Cp\u003E\n\t\t\t\t\tThis interface provides different endpoints to integrate geoCapture into your software solutions, \n\t\t\t\t\toffering a variety of functionalities for time-tracking, gps tracking services, disposition, and \n\t\t\t\t\tmany more.\u003Cbr\u003E \n\t\t\t\t\t\u003Cbr\u003E\n\t\t\t\t\tTime tracking can be achieved through the generation of stamps using this API. These stamps can be \n\t\t\t\t\tused to record employees\u0027 working hours. \u003Cbr\u003E\n\t\t\t\t\t\u003Cbr\u003E\n\t\t\t\t\tAuthentication in the geoCapture API is handled by passing the \u0022apitoken\u0022 as a query parameter.\n\t\t\t\t\tDevelopers must include the \u0022apitoken\u0022 value in their API requests to authenticate and access \n\t\t\t\t\tthe endpoints.\u003Cbr\u003E\t\n\t\t\t\t\t\u003Cbr\u003E\n\t\t\t\t\tThis documentation allows you to try out the different endpoints by entering an API key when you \n\t\t\t\t\tclick on the lock icon or on the Authorize Button.\u003Cbr\u003E\n\t\t\t\t\t\u003Cbr\u003E\n\t\t\t\t\tThis interface is rate limited. You are able to do 100 requests per minute. Further requests are \n\t\t\t\t\tblocked when the rate limit is reached. You will receive a response with the status 429 \u0022Too Many\n\t\t\t\t\tRequests\u0022. To ensure optimal performance and avoid hitting this limit, we advise minimizing the \n\t\t\t\t\tnumber of API requests. This approach not only helps in adhering to the rate limit but also enhances \n\t\t\t\t\toverall system efficiency and reliability. Strategies like batch processing, caching, and optimizing \n\t\t\t\t\tdata queries can significantly reduce the number of necessary requests, providing a smoother and \n\t\t\t\t\tmore cost-effective user experience.\u003Cbr\u003E\n\t\t\t\t\t\u003Cbr\u003E\n\t\t\t\t\tPlease note that the API does not support tracking data input into the system.\n\t\t\t\t\tInstead, it provides endpoints to manage and retrieve data related to tracking, such as GPS records. \n\t\t\t\t\tand beacon data, ensuring proper data security and management within the geoCapture system.\u003Cbr\u003E\n\t\t\t\t\t\u003Cbr\u003E\n\t\t\t\t\tIn case of questions or errors, please contact our support team at \n\t\t\t\t\t\u003Ca href=\u0022tel:+49545893666872\u0022\u003E+49 5458 93666872\u003C\/a\u003E or \n\t\t\t\t\t\u003Ca href=\u0022mailto:info@geocapture.de\u0022\u003Einfo@geocapture.de\u003C\/a\u003E.\n\t\t\t\t\u003C\/p\u003E","version":"1.1.0","contact":{"name":"geoCapture GmbH","url":"https:\/\/geocapture.de","email":"support@geocapture.de"},"license":{"name":"Proprietary"}},"servers":[{"url":"https:\/\/app.geocapture.net\/api","description":"geoCapture API"}],"tags":[{"name":"Containers|Container","description":"This interface allows you to fetch a list of containers."},{"name":"Containers|Container inquiry","description":"This interface allows you to fetch a list of, create and update container inquirys."},{"name":"Containers|Container type","description":"This interface allows you to fetch a list of container types."},{"name":"Cost control|Cost Booking"},{"name":"Cost control|Tool cost setting","description":"This interface allows you to fetch the tool cost setting or create new setting entries"},{"name":"Cost control|Tracker cost setting","description":"This interface allows you to fetch the tracker cost settting or create new setting entries"},{"name":"Cost control|Wage group","description":"This interface allows you to fetch, update or create wage groups."},{"name":"Cost control|Wage group cost setting","description":"This interface allows you to fetch the wage group cost settings or create new setting entries"},{"name":"Cost control|Wage group employee setting","description":"This interface allows you to fetch the wage group employee settings or create new setting entries"},{"name":"Disposition|Dispo type","description":"This interface allows you to fetch dispo types, details to dispo types, dispo teams, qualifications and districts."},{"name":"Disposition|Qualifications","description":"This interface allows you to fetch a list of dispo qualifications."},{"name":"Disposition|Tour","description":"This interface allows you to fetch tour details, add, update and delete tours and to calculate and optmize tours."},{"name":"Documents|File","description":"This interface allows you tou to fetch a list of files, download files, create and delete files and fetch a list of\nfile types."},{"name":"Documents|Form data","description":"This interface allows you to fetch form data, generate a pdf from form data, fetch a changelog and fetch media from\nform data."},{"name":"Documents|Form definition","description":"This interface allows you to fetch a list with details about form definitions."},{"name":"Employees|Department","description":"This interface allows you to fetch information about departments."},{"name":"Employees|Employee","description":"This interface allows you to fetch, create, update and delete employee data."},{"name":"Employees|Location","description":"This interface allows you to fetch a list of locations."},{"name":"Maintenance|Maintenance","description":"This interface allows you to fetch and create maintenances."},{"name":"Maintenance|Maintenance Log","description":"This interface allows you to create maintenances logs."},{"name":"Maintenance|Maintenance Type","description":"This interface allows you to fetch maintenance types."},{"name":"Miscellaneous|Approval","description":"This interface allows you to request approvals, update the status of approvals or create new approval applications."},{"name":"Miscellaneous|Approval Rule","description":"This interface allows you to fetch a list of approval rules."},{"name":"Miscellaneous|Geocoding","description":"This interface allows you to convert an address to a latitude and longitude or vice versa."},{"name":"Miscellaneous|Job","description":"This interface allows you to request a status of a job."},{"name":"Orders|Order","description":"This interface allows you to fetch an order list, request details, delete an order and to create and update orders."},{"name":"Orders|Order category","description":"This interface allows you to fetch a list with details about an order category."},{"name":"Orders|Order importer","description":"This interface allows you to import base64 encoded files as orders."},{"name":"Projects|Bill of quantities","description":"This interface allows you to fetch details, update, create and delete bill of quantities."},{"name":"Projects|Project","description":"This interface allows you to fetch a list of projects and to create, update and delete projects."},{"name":"Projects|Project assignment","description":"This interface allows you to fetch, create, update and delete project assignments."},{"name":"Projects|Project category","description":"This interface allows you to fetch a list of project categories."},{"name":"Projects|Project time","description":"This interface allows you to request the operating hours and working hours of a project."},{"name":"Resources|Resource Planning","description":"This interface allows you to fetch a list of resource assignments."},{"name":"Routing | Route","description":"This interface allows you to calculate a route between two points."},{"name":"Time Tracking|Absence","description":"This interface allows you to request employee absences, delete existing absences and create new ones."},{"name":"Time Tracking|Absence type","description":"This interface allows you to request detailed information about absence types."},{"name":"Time Tracking|Employee Accounting Entry","description":"This interface allows you to request accounting entries, delete existing accounting entries and create new ones."},{"name":"Time Tracking|Employee Stamp","description":"This interface allows you to fetch and create stamps."},{"name":"Time Tracking|Employee time tracking","description":"This interface allows you to request the employee\u0027s time sheet, hour account, and vacation account."},{"name":"Time Tracking|Salary type","description":"This interface allows you to fetch a list of salary types."},{"name":"Tools|Tool","description":"This interface allows you to fetch a list of tools, fetch details, create, update and delete tools."},{"name":"Tools|Tool category","description":"This interface allows you to fetch a list of tool categories."},{"name":"Tools|Tool manufacturer","description":"This interface allows you to fetch a list of tool manufacturers including the standard manufacturers provided by\ngeoCapture."},{"name":"Tracking|Beacon","description":"This interface allows you to request detailed information, like the current postion of beacons, and update beacon\ninformation."},{"name":"Tracking|Beacon Map Embedding","description":"This interface allows you to embed a beacon map into your application."},{"name":"Tracking|Counter","description":"This interface allows you to fetch detailed values about tracking devices such as driven distances."},{"name":"Tracking|Event","description":"This interface allows you to request events from trackers (e.g. drives, stops, ...)."},{"name":"Tracking|GPS record","description":"This interface allows you to request GPS records."},{"name":"Tracking|Tracker health","description":"This interface allows you to check for issues with a vehicle tracker."},{"name":"Tracking|Vehicle","description":"This interface allows you to fetch a list of vehicles and update vehicle information such as the name."},{"name":"Tracking|Vehicle Map Embedding","description":"This endpoint allows you to embed a map of tracking devices within your app or fetch the current tracking positions\nof these devices."},{"name":"Tracking|Vehicle category","description":"This interface allows you to fetch a list of tracker categories."},{"name":"Tracking|Vehicle manufacturer","description":"This interface allows you to fetch a list of tracker manufacturers and create\/update tracker manufacturers."},{"name":"Tracking|Vehicle profile","description":"This interface allows you to fetch a list of tracker profiles"},{"name":"Webhook|Application","description":"This interface allows you to manage webhook applications."},{"name":"Webhook|Webhook","description":"This interface allows you to manage webhooks."}],"components":{"schemas":{"DateTime":{"type":"string","description":"Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd\u0027T\u0027HH:mm:ssxxx","example":"2015-02-20T12:59:21+01:00"},"Date":{"type":"string","description":"Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd","example":"2015-02-20"},"Time":{"type":"string","description":"Represents a time. (ISO 8601) ICU-Format: HH:mm:ss","example":"12:59:21"},"ComponentHttpFoundationResponse":{"type":"object","description":"Represents a formless response. (HTML, Text, ...)"},"ComponentGeocodingAddressInterface":{"type":"object","description":"Represents an address","properties":{"latLng":{"description":"The geo coordinate.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"name":{"type":"string","description":"The address name."},"street":{"type":"string","description":"The complete street."},"streetName":{"type":"string","description":"The street name."},"streetNumber":{"type":"string","description":"The house number."},"zipCode":{"type":"string","description":"The postcode."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two digit country abbreviation. (ISO-3166 ALPHA-2)"},"fullAddress":{"type":"string","description":"The complete address."}}},"DynamicWeekdayTime":{"type":"object","description":"Represents dynamic weekday times\n\n~~~\nJSON format:\n~~~\n{\u0022MO\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]],\u0022WE\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]],\u0022FR\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]]}\n~~~","properties":{"MO":{"description":"monday","type":"object","$ref":"#\/components\/schemas\/StandardCoreTypeDynamicWeekdayTimes"},"TU":{"description":"tuesday","type":"object","$ref":"#\/components\/schemas\/StandardCoreTypeDynamicWeekdayTimes"},"WE":{"description":"wednesday","type":"object","$ref":"#\/components\/schemas\/StandardCoreTypeDynamicWeekdayTimes"},"TH":{"description":"thursday","type":"object","$ref":"#\/components\/schemas\/StandardCoreTypeDynamicWeekdayTimes"},"FR":{"description":"friday","type":"object","$ref":"#\/components\/schemas\/StandardCoreTypeDynamicWeekdayTimes"},"SA":{"description":"saturday","type":"object","$ref":"#\/components\/schemas\/StandardCoreTypeDynamicWeekdayTimes"},"SU":{"description":"sunday","type":"object","$ref":"#\/components\/schemas\/StandardCoreTypeDynamicWeekdayTimes"}}},"ComponentGeocodingLatLngInterface":{"type":"array","description":"Represents a geo coordinate. An array of two double values, representing the latitude and longitude.","example":[52.38127828631681,7.594243214018696],"items":{"type":"number"}},"ComponentGeocodingLatLngBoundsInterface":{"type":"object","description":"Represents a rectangle in geo coordinates","properties":{"minLatLng":{"description":"Min. Latitude\/Longitude","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"maxLatLng":{"description":"Max. Latitude\/Longitude","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"}}},"StandardContainerFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The containers.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerBaseContainerListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available containers."}}},"StandardContainerBaseContainerListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the container."},"reference":{"type":"string","description":"The reference of the container."},"type":{"description":"The container type.","type":"object","$ref":"#\/components\/schemas\/StandardContainerTypeBaseContainerTypeListItem"},"purchaseDate":{"description":"The date the container was bought.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardContainerTypeBaseContainerTypeListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the container type."},"name":{"type":"string","description":"The name of the container type."}}},"ContainerFetchRequestContainerFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the containers based on the internal IDs."},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters the containers based on the references."}}},"StandardContainerFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The container filter.","type":"object","$ref":"#\/components\/schemas\/ContainerFetchRequestContainerFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records."}}},"StandardContainerInquiryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The container inquirys.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerInquiryBaseContainerInquiryListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available container inquirys."}}},"StandardContainerInquiryBaseContainerInquiryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the container inquiry."},"name":{"type":"string","description":"The name of the container inquiry."},"container":{"description":"The container assigned to the inquiry.","type":"object","$ref":"#\/components\/schemas\/StandardContainerBaseContainerListItem"},"containerType":{"description":"The container type assigned to the inquiry.","type":"object","$ref":"#\/components\/schemas\/StandardContainerTypeBaseContainerTypeListItem"}}},"ContainerInquiryFetchRequestContainerInquiryFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the container inquirys based on the internal IDs."},"byContainerIds":{"type":"array","items":{"type":"integer"},"description":"Filters the container inquirys based on the container ids."},"byContainerReferences":{"type":"array","items":{"type":"string"},"description":"Filters the container inquirys based on the container references."},"byContainerTypeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the container inquirys based on the container type IDs."}}},"StandardContainerInquiryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The container inquiry filter.","type":"object","$ref":"#\/components\/schemas\/ContainerInquiryFetchRequestContainerInquiryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records."}}},"StandardContainerInquiryUpsertResponse":{"type":"object","description":"","properties":{"createdContainerInquiries":{"description":"The created container inquiries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ContainerInquiryUpsertRequestContainerInquiryItem"},{"description":""}]}},"updatedContainerInquiries":{"description":"The changed container inquiries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ContainerInquiryUpsertRequestContainerInquiryItem"},{"description":""}]}},"deletedContainerInquiries":{"description":"The deleted container inquiries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ContainerInquiryUpsertRequestContainerInquiryItem"},{"description":""}]}}}},"ContainerInquiryUpsertRequestContainerInquiryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the container inquiry."},"name":{"type":"string","description":"The name of the container inquiry. (max. 128 characters)"},"type":{"type":"string","description":"The container inquiry type.\n\n| type |\n| ---- |\n| CLEANING | container needs to be specified |\n| COLLECTION | container needs to be specified |\n| DELIVERY | container or container type needs to be specified |\n| FOUND | container or container type needs to be specified |\n| PICKUP | container needs to be specified |\n| REFILL | container needs to be specified |\n| REPLACEMENT | container needs to be specified |"},"containerId":{"type":"integer","description":"The internal id of the container."},"containerTypeId":{"type":"integer","description":"The internal id of the container type."},"amount":{"type":"integer","description":"The amount of containers. Only for container type deliveries that allow the amount input."},"projectId":{"type":"integer","description":"The internal id of the assigned project. If no other address is set the address of this project will be used."},"street":{"type":"string","description":"The street for the inquiry. (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code for the inquiry."},"city":{"type":"string","description":"The city for the inquiry. (max. 255 characters)"},"countryCode":{"type":"string","description":"The country code for the inquiry."},"latLng":{"description":"The geo-coordinates","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonPhoneNumber":{"type":"string","description":"The phone number for the contact person. (max. 64 characters)"},"contactPersonName":{"type":"string","description":"The name of the contact person. (max. 255 characters)"},"targetDateTime":{"description":"The targeted date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"note":{"type":"string","description":"Additional notes."}}},"ContainerInquiryUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal container inquiry ID        |"},"data":{"description":"The container inquiry record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/ContainerInquiryUpsertRequestRecordData"}}},"ContainerInquiryUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the container inquiry."},"name":{"type":"string","description":"The name of the container inquiry. (max. 128 characters)"},"type":{"type":"string","description":"The container inquiry type.\n\n| type |\n| ---- |\n| CLEANING | container needs to be specified |\n| COLLECTION | container needs to be specified |\n| DELIVERY | container or container type needs to be specified |\n| FOUND | container or container type needs to be specified |\n| PICKUP | container needs to be specified |\n| REFILL | container needs to be specified |\n| REPLACEMENT | container needs to be specified |"},"containerId":{"type":"integer","description":"The internal id of the container."},"containerTypeId":{"type":"integer","description":"The internal id of the container type."},"amount":{"type":"integer","description":"The amount of containers. Only for container type deliveries that allow the amount input."},"projectId":{"type":"integer","description":"The internal id of the assigned project. If no other address is set the address of this project will be used."},"street":{"type":"string","description":"The street for the inquiry. (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code for the inquiry."},"city":{"type":"string","description":"The city for the inquiry. (max. 255 characters)"},"countryCode":{"type":"string","description":"The country code for the inquiry."},"latLng":{"description":"The geo-coordinates","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonPhoneNumber":{"type":"string","description":"The phone number for the contact person. (max. 64 characters)"},"contactPersonName":{"type":"string","description":"The name of the contact person. (max. 255 characters)"},"targetDateTime":{"description":"The targeted date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"note":{"type":"string","description":"Additional notes."}}},"StandardContainerInquiryUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ContainerInquiryUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all tools missing from this request? This Parameter is optional. (Default: false)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardEmployeeStampFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The emplyoee stamps.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ApiHelperResponseEmployeeStampItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available employee stamps.\n(Calculated only if the offset is 0)"}}},"ApiHelperResponseEmployeeStampItem":{"type":"object","description":"","properties":{"employeeId":{"type":"integer","description":"The internal employee ID."},"employeeReference":{"type":"string","description":"Personnel number of the employee."},"time":{"description":"Time of the stamp.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"state":{"type":"string","description":"The state of the stamp. \u0022S\u0022 = STAY or \u0022E\u0022 = END."},"note":{"type":"string","description":"Note of the stamp."},"trackerId":{"type":"integer","description":"Tracker ID of the stamp."},"projectId":{"type":"integer","description":"The internal Project ID."},"projectRef":{"type":"string","description":"Project reference of the stamp."},"salaryType":{"type":"string","description":"Salary type of the stamp."},"costCenter":{"type":"string","description":"Cost center of the stamp."},"sourceType":{"type":"string","description":"Source of the stamp.\n\n| Values | Description |\n| ----- | ------------ |\n| ALERT | Event clocking |\n| API | API clocking |\n| BREAK_RULE | Automatic pause clocking |\n| CUSTOM_FORM | Form clocking |\n| EMPLOYEE_APPLICATION | Application clocking |\n| GARMIN | Garmin clocking |\n| MANUAL | Manual clocking |\n| MOBILE_APP | Cell Phone Clocking |\n| TACHOGRAPH | Speedometer card clocking |\n| TERMINAL | Terminal clocking |\n| TRACKER | Vehicle clocking |"},"latLng":{"description":"Position of the stamp.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"importSource":{"type":"string","description":"External data source from which this stamp originates."},"importKey":{"type":"string","description":"External ID from the respective data source."}}},"EmployeeStampFetchRequestEmployeeFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the employee based on the IDs."},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the personal numbers."},"byCardNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the driver card numbers."},"byIbuttonNumbers":{"type":"array","items":{"type":"integer"},"description":"Filters the employees based on the iButton numbers."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the employee import IDs."},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered."}}},"StandardEmployeeStampFetchRequest":{"type":"object","description":"","properties":{"employees":{"description":"The employee filter.","type":"object","$ref":"#\/components\/schemas\/EmployeeStampFetchRequestEmployeeFilter"},"stampId":{"type":"string","description":"Internal Id of the stamp. (Ignores other Filters and returns the specific Stamp)"},"from":{"description":"Start date","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"End date","type":"object","$ref":"#\/components\/schemas\/Date"},"offset":{"type":"integer","description":"Number of records to skip."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardEmployeeStampCreateResponse":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID of the created stamp."}}},"StandardEmployeeStampCreateRequest":{"type":"object","description":"","properties":{"employeeReference":{"type":"string","description":"Personnel number of the employee. (required)"},"time":{"description":"Time of the stamp. (required)","type":"object","$ref":"#\/components\/schemas\/DateTime"},"state":{"type":"string","description":"The state of the stamp. \u0022STAY\u0022 or \u0022END\u0022. (required)"},"note":{"type":"string","description":"Note of the stamp."},"trackerId":{"type":"string","description":"Tracker ID of the stamp."},"trackerVin":{"type":"string","description":"Vehicle identification number for the tracker of the stamp (Used if trackerId not provided)."},"projectRef":{"type":"string","description":"Project reference of the stamp."},"salaryType":{"type":"string","description":"Salary type of the stamp. This referes to the salary type type, not to the salary type name."},"costCenter":{"type":"string","description":"Cost center of the stamp."},"latLng":{"description":"Position of the stamp.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"importSource":{"type":"string","description":"External data source from which this stamp originates."},"importKey":{"type":"string","description":"External ID from the respective data source."}}},"StandardToolFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tools.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolFetchResponseToolListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tools."}}},"ToolFetchResponseToolListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool."},"name":{"type":"string","description":"The name of the tool."},"category":{"type":"string","description":"The name of the tool\u0027s category."},"serialNumber":{"type":"string","description":"The serial number of the tool."},"inventoryNumber":{"type":"string","description":"The inventory number of the tool."},"externalId":{"type":"string","description":"The external ID of the tool."},"status":{"type":"string","description":"The status of the tool."},"manufacturer":{"type":"string","description":"The name of the manufacturer of the tool."},"vehicleId":{"type":"string","description":"The id of the assigned locating device if it is a vehicle."},"beaconId":{"type":"string","description":"The id of the assigned locating device if it is a beacon."},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentProjectChangedAt":{"description":"The time of the last project change.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"createdAt":{"description":"The date the tool was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"licenseNumber":{"type":"string","description":"The license plate of the tool."}}},"StandardToolBaseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name."}}},"ToolFetchRequestToolFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the tools based on the internal IDs."},"bySerialNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the tools based on the serial numbers."},"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters the tools based on the external IDs."},"byBeaconIds":{"type":"array","items":{"type":"string"},"description":"Filters the tools based on beacon IDs."},"byProjectChangedAfter":{"description":"Filter the tools which projectChangedAt is after the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"byLicenseNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the license plates."}}},"StandardToolFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The tool filter.","type":"object","$ref":"#\/components\/schemas\/ToolFetchRequestToolFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records."}}},"StandardToolFetchDataResponse":{"type":"object","description":"","properties":{"tool":{"description":"The tool details.","type":"object","$ref":"#\/components\/schemas\/ToolFetchDataResponseToolItem"}}},"ToolFetchDataResponseToolItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool."},"name":{"type":"string","description":"The name of the tool."},"category":{"type":"string","description":"The name of the tool\u0027s category."},"serialNumber":{"type":"string","description":"The serial number of the tool."},"inventoryNumber":{"type":"string","description":"The inventory number of the tool."},"externalId":{"type":"string","description":"The external ID of the tool."},"status":{"type":"string","description":"The status of the tool."},"manufacturer":{"type":"string","description":"The name of the manufacturer of the tool."},"vehicleId":{"type":"string","description":"The id of the assigned locating device if it is a vehicle."},"beaconId":{"type":"string","description":"The id of the assigned locating device if it is a beacon."},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentProjectChangedAt":{"description":"The time of the last project change.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"createdAt":{"description":"The date the tool was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"licenseNumber":{"type":"string","description":"The license plate of the tool."},"description":{"type":"string","description":"The description of the tool."},"costCenter":{"type":"string","description":"The Cost Center of the tracker."},"beacon":{"description":"The beacon assigned to the tool.","type":"object","$ref":"#\/components\/schemas\/ToolUpsertResponseToolBeaconItem"},"tracker":{"description":"The tracker assigned to the tool.","type":"object","$ref":"#\/components\/schemas\/ToolUpsertResponseToolTrackerItem"},"synchronizeBeacon":{"type":"boolean","description":"Indicates that the beacon mirrors the device\u2019s metadata. The name, photo, description, and serial number are kept synchronized from the device to the beacon.\nWhenever any of these fields on the device changes, the beacon is automatically updated accordingly."}}},"ToolUpsertResponseToolBeaconItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the beacon."},"name":{"type":"string","description":"The name of the beacon."},"description":{"type":"string","description":"The description of the beacon."},"status":{"type":"string","description":"The status of the beacon."},"currentProjectId":{"type":"integer","description":"The current project of the beacon."},"lastSignalAt":{"description":"The datetime the last signal was received.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"latLng":{"description":"The geo-coordinates of the beacon.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"estimatedPosition":{"description":"The estimated geo-coordinates of the beacon.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"}}},"ToolUpsertResponseToolTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tracker."},"name":{"type":"string","description":"The name of the tracker."},"description":{"type":"string","description":"The description of the tracker."},"lastSignalAt":{"description":"The datetime the last signal was received.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"latLng":{"description":"The geo-coordinates of the tracker.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"}}},"StandardToolFetchDataRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool. This Parameter is required."}}},"StandardToolDeleteResponse":{"type":"object","description":"","properties":{"deletedItems":{"description":"The tools that were deleted.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolDeleteResponseToolListItem"},{"description":""}]}}}},"ToolDeleteResponseToolListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool."},"name":{"type":"string","description":"The name of the tool."},"category":{"type":"string","description":"The name of the tool\u0027s category."},"serialNumber":{"type":"string","description":"The serial number of the tool."},"inventoryNumber":{"type":"string","description":"The inventory number of the tool."},"externalId":{"type":"string","description":"The external ID of the tool."},"status":{"type":"string","description":"The status of the tool."},"manufacturer":{"type":"string","description":"The name of the manufacturer of the tool."},"vehicleId":{"type":"string","description":"The id of the assigned locating device if it is a vehicle."},"beaconId":{"type":"string","description":"The id of the assigned locating device if it is a beacon."},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentProjectChangedAt":{"description":"The time of the last project change.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"createdAt":{"description":"The date the tool was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"licenseNumber":{"type":"string","description":"The license plate of the tool."}}},"StandardToolDeleteRequest":{"type":"object","description":"","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"The internal ids of the tool to be deleted. This Parameter is optional."},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardToolUpsertResponse":{"type":"object","description":"","properties":{"createdTools":{"description":"The created tools.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolUpsertResponseToolItem"},{"description":""}]}},"updatedTools":{"description":"The changed tools.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolUpsertResponseToolItem"},{"description":""}]}},"deletedTools":{"description":"The deleted tools.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolUpsertResponseToolItem"},{"description":""}]}}}},"ToolUpsertResponseToolItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool."},"name":{"type":"string","description":"The name of the tool."},"category":{"type":"string","description":"The name of the tool\u0027s category."},"serialNumber":{"type":"string","description":"The serial number of the tool."},"inventoryNumber":{"type":"string","description":"The inventory number of the tool."},"externalId":{"type":"string","description":"The external ID of the tool."},"status":{"type":"string","description":"The status of the tool."},"manufacturer":{"type":"string","description":"The name of the manufacturer of the tool."},"vehicleId":{"type":"string","description":"The id of the assigned locating device if it is a vehicle."},"beaconId":{"type":"string","description":"The id of the assigned locating device if it is a beacon."},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentProjectChangedAt":{"description":"The time of the last project change.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"createdAt":{"description":"The date the tool was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"licenseNumber":{"type":"string","description":"The license plate of the tool."},"description":{"type":"string","description":"The description of the tool."},"costCenter":{"type":"string","description":"The Cost Center of the tracker."},"beacon":{"description":"The beacon assigned to the tool.","type":"object","$ref":"#\/components\/schemas\/ToolUpsertResponseToolBeaconItem"},"tracker":{"description":"The tracker assigned to the tool.","type":"object","$ref":"#\/components\/schemas\/ToolUpsertResponseToolTrackerItem"},"synchronizeBeacon":{"type":"boolean","description":"Indicates that the beacon mirrors the device\u2019s metadata. The name, photo, description, and serial number are kept synchronized from the device to the beacon.\nWhenever any of these fields on the device changes, the beacon is automatically updated accordingly."}}},"ToolUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal tool ID        |\n| externalid     | The external ID of the tool |"},"data":{"description":"The tool record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/ToolUpsertRequestRecordData"}}},"ToolUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool."},"name":{"type":"string","description":"The name of the tool. (max. 255 characters)"},"description":{"type":"string","description":"The description of the tool."},"categoryId":{"type":"integer","description":"The category of the tool."},"categoryName":{"type":"string","description":"The name of the tools\u0027 category (Used if categoryId not provided)."},"serialNumber":{"type":"string","description":"The serial number of the tool. (max. 255 characters)"},"externalId":{"type":"string","description":"The external ID of the tool. (max. 255 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number of the tool. (max. 255 characters)"},"manufacturerId":{"type":"integer","description":"The manufacturer of the tool."},"manufacturerName":{"type":"string","description":"The name of the tools\u0027 manufacturer (Used if manufacturerId not provided)."},"model":{"type":"string","description":"The model of the tool. (max. 255 characters)"},"machineType":{"type":"string","description":"The machine type of the tool. (max. 255 characters)"},"assessory":{"type":"string","description":"Additional information for the tool."},"supplier":{"type":"string","description":"The supplier of the tool. (max. 255 characters)"},"iconName":{"type":"string","description":"Filename of the icon with file extension"},"iconData":{"type":"string","description":"base64 encoded icon"},"purchaseCost":{"type":"number","description":"The purchase costs of the tool."},"purchaseDate":{"description":"The purchase date of the tool.","type":"object","$ref":"#\/components\/schemas\/Date"},"warrantyMonth":{"type":"integer","description":"The warranty of the tool in months."},"yearOfManufacture":{"type":"integer","description":"The tools year of manufacture."},"outgoingDate":{"description":"The outgoing date of the tool.","type":"object","$ref":"#\/components\/schemas\/Date"},"status":{"type":"string","description":"The status of the tool.\n\n| status         |\n| -------------- |\n| NEW            |\n| SOLD           |\n| IN_REPAIR      |\n| LOST           |\n| RESERVED       |\n| OK             |\n| BROKEN         |\n| LENT           |"},"weight":{"type":"number","description":"The weight of the tool in kgs."},"length":{"type":"number","description":"The length of the tool in meters."},"width":{"type":"number","description":"The width of the tool in meters."},"height":{"type":"number","description":"The height of the tool in meters."},"dguvCheckNumber":{"type":"string","description":"The dguv check number of the tool. (max. 32 characters)"},"responsibleEmployeeId":{"type":"integer","description":"The id of the employee responsible for the tool."},"beaconId":{"type":"integer","description":"The internal id of the beacon assigned to the tool (Either a tracker or a beacon can be assigned)."},"trackerId":{"type":"integer","description":"The internal id of the tracker assigned to the tool (Either a tracker or a beacon can be assigned)."},"licenseNumber":{"type":"string","description":"The license plate of the tool. (max. 64 characters)"},"synchronizeBeacon":{"type":"boolean","description":"Indicates that the beacon mirrors the device\u2019s metadata. The name, photo, description, and serial number are kept synchronized from the device to the beacon.\nWhenever any of these fields on the device changes, the beacon is automatically updated accordingly (Default false)."},"costCenter":{"type":"string","description":"The cost center."}}},"StandardToolUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all tools missing from this request? This Parameter is optional. (Default: false)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardEmployeeAccountingEntryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The accounting entries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchResponseEmployeeAccountingEntryListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of accounting entries.\n(Only calculated if offset is 0)"}}},"EmployeeAccountingEntryFetchResponseEmployeeAccountingEntryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the accounting entry."},"employee":{"description":"The employee associated with the accounting entry.","type":"object","$ref":"#\/components\/schemas\/ApiHelperResponseEmployeeReference"},"date":{"description":"The date of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/Date"},"updatedAt":{"description":"The datetime when the accounting entry was updated.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"salaryType":{"description":"The salary type of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchResponseSalaryTypeItem"},"value":{"type":"number","description":"The value of the accounting entry."},"valueUnit":{"type":"string","description":"The value unit of the accounting entry.\n\n | Value                     |  Description                           |\n | ------------------------- | -------------------------------------- |\n | HOUR                      | Hours                                  |\n | DAY                       | Days                                   |\n | CURRENCY                  | Currency                               |\n | QUANTITY                  | Quantity                               |"},"project":{"description":"The project associated with the accounting entry.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchResponseProjectItem"},"description":{"type":"string","description":"The description of the accounting entry."},"costCenter":{"type":"string","description":"The costCenter of the accounting entry. (max. 128 characters)"}}},"ApiHelperResponseEmployeeReference":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"}}},"EmployeeAccountingEntryFetchResponseSalaryTypeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal salary type ID."},"name":{"type":"string","description":"The name of the salary type."},"type":{"type":"string","description":"The salary type."},"isVacation":{"type":"boolean","description":"Whether the salary type is the holiday salary type."}}},"EmployeeAccountingEntryFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name."}}},"EmployeeAccountingEntryFetchRequestEmployeeAccountingEntryFilter":{"type":"object","description":"","properties":{"from":{"description":"Filters the accounting entries based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the accounting entries based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given IDs."},"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given projects."},"bySalaryTypeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given salary types."},"byEmployeeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given employees."}}},"StandardEmployeeAccountingEntryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The accounting entry filter.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchRequestEmployeeAccountingEntryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardEmployeeAccountingEntryDeleteResponse":{"type":"object","description":"","properties":{"deletedEmployeeAccountingEntries":{"description":"The deleted employee accounting entries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAccountingEntryDeleteResponseEmployeeAccountingEntryListItem"},{"description":""}]}}}},"EmployeeAccountingEntryDeleteResponseEmployeeAccountingEntryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the accounting entry."},"employee":{"description":"The employee associated with the accounting entry.","type":"object","$ref":"#\/components\/schemas\/ApiHelperResponseEmployeeReference"},"date":{"description":"The date of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/Date"},"updatedAt":{"description":"The datetime when the accounting entry was updated.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"salaryType":{"description":"The salary type of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchResponseSalaryTypeItem"},"value":{"type":"number","description":"The value of the accounting entry."},"valueUnit":{"type":"string","description":"The value unit of the accounting entry.\n\n | Value                     |  Description                           |\n | ------------------------- | -------------------------------------- |\n | HOUR                      | Hours                                  |\n | DAY                       | Days                                   |\n | CURRENCY                  | Currency                               |\n | QUANTITY                  | Quantity                               |"},"project":{"description":"The project associated with the accounting entry.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchResponseProjectItem"},"description":{"type":"string","description":"The description of the accounting entry."},"costCenter":{"type":"string","description":"The costCenter of the accounting entry. (max. 128 characters)"}}},"EmployeeAccountingEntryDeleteRequestEmployeeAccountingEntryFilter":{"type":"object","description":"","properties":{"from":{"description":"Filters the accounting entries based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the accounting entries based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given IDs."},"byEmployeeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given employees."},"bySalaryTypeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given salary types."},"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the accounting entries based on the given projects."}}},"StandardEmployeeAccountingEntryDeleteRequest":{"type":"object","description":"","properties":{"employee_accounting_entries":{"description":"The employee accounting entry filter. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryDeleteRequestEmployeeAccountingEntryFilter"},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardEmployeeAccountingEntryUpsertResponse":{"type":"object","description":"","properties":{"createdEmployeeAccountingEntries":{"description":"The created employee accounting entries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAccountingEntryUpsertResponseEmployeeAccountingEntryListItem"},{"description":""}]}},"updatedEmployeeAccountingEntries":{"description":"The changed employee accounting entries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAccountingEntryUpsertResponseEmployeeAccountingEntryListItem"},{"description":""}]}},"deletedEmployeeAccountingEntries":{"description":"The deleted employee accounting entries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAccountingEntryUpsertResponseEmployeeAccountingEntryListItem"},{"description":""}]}}}},"EmployeeAccountingEntryUpsertResponseEmployeeAccountingEntryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the accounting entry."},"employee":{"description":"The employee associated with the accounting entry.","type":"object","$ref":"#\/components\/schemas\/ApiHelperResponseEmployeeReference"},"date":{"description":"The date of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/Date"},"updatedAt":{"description":"The datetime when the accounting entry was updated.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"salaryType":{"description":"The salary type of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchResponseSalaryTypeItem"},"value":{"type":"number","description":"The value of the accounting entry."},"valueUnit":{"type":"string","description":"The value unit of the accounting entry.\n\n | Value                     |  Description                           |\n | ------------------------- | -------------------------------------- |\n | HOUR                      | Hours                                  |\n | DAY                       | Days                                   |\n | CURRENCY                  | Currency                               |\n | QUANTITY                  | Quantity                               |"},"project":{"description":"The project associated with the accounting entry.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryFetchResponseProjectItem"},"description":{"type":"string","description":"The description of the accounting entry."},"costCenter":{"type":"string","description":"The costCenter of the accounting entry. (max. 128 characters)"}}},"EmployeeAccountingEntryUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifier the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value | Description          |\n|-------|----------------------|\n| id    | The internal employee accounting entry id |"},"data":{"description":"The employee accounting entry record.\n\nFor updates only the updated fields need to be specified.","type":"object","$ref":"#\/components\/schemas\/EmployeeAccountingEntryUpsertRequestRecordData"}}},"EmployeeAccountingEntryUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the employee accounting entry."},"date":{"description":"The date of the employee accounting entry.","type":"object","$ref":"#\/components\/schemas\/Date"},"description":{"type":"string","description":"The description of the employee accounting entry."},"salaryTypeId":{"type":"integer","description":"The salary type id of the employee accounting entry."},"value":{"type":"number","description":"The value of the employee accounting entry."},"valueUnit":{"type":"string","description":"The value unit of the employee accounting entry."},"projectId":{"type":"integer","description":"The id of the project associated with the employee accounting entry."},"costCenter":{"type":"string","description":"The Costcenter of the employee accounting entry."},"employeeId":{"type":"integer","description":"The id of the employee associated with the accounting entry."}}},"StandardEmployeeAccountingEntryUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAccountingEntryUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardApprovalRuleFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tool categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ApprovalRuleFetchRequestApprovalRuleListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tool categories."}}},"ApprovalRuleFetchRequestApprovalRuleListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the approval rule."},"name":{"type":"string","description":"The name of the approval rule."},"description":{"type":"string","description":"The description of the approval rule."},"positions":{"description":"The rule positions.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardApprovalRuleBaseApprovalRulePositionListItem"},{"description":""}]}},"createdAt":{"description":"Date when the approval rule was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardApprovalRuleBaseApprovalRulePositionListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the approval rule position."},"employee":{"description":"The employee of this position.","type":"object","$ref":"#\/components\/schemas\/StandardApprovalRuleBaseApprovalRulePositionEmployee"},"sequence":{"type":"integer","description":""},"type":{"type":"string","description":""},"supervisor":{"type":"boolean","description":""},"createdAt":{"description":"Date when the approval rule position was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardApprovalRuleBaseApprovalRulePositionEmployee":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the employee."},"name":{"type":"string","description":"The name of the employee."}}},"StandardApprovalRuleFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardMaintenanceLogFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The maintenance logs.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceLogFetchResponseMaintenanceLogListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available maintenance logs."}}},"MaintenanceLogFetchResponseMaintenanceLogListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the maintenance log."},"description":{"type":"string","description":"The description of the maintenance log."},"type":{"type":"string","description":"The maintenance type."},"tracker":{"description":"The vehicle the maintenance log is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardMaintenanceBaseTrackerItem"},"tool":{"description":"The tool the maintenance log is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseToolListItem"},"date":{"description":"The mainteance date.","type":"object","$ref":"#\/components\/schemas\/Date"},"employee":{"type":"string","description":"The name of the employee."},"duration":{"type":"integer","description":"The duration of the maintenance in seconds."},"materialCost":{"type":"number","description":"The material costs of the maintenance."},"serviceCost":{"type":"number","description":"The service costs of the maintenance."},"invoiceNumber":{"type":"string","description":"The invoice number for the maintenance."},"invoiceFileData":{"type":"string","description":"The data of the invoice file (base64 encoded)"},"company":{"type":"string","description":"The company that carried out the maintenance."},"note":{"type":"string","description":"Additional notes."}}},"StandardMaintenanceBaseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"description":{"type":"string","description":"The vehicle description."},"driverName":{"type":"string","description":"The driver name. (max. 255 characters)"},"driverPhoneNumber":{"type":"string","description":"The driver phone number. (max. 255 characters)"},"costCenter":{"type":"string","description":"The cost center. (max. 25 characters)"},"serialNumber":{"type":"string","description":"The serial number of the vehicle."},"manufacturingDate":{"description":"The manufacturing date of the vehicle.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardToolBaseToolListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool."},"name":{"type":"string","description":"The name of the tool."},"category":{"type":"string","description":"The name of the tool\u0027s category."},"serialNumber":{"type":"string","description":"The serial number of the tool."},"inventoryNumber":{"type":"string","description":"The inventory number of the tool."},"externalId":{"type":"string","description":"The external ID of the tool."},"status":{"type":"string","description":"The status of the tool."},"manufacturer":{"type":"string","description":"The name of the manufacturer of the tool."},"vehicleId":{"type":"string","description":"The id of the assigned locating device if it is a vehicle."},"beaconId":{"type":"string","description":"The id of the assigned locating device if it is a beacon."},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentProjectChangedAt":{"description":"The time of the last project change.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"createdAt":{"description":"The date the tool was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"licenseNumber":{"type":"string","description":"The license plate of the tool."}}},"MaintenanceLogFetchRequestMaintenanceLogFilter":{"type":"object","description":"","properties":{"byTrackerIds":{"type":"array","items":{"type":"integer"},"description":"Filters the maintenance logs based on the tracker ids."},"byToolIds":{"type":"array","items":{"type":"integer"},"description":"Filters the maintenance logs based on the tool ids."},"byMaintenanceTypeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the maintenance logs based on the maintenance type ids."}}},"StandardMaintenanceLogFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The maintenance log filter","type":"object","$ref":"#\/components\/schemas\/MaintenanceLogFetchRequestMaintenanceLogFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardMaintenanceLogUpsertResponse":{"type":"object","description":"","properties":{"createdMaintenanceLogs":{"description":"The created maintenances.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceLogUpsertResponseMaintenanceLogItem"},{"description":""}]}},"updatedMaintenanceLogs":{"description":"The changed maintenances.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceLogUpsertResponseMaintenanceLogItem"},{"description":""}]}},"deletedMaintenanceLogs":{"description":"The deleted maintenances.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceLogUpsertResponseMaintenanceLogItem"},{"description":""}]}}}},"MaintenanceLogUpsertResponseMaintenanceLogItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the maintenance log."},"description":{"type":"string","description":"The description of the maintenance log."},"type":{"type":"string","description":"The maintenance type."},"tracker":{"description":"The vehicle the maintenance log is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardMaintenanceBaseTrackerItem"},"tool":{"description":"The tool the maintenance log is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseToolListItem"},"date":{"description":"The mainteance date.","type":"object","$ref":"#\/components\/schemas\/Date"},"employee":{"type":"string","description":"The name of the employee."},"duration":{"type":"integer","description":"The duration of the maintenance in seconds."},"materialCost":{"type":"number","description":"The material costs of the maintenance."},"serviceCost":{"type":"number","description":"The service costs of the maintenance."},"invoiceNumber":{"type":"string","description":"The invoice number for the maintenance."},"invoiceFileData":{"type":"string","description":"The data of the invoice file (base64 encoded)"},"company":{"type":"string","description":"The company that carried out the maintenance."},"note":{"type":"string","description":"Additional notes."}}},"MaintenanceLogUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifier the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value | Description          |\n|-------|----------------------|\n| id    | The internal maintenance log id |"},"data":{"description":"The maintenance record.\n\nFor updates only the updated fields need to be specified.","type":"object","$ref":"#\/components\/schemas\/MaintenanceLogUpsertRequestRecordData"}}},"MaintenanceLogUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the maintenance log."},"description":{"type":"string","description":"The description of the maintenance log. This value is required. (max. 255 characters)"},"maintenanceId":{"type":"integer","description":"The internal id of the maintenance to create the log for. This value is required."},"date":{"description":"The mainteance date. This value is required.","type":"object","$ref":"#\/components\/schemas\/Date"},"employee":{"type":"string","description":"The name of the employee. (max. 60 characters)"},"duration":{"type":"integer","description":"The duration of the maintenance in seconds."},"materialCost":{"type":"number","description":"The material costs of the maintenance."},"serviceCost":{"type":"number","description":"The service costs of the maintenance."},"invoiceNumber":{"type":"string","description":"The invoice number for the maintenance. (max. 50 characters)"},"invoiceFileData":{"type":"string","description":"The data of the invoice file that is connected to the maintenance (base64 encoded)."},"company":{"type":"string","description":"The company that carried out the maintenance. (max. 60 characters)"},"note":{"type":"string","description":"Additional notes."}}},"StandardMaintenanceLogUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceLogUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardProjectFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectFetchResponseProjectItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skiped records."},"totalCount":{"type":"integer","description":"Total number of available projects.\n(Only calculated if offset is 0)"}}},"ProjectFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"},"orderReference":{"type":"string","description":"The order reference. (max. 255 characters)"},"offerReference":{"type":"string","description":"The offer reference. (max. 255 characters)"},"contactPerson":{"type":"string","description":"Contact person. (max. 255 characters)"},"phoneNumber":{"type":"string","description":"Telephone number. (max. 255 characters)"},"mobileNumber":{"type":"string","description":"Mobile number. (max. 255 characters)"},"email":{"type":"string","description":"Email. (max. 255 characters)"},"validFrom":{"description":"Valid from.","type":"object","$ref":"#\/components\/schemas\/Date"},"validTo":{"description":"Valid to.","type":"object","$ref":"#\/components\/schemas\/Date"},"resourcePlanningFrom":{"description":"Ressource planning start date. (Only if the feature ressource planning is enabled)","type":"object","$ref":"#\/components\/schemas\/Date"},"resourcePlanningTo":{"description":"Ressource planning end date. (Only if the feature ressource planning is enabled)","type":"object","$ref":"#\/components\/schemas\/Date"},"projectLeader":{"description":"Project Leader","type":"object","$ref":"#\/components\/schemas\/ApiHelperResponseProjectLeaderReference"},"category":{"description":"The category.","type":"object","$ref":"#\/components\/schemas\/StandardProjectCategoryBaseProjectCategoryListItem"},"fenceBounds":{"description":"The rough project fence.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"},"fences":{"description":"The project fences.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectFetchResponseProjectFence"},{"description":""}]}},"fenceType":{"type":"string","description":"(Deprecated, use fences instead)\nProject fence type.\n\n| Value          | Description         |\n|---------------|---------------------|\n| RADIUS        | Radius             |\n| POLYGON       | Polygon             |","deprecated":true},"fenceRadius":{"type":"integer","description":"(Deprecated, use fences instead)\nProject fence as radius. (In meters)","deprecated":true},"fencePolygon":{"description":"(Deprecated, use fences instead)\nProject fence as polygon.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},{"description":""}]},"deprecated":true},"approvalRuleId":{"type":"integer","description":""},"openingHours":{"description":"Example: {\u0022MO\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]]}","type":"object","$ref":"#\/components\/schemas\/DynamicWeekdayTime"}}},"ApiHelperResponseProjectLeaderReference":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal Project Leader ID. (EmployeeId or UserId)"},"type":{"type":"string","description":"The internal Project Leader type.\n\n | Value | Description |\n | ----- | ----------- |\n | E | Project Leader type Employee |\n | U | Project Leader type User |"}}},"StandardProjectCategoryBaseProjectCategoryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the project category."},"description":{"type":"string","description":"The description of the project category."},"externalId":{"type":"string","description":"The external ID of the project category."},"createdAt":{"description":"Date when the project category was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"ProjectFetchResponseProjectFence":{"type":"object","description":"","properties":{"type":{"type":"string","description":"Fence type.\n\n| Value         | Description         |\n|---------------|---------------------|\n| CIRCLE        | Circle              |\n| POLYGON       | Polygon             |"},"bounds":{"description":"The rough fence boundary.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"},"circleCenter":{"description":"Circle center.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"circleRadius":{"type":"integer","description":"Circle radius in meters."},"polygonCoordinates":{"description":"Polygon coordinates.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},{"description":""}]}}}},"ProjectFetchRequestProjectFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters based on the internal project IDs"},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters based on the project numbers."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters based on the external project IDs."},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external project ID is filtered."},"byEmployeeActivities":{"description":"Filters projects on which employee hours have been incurred.","type":"object","$ref":"#\/components\/schemas\/ProjectFetchRequestActivityFilter"},"byTrackerWorkActivities":{"description":"Filters projects on which operating hours have been incurred.","type":"object","$ref":"#\/components\/schemas\/ProjectFetchRequestActivityFilter"},"byProjectCategoryIds":{"type":"array","items":{"type":"integer"},"description":"Filters projects based on the category ids."}}},"ProjectFetchRequestActivityFilter":{"type":"object","description":"","properties":{"from":{"description":"Start date. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"End date.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardProjectFetchRequest":{"type":"object","description":"","properties":{"projects":{"description":"The project filter. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/ProjectFetchRequestProjectFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records. This Parameter is optional."}}},"StandardProjectUpsertResponse":{"type":"object","description":"","properties":{"createdProjects":{"description":"The created projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectUpsertResponseProjectItem"},{"description":""}]}},"updatedProjects":{"description":"The changed projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectUpsertResponseProjectItem"},{"description":""}]}},"deletedProjects":{"description":"The deleted projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectUpsertResponseProjectItem"},{"description":""}]}}}},"ProjectUpsertResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."}}},"ProjectUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                 |\n|----------------|-----------------------------|\n| id             | The internal project ID     |\n| reference      | The project number             |\n| importKey      | The external record ID    |"},"data":{"description":"The project record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/ProjectUpsertRequestRecordData"}}},"ProjectUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"},"orderReference":{"type":"string","description":"The order reference. (max. 255 characters)"},"offerReference":{"type":"string","description":"The offer reference. (max. 255 characters)"},"contactPerson":{"type":"string","description":"Contact person. (max. 255 characters)"},"phoneNumber":{"type":"string","description":"Telephone number. (max. 255 characters)"},"mobileNumber":{"type":"string","description":"Mobile number. (max. 255 characters)"},"email":{"type":"string","description":"Email. (max. 255 characters)"},"validFrom":{"description":"Valid from.","type":"object","$ref":"#\/components\/schemas\/Date"},"validTo":{"description":"Valid to.","type":"object","$ref":"#\/components\/schemas\/Date"},"resourcePlanningFrom":{"description":"Ressource planning start date. (Only if the feature ressource planning is enabled)","type":"object","$ref":"#\/components\/schemas\/Date"},"resourcePlanningTo":{"description":"Ressource planning end date. (Only if the feature ressource planning is enabled)","type":"object","$ref":"#\/components\/schemas\/Date"},"projectLeader":{"description":"Project Leader","type":"object","$ref":"#\/components\/schemas\/ApiHelperResponseProjectLeaderReference"},"openingHours":{"description":"Example: {\u0022MO\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]]}","type":"object","$ref":"#\/components\/schemas\/DynamicWeekdayTime"},"approvalRuleId":{"type":"integer","description":""},"categoryExternalId":{"type":"string","description":"The external ID of the projectCategory."},"radius":{"type":"integer","description":"The project radius in meters."},"distanceToOffice":{"type":"integer","description":"The distance from the project to the office (in m)."},"workSalaryTypeId":{"type":"integer","description":"A project-specific wage type. For time entries on this project, the selected wage type will be used. Note: This wage type overrides other wage type settings (e.g. from app settings or department assignment)."},"allowance":{"type":"number","description":"A project-specific allowance."}}},"StandardProjectUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all projects missing from this request? This Parameter is optional. (Default: false)"},"deleteImportSource":{"type":"string","description":"The data source from which the missing projects can be deleted. This Parameter is optional.\n(Default: \u0022*API\u0022)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardProjectDeleteResponse":{"type":"object","description":"","properties":{"deletedProjects":{"description":"The deleted projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectDeleteResponseProjectItem"},{"description":""}]}}}},"ProjectDeleteResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."}}},"ProjectDeleteRequestProjectFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters based on the internal project IDs"},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters based on the project numbers."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters based on the external project IDs."},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external project ID is filtered."}}},"StandardProjectDeleteRequest":{"type":"object","description":"","properties":{"projects":{"description":"The project filter. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/ProjectDeleteRequestProjectFilter"},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardProjectApplyGeofenceResponse":{"type":"object","description":"","properties":{"appliedProjects":{"description":"The projects where the geofences were applied.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectApplyGeofenceResponseProjectItem"},{"description":""}]}}}},"ProjectApplyGeofenceResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"numStamps":{"type":"integer","description":"The number of changed stamps."},"numEvents":{"type":"integer","description":"The number of changed events."},"numBeacons":{"type":"integer","description":"The number of changed beacons."}}},"ProjectApplyGeofenceRequestProjectFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters based on the internal project IDs"},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters based on the project numbers."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters based on the external project IDs."},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external project ID is filtered."},"from":{"type":"string","description":"The date from which the geofences should be applied"}}},"StandardProjectApplyGeofenceRequest":{"type":"object","description":"","properties":{"projectFilter":{"description":"The project filter.","type":"object","$ref":"#\/components\/schemas\/ProjectApplyGeofenceRequestProjectFilter"}}},"StandardEventFetchResponse":{"type":"object","description":"","properties":{"trackers":{"description":"The vehicles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EventFetchResponseTrackerItem"},{"description":""}]}},"employees":{"description":"The referenced employees.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EventFetchResponseEmployeeItem"},{"description":""}]}},"projects":{"description":"The referenced projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EventFetchResponseProjectItem"},{"description":""}]}},"totalCount":{"type":"integer","description":"Total number of events.\n(Only calculated if offset is 0)"}}},"EventFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"driverName":{"type":"string","description":"The driver\u0027s name."},"events":{"description":"The events.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EventFetchResponseEventItem"},{"description":""}]}},"costCenter":{"type":"string","description":"The cost center."}}},"EventFetchResponseEventItem":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The event type\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| MOVE                     | Move                                 |\n| STOP                     | Stop                                 |\n| STAMP                    | Stamp                                |\n| IGNITION                 | Ignition                             |\n| SENSOR                   | Sensor                               |"},"sensorValueTypeName":{"type":"string","description":"The event value type name."},"startTime":{"description":"The timestamp at the event start.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"startLatLng":{"description":"The geo coordinates of the vehicle at the event start.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"startProjectId":{"type":"integer","description":"The project the vehicle was located at the event start."},"endTime":{"description":"The timestamp at the event end.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endLatLng":{"description":"The geo coordinates of the vehicle at the event end.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"endProjectId":{"type":"integer","description":"The project the vehicle was located at the event start."},"distance":{"type":"integer","description":"The driven distance in meters."},"employeeId":{"type":"integer","description":"For MOVE events the driver. For STAMP events the employee."},"beaconIds":{"type":"integer","description":"The beacon\u0027s IDs of the event."}}},"EventFetchResponseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."}}},"EventFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"}}},"EventFetchRequestTrackerFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the vehicles based on the IDs."},"byLicenseNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the license plates."},"byIdentifiers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the customer-specific IDs."},"byIdentificationNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the VINs."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the external vehicle IDs."},"byProjectChangedAfter":{"description":"Filter the vehicles which projectChangedAt is after the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered."},"byName":{"type":"string","description":"Filter the vehicles on their name."},"byDriver":{"type":"string","description":"Filter the vehicles on their driver."},"byEmployees":{"description":"Filters the vehicles by employees who clocked in at or driven the vehicle.","type":"object","$ref":"#\/components\/schemas\/EventFetchRequestEmployeeFilter"}}},"EventFetchRequestEmployeeFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the employee based on the IDs."},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the personal numbers."},"byCardNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the driver card numbers."},"byIbuttonNumbers":{"type":"array","items":{"type":"integer"},"description":"Filters the employees based on the iButton numbers."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the employee import IDs."},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered."}}},"StandardEventFetchRequest":{"type":"object","description":"","properties":{"eventTypes":{"type":"array","items":{"type":"string"},"description":"Filter for event type. This paramter is optional.\n\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| MOVE                     | Move                                |\n| STOP                     | Stop                                 |\n| STAMP                    | Stamp                           |\n| IGNITION                 | Ignition                              |\n| SENSOR                   | Sensor                              |"},"sensorValueTypeName":{"type":"string","description":"Filter for sensor value type name. This paramter is optional."},"trackers":{"description":"Filter for vehicles. This paramter is optional.","type":"object","$ref":"#\/components\/schemas\/EventFetchRequestTrackerFilter"},"employees":{"description":"Filter for employees. This paramter is optional.","type":"object","$ref":"#\/components\/schemas\/EventFetchRequestEmployeeFilter"},"offset":{"type":"integer","description":"Number of events to be skipped. This paramter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."},"from":{"description":"Filter for events from this time on. This paramter is optional.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filter for events till this time. This paramter is optional.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"date":{"description":"Filter for events on this day.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardWebhookApplicationFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The applications.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookApplicationBaseWebhookApplicationItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of records."}}},"StandardWebhookApplicationBaseWebhookApplicationItem":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the application."},"name":{"type":"string","description":"The name of the application."},"externalId":{"type":"string","description":"The external id of the application."},"description":{"type":"string","description":"The description of the application."},"active":{"type":"boolean","description":"Is the application active?"},"baseUrl":{"type":"string","description":"The base url of the application."}}},"WebhookApplicationFetchRequestWebhookApplicationFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the internal IDs."},"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the external IDs."}}},"StandardWebhookApplicationFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The filter. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/WebhookApplicationFetchRequestWebhookApplicationFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records. This Parameter is optional."}}},"StandardWebhookApplicationUpsertResponse":{"type":"object","description":"","properties":{"createdApplications":{"description":"The created applications.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookApplicationBaseWebhookApplicationItem"},{"description":""}]}},"updatedApplications":{"description":"The updated applications.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookApplicationBaseWebhookApplicationItem"},{"description":""}]}}}},"WebhookApplicationUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                       |\n|----------------|------------------------------------|\n| id             | The internal application ID        |\n| externalid     | The external application ID        |"},"data":{"description":"The application record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/WebhookApplicationUpsertRequestRecordData"}}},"WebhookApplicationUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the application."},"externalId":{"type":"string","description":"The external id of the application. (max. 255 characters)"},"name":{"type":"string","description":"The name of the application. (max. 255 characters)"},"description":{"type":"string","description":"The description of the application."},"active":{"type":"boolean","description":"The active flag."},"baseUrl":{"type":"string","description":"The base url of the application. (max. 255 characters)"}}},"StandardWebhookApplicationUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WebhookApplicationUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardProjectAssignmentFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The project assignments.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectAssignmentListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available project assignments."}}},"StandardProjectAssignmentBaseProjectAssignmentListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The id of the project assignment"},"type":{"type":"string","description":"| Value           | Description                |\n|----------------|-----------------------------|\n| RELEASE             | The given vehicle\/tool is assigned to no current project (released) |\n| FIXED_ASSIGNMENT    | The given vehicle\/tool is assigned to a fixed project |"},"assignedProject":{"description":"The assigned project if this is a fixed assignment.","type":"object","$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectItem"},"tracker":{"description":"The vehicle that is assigned.","type":"object","$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseTrackerItem"},"tool":{"description":"The tool that is assigned.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseToolItem"},"from":{"description":"The start date for the assignment.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"The end date for this assignment.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardProjectAssignmentBaseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."}}},"StandardProjectAssignmentBaseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"}}},"StandardToolBaseToolItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool."},"name":{"type":"string","description":"The name of the tool."},"category":{"type":"string","description":"The name of the tool\u0027s category."},"serialNumber":{"type":"string","description":"The serial number of the tool."},"inventoryNumber":{"type":"string","description":"The inventory number of the tool."},"externalId":{"type":"string","description":"The external ID of the tool."},"status":{"type":"string","description":"The status of the tool."},"manufacturer":{"type":"string","description":"The name of the manufacturer of the tool."},"vehicleId":{"type":"string","description":"The id of the assigned locating device if it is a vehicle."},"beaconId":{"type":"string","description":"The id of the assigned locating device if it is a beacon."},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentProjectChangedAt":{"description":"The time of the last project change.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"createdAt":{"description":"The date the tool was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"licenseNumber":{"type":"string","description":"The license plate of the tool."},"description":{"type":"string","description":"The description of the tool."},"costCenter":{"type":"string","description":"The Cost Center of the tracker."},"beacon":{"description":"The beacon assigned to the tool.","type":"object","$ref":"#\/components\/schemas\/ToolUpsertResponseToolBeaconItem"},"tracker":{"description":"The tracker assigned to the tool.","type":"object","$ref":"#\/components\/schemas\/ToolUpsertResponseToolTrackerItem"},"synchronizeBeacon":{"type":"boolean","description":"Indicates that the beacon mirrors the device\u2019s metadata. The name, photo, description, and serial number are kept synchronized from the device to the beacon.\nWhenever any of these fields on the device changes, the beacon is automatically updated accordingly."}}},"StandardProjectAssignmentBaseProjectAssignmentFilter":{"type":"object","description":"","properties":{"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the project assignments based on the given project IDs."},"byTrackerIds":{"type":"array","items":{"type":"integer"},"description":"Filters the project assignments based on the given vehicle IDs."},"byToolIds":{"type":"array","items":{"type":"integer"},"description":"Filters the project assignments based on the given tool IDs."},"byToolExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters the project assignments based on the given tool external IDs."},"fromDate":{"description":"Filters the project assignments based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"toDate":{"description":"Filters the project assignments based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardProjectAssignmentFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The project assignment filter.","type":"object","$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectAssignmentFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional."}}},"StandardProjectAssignmentUpsertResponse":{"type":"object","description":"","properties":{"createdProjectAssignments":{"description":"The created project assignments.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectAssignmentListItem"},{"description":""}]}},"updatedProjectAssignments":{"description":"The changed project assignments.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectAssignmentListItem"},{"description":""}]}},"deletedProjectAssignments":{"description":"The deleted project assignments.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectAssignmentListItem"},{"description":""}]}}}},"ProjectAssignmentUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal project assignment ID        |"},"data":{"description":"The project assignment record.\n\n For updates, only the updated fields need to be specified.\n\n The primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/ProjectAssignmentUpsertRequestRecordData"}}},"ProjectAssignmentUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the project assignment."},"trackerId":{"type":"integer","description":"The id for the vehicle that is assigned."},"toolId":{"type":"integer","description":"The id for the tool that is assigned."},"type":{"type":"string","description":"The assignment type\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| RELEASE             | The given vehicle\/tool is assigned to no current project (released) |\n| FIXED_ASSIGNMENT    | The given vehicle\/tool is assigned to a fixed project |"},"assignedProjectId":{"type":"integer","description":"The internal id of the assigned project. Only relevant if type is FIXED_ASSIGNMENT."},"fromDate":{"description":"The start date for the assignment.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"toDate":{"description":"The end date for the assignment. (Optional)","type":"object","$ref":"#\/components\/schemas\/DateTime"},"note":{"type":"string","description":"A note for the project assignment."}}},"StandardProjectAssignmentUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectAssignmentUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardProjectAssignmentDeleteResponse":{"type":"object","description":"","properties":{"deletedProjectsAssignments":{"description":"The deleted project assignments.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectAssignmentListItem"},{"description":""}]}}}},"StandardProjectAssignmentDeleteRequest":{"type":"object","description":"","properties":{"filter":{"description":"The project assignment filter.","type":"object","$ref":"#\/components\/schemas\/StandardProjectAssignmentBaseProjectAssignmentFilter"},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardTestPushArrayResponse":{"type":"object","description":"","properties":{"message":{"type":"string","description":""},"linesGiven":{"type":"array","items":{"type":"string"},"description":""}}},"StandardTestPushArrayRequest":{"type":"object","description":"","properties":{"lines":{"type":"array","items":{"type":"string"},"description":""}}},"StandardTestPushDictResponse":{"type":"object","description":"","properties":{"message":{"type":"string","description":""},"tableGiven":{"type":"string","description":""}}},"string[string]":{"type":"array","items":{"type":"string"}},"StandardTestPushDictRequest":{"type":"object","description":"","properties":{"table":{"type":"string","description":""}}},"StandardTrackerCounterFetchResponse":{"type":"object","description":"","properties":{"trackers":{"description":"The vehicles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerCounterFetchResponseTrackerItem"},{"description":""}]}},"counters":{"description":"The counters.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerCounterFetchResponseTrackerCounterItem"},{"description":""}]}}}},"TrackerCounterFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"sensors":{"description":"Relevant sensors.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerCounterFetchResponseTrackerSensorItem"},{"description":""}]}}}},"TrackerCounterFetchResponseTrackerSensorItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal sensor ID."},"name":{"type":"string","description":"The sensor name."},"type":{"type":"string","description":"The sensor type.\n\n| Value                     |  Description                               |\n| ------------------------ | ------------------------------------------- |\n| ALTITUDE                 | Height                                      |\n| SPEED                    | Speed                                       |\n| DIRECTION                | Direction                                   |\n| GPS_SIGNAL_QUALITY       | GPS signal strength (Number of satellites)  |\n| GSM_SIGNAL_QUALITY       | GSM signal strength                         |\n| POWER_SUPPLY_VOLTAGE     | Voltage                                     |\n| EMPLOYEE                 | Employee                                    |\n| PIECE                    | Piece                                       |\n| SECOND                   | Second                                      |\n| MINUTE                   | Minute                                      |\n| DEGREE                   | Degree                                      |\n| MILLIVOLT                | Millivolt                                   |\n| METER                    | Meter                                       |\n| METER_PER_SEC2           | Meter\/s\u00b2                                    |\n| KILOMETER                | Kilometer                                   |\n| KILOMETER_PER_HOUR       | Kilometer\/h                                 |\n| LITER                    | Liter                                       |\n| LITER_PER_100KM          | Liter\/100 km                                |\n| VOLT                     | Volt                                        |\n| AMPERE                   | Ampere                                      |\n| MILLIAMPERE              | Milliampere                                 |\n| PERCENT                  | Percent                                     |\n| DEGREE_CELSIUS           | Degrees Celsius (\u00b0C)                        |\n| BOOLEAN                  | On\/Off                                      |\n| ID                       | ID                                          |\n| NUMBER                   | Number                                      |\n| METER2                   | Meter\u00b2                                      |\n| HECTARE                  | Hectar                                      |"}}},"TrackerCounterFetchResponseTrackerCounterItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal counter ID."},"trackerId":{"type":"integer","description":"The internal vehicle ID."},"sensorId":{"type":"integer","description":"The internal sensor ID."},"name":{"type":"string","description":"The counter name."},"type":{"type":"string","description":"The counter type.\n\n| Value            | Description              |\n|------------------|--------------------------|\n| KILOMETER        | Kilometers               |\n| OPERATING_HOURS  | operating hours          |\n| SENSOR           | Sensor                   |"},"mode":{"type":"string","description":"The counter mode.\n\n| Value            | Description               |\n|------------------|---------------------------|\n| DISTANCE         | Distance                  |\n| DURATION         | Duration                  |\n| OCCURRENCE       | Occurances                |\n| AREA             | Area                      |\n| VALUE            | value                     |"},"unitType":{"type":"string","description":"The counter unit."},"counterValue":{"type":"number","description":"The counter value."},"counterDate":{"description":"The date of the counter reading.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"TrackerCounterFetchRequestTrackerFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the vehicles based on the IDs."},"byLicenseNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the license plates."},"byIdentifiers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the customer-specific IDs."},"byIdentificationNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the VINs."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the external vehicle IDs."},"byProjectChangedAfter":{"description":"Filter the vehicles which projectChangedAt is after the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered."},"byName":{"type":"string","description":"Filter the vehicles on their name."},"byDriver":{"type":"string","description":"Filter the vehicles on their driver."}}},"StandardTrackerCounterFetchRequest":{"type":"object","description":"","properties":{"trackers":{"description":"Filter for vehicles.","type":"object","$ref":"#\/components\/schemas\/TrackerCounterFetchRequestTrackerFilter"},"date":{"description":"Request the counter reading of the respective date.\n\nIf no date is given, the current reading will be requested.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardWageGroupFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The wage groups.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WageGroupFetchResponseWageGroupListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available wage groups."}}},"WageGroupFetchResponseWageGroupListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the wage group."},"name":{"type":"string","description":"The name of the wage group."},"externalId":{"type":"string","description":"The external id of the wage group."},"createdAt":{"description":"Date when the wage group was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"WageGroupFetchRequestWageGroupFilter":{"type":"object","description":"","properties":{"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters the wage groups based on the externalIds."}}},"StandardWageGroupFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The wage group filter.","type":"object","$ref":"#\/components\/schemas\/WageGroupFetchRequestWageGroupFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardWageGroupUpsertResponse":{"type":"object","description":"","properties":{"createdWageGroups":{"description":"The created wage groups.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WageGroupUpsertResponseWageGroupItem"},{"description":""}]}},"updatedWageGroups":{"description":"The changed wage groups.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WageGroupUpsertResponseWageGroupItem"},{"description":""}]}}}},"WageGroupUpsertResponseWageGroupItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the wage group."},"name":{"type":"string","description":"The name of the wage group."},"externalId":{"type":"string","description":"The external id of the wage group."},"createdAt":{"description":"Date when the wage group was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"WageGroupUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal wage group ID        |\n| externalid     | The external ID of the wage group |"},"data":{"description":"The wage group record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/WageGroupUpsertRequestRecordData"}}},"WageGroupUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the wage group."},"name":{"type":"string","description":"The name of the wage group. (max. 255 characters)"},"externalId":{"type":"string","description":"The external ID of the wage group. (max. 128 characters)"}}},"StandardWageGroupUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WageGroupUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardDepartmentFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The departments.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DepartmentFetchResponseDepartmentItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available departments.\n(Only calculated if offset is 0)"}}},"DepartmentFetchResponseDepartmentItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the department."},"name":{"type":"string","description":"The name of the department."},"parent":{"type":"string","description":"The name of the departments parent."}}},"StandardDepartmentFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardDepartmentUpsertResponse":{"type":"object","description":"","properties":{"createdDepartment":{"description":"The created department.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDepartmentBaseDepartmentListItem"},{"description":""}]}},"updatedDepartment":{"description":"The changed department.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDepartmentBaseDepartmentListItem"},{"description":""}]}},"deletedDepartment":{"description":"The deleted department.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDepartmentBaseDepartmentListItem"},{"description":""}]}}}},"StandardDepartmentBaseDepartmentListItem":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the department."},"name":{"type":"string","description":"The name of the department. (max. 255 characters)"},"identifier":{"type":"string","description":"The internal id of the department. This Parameter is optional. (max. 255 characters)"},"locationId":{"type":"string","description":"The location id of the department. This Parameter is optional."},"timeSchemeId":{"type":"string","description":"The time scheme id of the department. This Parameter is optional."},"costCenter":{"type":"string","description":"The cost Center of the department. This Parameter is optional. (max. 255 characters)"},"headId":{"type":"string","description":"The head id of the department. This Parameter is optional."},"resourcePlanning":{"type":"boolean","description":"Department is included in resource planning. This Parameter is optional. (Default: false)"},"ignoreProjectWorktimeApprovalRule":{"type":"boolean","description":"Department ignore project worktime approval rules. This Parameter is optional. (Default: false)"},"sequence":{"type":"integer","description":"The sequence of the department. This Parameter is optional. (Default: 0)"},"driveSalaryTypeId":{"type":"string","description":"The drive salary type id of the department. This Parameter is optional."},"workSalaryTypeId":{"type":"string","description":"The work salary type id of the department. This Parameter is optional."},"worktimeApprovalRuleId":{"type":"string","description":"The worktime approval rule id of the department. This Parameter is optional."},"stampApplicationApprovalRuleId":{"type":"string","description":"The stamp approval rule id of the department. This Parameter is optional."},"absenceApplicationApprovalRuleId":{"type":"string","description":"The absence approvale rule id of the department. This Parameter is optional."},"sicknessApplicationApprovalRuleId":{"type":"string","description":"The sickness approval rule id of the department. This Parameter is optional."},"accountingEntryApplicationApprovalRuleId":{"type":"string","description":"The accounting entry approval rule id of the department. This Parameter is optional."},"allowedProjectCategoriesIds":{"type":"array","items":{"type":"integer"},"description":"The allowed project category ids of the department. This Parameter is optional."}}},"DepartmentUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value          | Description                       |\n|----------------|-----------------------------------|\n| id             | The internal department id        |\n| externalid     | The external ID of the department |"},"data":{"description":"The department record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/DepartmentUpsertRequestRecordData"}}},"DepartmentUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the department."},"name":{"type":"string","description":"The name of the department. (max. 255 characters)"},"identifier":{"type":"string","description":"The internal id of the department. This Parameter is optional. (max. 255 characters)"},"locationId":{"type":"string","description":"The location id of the department. This Parameter is optional."},"timeSchemeId":{"type":"string","description":"The time scheme id of the department. This Parameter is optional."},"costCenter":{"type":"string","description":"The cost Center of the department. This Parameter is optional. (max. 255 characters)"},"headId":{"type":"string","description":"The head id of the department. This Parameter is optional."},"resourcePlanning":{"type":"boolean","description":"Department is included in resource planning. This Parameter is optional. (Default: false)"},"ignoreProjectWorktimeApprovalRule":{"type":"boolean","description":"Department ignore project worktime approval rules. This Parameter is optional. (Default: false)"},"sequence":{"type":"integer","description":"The sequence of the department. This Parameter is optional. (Default: 0)"},"driveSalaryTypeId":{"type":"string","description":"The drive salary type id of the department. This Parameter is optional."},"workSalaryTypeId":{"type":"string","description":"The work salary type id of the department. This Parameter is optional."},"worktimeApprovalRuleId":{"type":"string","description":"The worktime approval rule id of the department. This Parameter is optional."},"stampApplicationApprovalRuleId":{"type":"string","description":"The stamp approval rule id of the department. This Parameter is optional."},"absenceApplicationApprovalRuleId":{"type":"string","description":"The absence approvale rule id of the department. This Parameter is optional."},"sicknessApplicationApprovalRuleId":{"type":"string","description":"The sickness approval rule id of the department. This Parameter is optional."},"accountingEntryApplicationApprovalRuleId":{"type":"string","description":"The accounting entry approval rule id of the department. This Parameter is optional."},"allowedProjectCategoriesIds":{"type":"array","items":{"type":"integer"},"description":"The allowed project category ids of the department. This Parameter is optional."}}},"StandardDepartmentUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DepartmentUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all departments missing from this request? This Parameter is optional. (Default: false)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardBillOfQuantitiesFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The list of bills of quantities.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BillOfQuantitiesFetchResponseBillOfQuantitiesListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipepd records."},"totalCount":{"type":"integer","description":"Total number of available bills of quantities.\n(Only calculated if offset is 0)"}}},"BillOfQuantitiesFetchResponseBillOfQuantitiesListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the bill of quantities."},"externalId":{"type":"string","description":"The external id."},"offerNumber":{"type":"string","description":"The offer number."},"addendum":{"type":"string","description":"The number of the addendum of this bill of quantities."},"text1":{"type":"string","description":"The name."},"date":{"description":"The date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"totalValue":{"type":"number","description":"The total Value."},"currency":{"type":"string","description":"The currency."}}},"BillOfQuantitiesFetchRequestBillOfQuantitiesFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the bills of quantities based on the internal IDs."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the bills of quantities based on the import keys."},"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters the bills of quantities based on the externalIds."},"from":{"description":"Filters the bill of quantities based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the bill of quantities based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardBillOfQuantitiesFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The bill of quantities filter.","type":"object","$ref":"#\/components\/schemas\/BillOfQuantitiesFetchRequestBillOfQuantitiesFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardBillOfQuantitiesFetchDataResponse":{"type":"object","description":"","properties":{"data":{"description":"The bill of quantities details.","type":"object","$ref":"#\/components\/schemas\/BillOfQuantitiesFetchDataResponseBillOfQuantitiesItem"}}},"BillOfQuantitiesFetchDataResponseBillOfQuantitiesItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the bill of quantities."},"externalId":{"type":"string","description":"The external id. (max. 255 characters)"},"offerNumber":{"type":"string","description":"The offer number. (max. 30 characters)"},"addendum":{"type":"string","description":"The number of the addendum of this bill of quantities. (max. 10 characters)"},"text1":{"type":"string","description":"The name. (max. 80 characters)"},"text2":{"type":"string","description":"The additional name. (max. 80 characters)"},"noteStart":{"type":"string","description":"An additional note at the beginning."},"noteEnd":{"type":"string","description":"An additional note at the end."},"date":{"description":"The date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"totalValue":{"type":"number","description":"The total Value."},"currency":{"type":"string","description":"The currency."},"projectName":{"type":"string","description":"The name of the project. (max. 100 characters)"},"importSource":{"type":"string","description":"External data source from which this bill of quantities originates. (max. 50 characters)"},"importKey":{"type":"string","description":"External ID of the respective data source. (max. 50 characters)"},"sections":{"description":"The sections of the bill of quantities.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BillOfQuantitiesFetchDataResponseBillOfQuantitiesSectionItem"},{"description":""}]}},"positions":{"description":"The positions of the bill of quantities.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BillOfQuantitiesFetchDataResponseBillOfQuantitiesPositionItem"},{"description":""}]}}}},"BillOfQuantitiesFetchDataResponseBillOfQuantitiesSectionItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id."},"position":{"type":"string","description":"The position in the bill of quantities."},"name":{"type":"string","description":"The name."},"description":{"type":"string","description":"The description."},"note":{"type":"string","description":"An additional note."},"price":{"type":"number","description":"The total price of the position under this section."}}},"BillOfQuantitiesFetchDataResponseBillOfQuantitiesPositionItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id."},"status":{"type":"string","description":"The status."},"position":{"type":"string","description":"The position in the bill of quantities."},"amount":{"type":"integer","description":"The amount."},"unit":{"type":"string","description":"The unit."},"name":{"type":"string","description":"The name."},"description":{"type":"string","description":"The description."},"note":{"type":"string","description":"An additional note."},"unitPrice":{"type":"number","description":"The unit price."},"price":{"type":"number","description":"The total price."},"uniformPrice":{"type":"boolean","description":"If this position has a uniform price."}}},"StandardBillOfQuantitiesFetchDataRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the bill of quantities. This Parameter is required."}}},"StandardBillOfQuantitiesImportResponse":{"type":"object","description":"","properties":{"jobId":{"type":"integer","description":"The id of the import job. (The status of the job can be queried via the job API)"}}},"StandardBillOfQuantitiesImportRequest":{"type":"object","description":"","properties":{"file":{"type":"string","description":"The file to import (base64 encoded). This Parameter is required."},"format":{"type":"string","description":"The format of the file to import. This Parameter is required.\n\n| Value          |\n|----------------|\n| XML            |\n| GAEB2000       |\n| GAEB90         |"},"externalId":{"type":"string","description":"The external id for the bill of quantities."},"offerNumber":{"type":"string","description":"The offer number for the bill of quantities"}}},"StandardBillOfQuantitiesUpdateResponse":{"type":"object","description":"","properties":{"updatedBillsOfQuantities":{"description":"The updated bill of quantities.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BillOfQuantitiesUpdateResponseBillOfQuantitiesItem"},{"description":""}]}}}},"BillOfQuantitiesUpdateResponseBillOfQuantitiesItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the bill of quantities."},"externalId":{"type":"string","description":"The external id. (max. 255 characters)"},"offerNumber":{"type":"string","description":"The offer number. (max. 30 characters)"},"addendum":{"type":"string","description":"The number of the addendum of this bill of quantities. (max. 10 characters)"},"text1":{"type":"string","description":"The name. (max. 80 characters)"},"text2":{"type":"string","description":"The additional name. (max. 80 characters)"},"noteStart":{"type":"string","description":"An additional note at the beginning."},"noteEnd":{"type":"string","description":"An additional note at the end."},"date":{"description":"The date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"totalValue":{"type":"number","description":"The total Value."},"currency":{"type":"string","description":"The currency."},"projectName":{"type":"string","description":"The name of the project. (max. 100 characters)"},"importSource":{"type":"string","description":"External data source from which this bill of quantities originates. (max. 50 characters)"},"importKey":{"type":"string","description":"External ID of the respective data source. (max. 50 characters)"}}},"BillOfQuantitiesUpdateRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value          | Description                          |\n|----------------|------------------------------------ |\n| id             | The internal bill of quantities ID  |\n| importKey      | The external record ID              |"},"data":{"description":"The bill of quantities record.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/BillOfQuantitiesUpdateRequestRecordData"}}},"BillOfQuantitiesUpdateRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the bill of quantities."},"externalId":{"type":"string","description":"The external id. (max. 255 characters)"},"offerNumber":{"type":"string","description":"The offer number. (max. 30 characters)"},"addendum":{"type":"string","description":"The number of the addendum of this bill of quantities. (max. 10 characters)"},"text1":{"type":"string","description":"The name. (max. 80 characters)"},"text2":{"type":"string","description":"The additional name. (max. 80 characters)"},"noteStart":{"type":"string","description":"An additional note at the beginning."},"noteEnd":{"type":"string","description":"An additional note at the end."},"date":{"description":"The date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"totalValue":{"type":"number","description":"The total Value."},"currency":{"type":"string","description":"The currency."},"projectName":{"type":"string","description":"The name of the project. (max. 100 characters)"},"importSource":{"type":"string","description":"External data source from which this bill of quantities originates. (max. 50 characters)"},"importKey":{"type":"string","description":"External ID of the respective data source. (max. 50 characters)"}}},"StandardBillOfQuantitiesUpdateRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BillOfQuantitiesUpdateRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardBillOfQuantitiesDeleteResponse":{"type":"object","description":"","properties":{"deletedItems":{"description":"The bills of quantities that were deleted.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BillOfQuantitiesDeleteResponseBillOfQuantitiesItem"},{"description":""}]}}}},"BillOfQuantitiesDeleteResponseBillOfQuantitiesItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the bill of quantities."},"externalId":{"type":"string","description":"The external id. (max. 255 characters)"},"offerNumber":{"type":"string","description":"The offer number. (max. 30 characters)"},"addendum":{"type":"string","description":"The number of the addendum of this bill of quantities. (max. 10 characters)"},"text1":{"type":"string","description":"The name. (max. 80 characters)"},"text2":{"type":"string","description":"The additional name. (max. 80 characters)"},"noteStart":{"type":"string","description":"An additional note at the beginning."},"noteEnd":{"type":"string","description":"An additional note at the end."},"date":{"description":"The date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"totalValue":{"type":"number","description":"The total Value."},"currency":{"type":"string","description":"The currency."},"projectName":{"type":"string","description":"The name of the project. (max. 100 characters)"},"importSource":{"type":"string","description":"External data source from which this bill of quantities originates. (max. 50 characters)"},"importKey":{"type":"string","description":"External ID of the respective data source. (max. 50 characters)"}}},"StandardBillOfQuantitiesDeleteRequest":{"type":"object","description":"","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"The ids of the bill of quantities to be deleted. This Parameter is required."},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardResourceAssignmentFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The resource assignments.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ResourceAssignmentFetchResponseResourceAssignmentListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available resource assignments.\n(Only calculated if offset is 0)"}}},"ResourceAssignmentFetchResponseResourceAssignmentListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the assignment"},"resource":{"description":"The resource of the assignment.","type":"object","$ref":"#\/components\/schemas\/ResourceAssignmentFetchResponseResourceItem"},"assignedResource":{"description":"The assigned resource of the assignment.","type":"object","$ref":"#\/components\/schemas\/ResourceAssignmentFetchResponseAssignedResourceItem"},"assignedFrom":{"description":"The start of the assignment.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"assignedTo":{"description":"The end of the assignment. If not set the assignment has an open end.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"planningType":{"type":"string","description":"The planning type of the assignment."}}},"ResourceAssignmentFetchResponseResourceItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the resource."},"name":{"type":"string","description":"The name of the resource."}}},"ResourceAssignmentFetchResponseAssignedResourceItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the assigned resource."},"name":{"type":"string","description":"The name of the assigned resource."}}},"ResourceAssignmentFetchRequestResourceAssignmentFilter":{"type":"object","description":"","properties":{"byResourceIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the resource IDs."},"byEmployeeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the employee IDs."},"byToolIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the tool IDs."},"byTrackerIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the tracker IDs."},"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the project IDs."},"byOrderIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the order IDs."},"byAbsenceTypeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the resource absence type IDs."},"byCustomProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the resource assignments based on the custom project IDs."},"from":{"description":"Filters the resource assignments based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filters the resource assignments based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardResourceAssignmentFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The resource assignment filter. This parameter is optional.","type":"object","$ref":"#\/components\/schemas\/ResourceAssignmentFetchRequestResourceAssignmentFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardContainerTypeFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The container types.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerTypeBaseContainerTypeListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available container types."}}},"StandardContainerTypeFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records."}}},"MapFetchRequestTrackerFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the vehicles based on the IDs."},"byLicenseNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the license plates."},"byIdentifiers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the customer-specific IDs."},"byIdentificationNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the VINs."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the external vehicle IDs."},"byProjectChangedAfter":{"description":"Filter the vehicles which projectChangedAt is after the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered."},"byName":{"type":"string","description":"Filter the vehicles on their name."},"byDriver":{"type":"string","description":"Filter the vehicles on their driver."}}},"StandardMapViewRequest":{"type":"object","description":"","properties":{"controls":{"type":"boolean","description":"Select whether the controls are displayed. This Parameter is optional."},"center":{"description":"Select the center of the map. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"zoom":{"type":"integer","description":"Set zoom level. This Parameter is optional."},"logo":{"type":"string","description":"Which logo should be dis\n\n| Value           | Description         |\n|-----------------|---------------------|\n| GEOCAPTURE      | geoCapture logo     |\n| CUSTOMER        | Customer logo       |"},"from":{"description":"Show the trackpoints from this moment on. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Show the trackpoints till this moment. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"date":{"description":"Show the trackpoints from this date. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/Date"},"trackers":{"description":"Filter for vehicles. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/MapFetchRequestTrackerFilter"},"eventTypes":{"type":"array","items":{"type":"string"},"description":"Show events. This Parameter is optional.\n\n| Value            | Description         |\n|-----------------|---------------------|\n| STOP            | Stop                |"}}},"StandardMapFetchResponse":{"type":"object","description":"","properties":{"trackers":{"description":"The vehicles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MapFetchResponseTrackerItem"},{"description":""}]}},"trackPoints":{"description":"The geo coordinate list.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MapFetchResponseTrackPointList"},{"description":""}]}},"events":{"description":"The event list.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MapFetchResponseEventList"},{"description":""}]}},"autoRefresh":{"type":"integer","description":"The configured refresh interval in seconds."}}},"MapFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"color":{"type":"string","description":"The defined route color."},"latLng":{"description":"The current positions.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"iconUrl":{"type":"string","description":"The URL for the icon."},"iconSize":{"type":"array","items":{"type":"integer"},"description":"The icon size in pixel."},"driverName":{"type":"string","description":"The driver name."},"sensors":{"description":"The available sensors.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MapFetchResponseTrackerSensorItem"},{"description":""}]}},"hasDriverKey":{"type":"boolean","description":"The current driver uses an iButton or RFID key."},"latLngBounds":{"description":"The rectangle around the route.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"}}},"MapFetchResponseTrackerSensorItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal sensor ID."},"name":{"type":"string","description":"The sensor name."},"type":{"type":"string","description":"The sensor type.\n\n| Value                     |  Description                               |\n| ------------------------ | ------------------------------------------- |\n| ALTITUDE                 | Height                                      |\n| SPEED                    | Speed                                       |\n| DIRECTION                | Direction                                   |\n| GPS_SIGNAL_QUALITY       | GPS signal strength (Number of satellites)  |\n| GSM_SIGNAL_QUALITY       | GSM signal strength                         |\n| POWER_SUPPLY_VOLTAGE     | Voltage                                     |\n| EMPLOYEE                 | Employee                                    |\n| PIECE                    | Piece                                       |\n| SECOND                   | Second                                      |\n| MINUTE                   | Minute                                      |\n| DEGREE                   | Degree                                      |\n| MILLIVOLT                | Millivolt                                   |\n| METER                    | Meter                                       |\n| METER_PER_SEC2           | Meter\/s\u00b2                                    |\n| KILOMETER                | Kilometer                                   |\n| KILOMETER_PER_HOUR       | Kilometer\/h                                 |\n| LITER                    | Liter                                       |\n| LITER_PER_100KM          | Liter\/100 km                                |\n| VOLT                     | Volt                                        |\n| AMPERE                   | Ampere                                      |\n| MILLIAMPERE              | Milliampere                                 |\n| PERCENT                  | Percent                                     |\n| DEGREE_CELSIUS           | Degrees Celsius (\u00b0C)                        |\n| BOOLEAN                  | On\/Off                                      |\n| ID                       | ID                                          |\n| NUMBER                   | Number                                      |\n| METER2                   | Meter\u00b2                                      |\n| HECTARE                  | Hectar                                      |"}}},"MapFetchResponseTrackPointList":{"type":"object","description":"","properties":{"trackerId":{"type":"integer","description":"The internal vehicle ID to which this list belongs."},"data":{"description":"The individual points.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MapFetchResponseTrackPointItem"},{"description":""}]}}}},"MapFetchResponseTrackPointItem":{"type":"object","description":"","properties":{"time":{"description":"The timestamp.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"latLng":{"description":"The position","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"sensorValues":{"description":"The sensor values.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MapFetchResponseTrackPointSensorValueItem"},{"description":""}]}}}},"MapFetchResponseTrackPointSensorValueItem":{"type":"object","description":"","properties":{"sensorId":{"type":"integer","description":"The sensor."},"value":{"type":"number","description":"The value."},"displayValue":{"type":"string","description":"The formatted value."}}},"MapFetchResponseEventList":{"type":"object","description":"","properties":{"trackerId":{"type":"integer","description":"The internal vehicle ID this list is linked to."},"data":{"description":"The individual points.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MapFetchResponseEventItem"},{"description":""}]}}}},"MapFetchResponseEventItem":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The event type\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| MOVE                     | Move                                 |\n| STOP                     | Stop                                 |\n| STAMP                    | Stamp                                |\n| IGNITION                 | Ignition                             |\n| SENSOR                   | Sensor                               |"},"sensorValueTypeName":{"type":"string","description":"The event value type name."},"startTime":{"description":"The timestamp at the event start.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"startLatLng":{"description":"The geo coordinates of the vehicle at the event start.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"startProjectId":{"type":"integer","description":"The project the vehicle was located at the event start."},"endTime":{"description":"The timestamp at the event end.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endLatLng":{"description":"The geo coordinates of the vehicle at the event end.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"endProjectId":{"type":"integer","description":"The project the vehicle was located at the event start."},"distance":{"type":"integer","description":"The driven distance in meters."},"employeeId":{"type":"integer","description":"For MOVE events the driver. For STAMP events the employee."},"beaconIds":{"type":"integer","description":"The beacon\u0027s IDs of the event."}}},"StandardMapFetchRequest":{"type":"object","description":"","properties":{"from":{"description":"Show the trackpoints from this moment on. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Show the trackpoints till this moment. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"date":{"description":"Show the trackpoints from this date. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/Date"},"trackers":{"description":"Filter for vehicles. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/MapFetchRequestTrackerFilter"},"eventTypes":{"type":"array","items":{"type":"string"},"description":"Show events. This Parameter is optional.\n\n| Value            | Description         |\n|-----------------|---------------------|\n| STOP            | Stop                |"}}},"StandardProjectCategoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tool categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectCategoryFetchRequestProjectCategoryListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tool categories."}}},"ProjectCategoryFetchRequestProjectCategoryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the project category."},"description":{"type":"string","description":"The description of the project category."},"externalId":{"type":"string","description":"The external ID of the project category."},"createdAt":{"description":"Date when the project category was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardProjectCategoryFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardProjectCategoryUpsertResponse":{"type":"object","description":"","properties":{"createdProjectCategories":{"description":"The created project categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectCategoryUpsertResponseProjectCategoryItem"},{"description":""}]}},"updatedProjectCategories":{"description":"The changed project categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectCategoryUpsertResponseProjectCategoryItem"},{"description":""}]}},"deletedProjectCategories":{"description":"The deleted project categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectCategoryUpsertResponseProjectCategoryItem"},{"description":""}]}}}},"ProjectCategoryUpsertResponseProjectCategoryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the project category."},"description":{"type":"string","description":"The description of the project category."},"externalId":{"type":"string","description":"The external ID of the project category."},"createdAt":{"description":"Date when the project category was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"ProjectCategoryUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal project category ID        |\n| externalid     | The external ID of the project category |"},"data":{"description":"The project category record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/ProjectCategoryUpsertRequestRecordData"}}},"ProjectCategoryUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the project category."},"description":{"type":"string","description":"The name of the project category. (max. 255 characters)"},"costCenter":{"type":"string","description":"The cost center of the project category. (max. 255 characters)"},"externalId":{"type":"string","description":"The external ID of the project category. (max. 255 characters)"},"namedId":{"type":"string","description":"The system internal ID of the project category. (max. 255 characters)"},"export":{"type":"boolean","description":"Whether the projects in this project category should be exported."},"ignoreReverseGeocoding":{"type":"boolean","description":"Whether the projects in this project category should be used for geocpding and events."},"homeCategory":{"type":"boolean","description":"Whether the projects in this project category are a home project (No driving times will be added)."}}},"StandardProjectCategoryUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectCategoryUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all project categories missing from this request? This Parameter is optional. (Default:\nfalse)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardTrackPointFetchResponse":{"type":"object","description":"","properties":{"sensors":{"description":"The vehicle sensors.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackPointFetchResponseTrackerSensorItem"},{"description":""}]}},"trackPoints":{"description":"The GPS records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackPointFetchResponseTrackPointItem"},{"description":""}]}},"lastTrackPointId":{"type":"string","description":"The ID of the last GPS record.\nWith this ID, newer records can be queried later,\nwhen passed as the \u0022afterTrackPointId\u0022 parameter."},"complete":{"type":"boolean","description":"Are the requested records complete?\n\nFor a \u0022false\u0022 value, further queries would have to be made with the \u0022afterTrackPointId\u0022 parameter,\nto load all records. The value for the parameter is contained in the lastTrackPointId field."}}},"TrackPointFetchResponseTrackerSensorItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal sensor ID."},"name":{"type":"string","description":"The sensor name."},"type":{"type":"string","description":"The sensor type.\n\n| Value                     |  Description                               |\n| ------------------------ | ------------------------------------------- |\n| ALTITUDE                 | Height                                      |\n| SPEED                    | Speed                                       |\n| DIRECTION                | Direction                                   |\n| GPS_SIGNAL_QUALITY       | GPS signal strength (Number of satellites)  |\n| GSM_SIGNAL_QUALITY       | GSM signal strength                         |\n| POWER_SUPPLY_VOLTAGE     | Voltage                                     |\n| EMPLOYEE                 | Employee                                    |\n| PIECE                    | Piece                                       |\n| SECOND                   | Second                                      |\n| MINUTE                   | Minute                                      |\n| DEGREE                   | Degree                                      |\n| MILLIVOLT                | Millivolt                                   |\n| METER                    | Meter                                       |\n| METER_PER_SEC2           | Meter\/s\u00b2                                    |\n| KILOMETER                | Kilometer                                   |\n| KILOMETER_PER_HOUR       | Kilometer\/h                                 |\n| LITER                    | Liter                                       |\n| LITER_PER_100KM          | Liter\/100 km                                |\n| VOLT                     | Volt                                        |\n| AMPERE                   | Ampere                                      |\n| MILLIAMPERE              | Milliampere                                 |\n| PERCENT                  | Percent                                     |\n| DEGREE_CELSIUS           | Degrees Celsius (\u00b0C)                        |\n| BOOLEAN                  | On\/Off                                      |\n| ID                       | ID                                          |\n| NUMBER                   | Number                                      |\n| METER2                   | Meter\u00b2                                      |\n| HECTARE                  | Hectar                                      |"}}},"TrackPointFetchResponseTrackPointItem":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The record ID."},"time":{"description":"The timestamp.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"gpsSignalQuality":{"type":"integer","description":"The GPS signal quality."},"gsmSignalQuality":{"type":"integer","description":"The GSM signal quality."},"direction":{"type":"number","description":"The direction."},"speed":{"type":"number","description":"The speed."},"altitude":{"type":"number","description":"The height."},"powerSupplyVoltage":{"type":"number","description":"The power supply voltage."},"latLng":{"description":"The position.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"sensorValues":{"description":"The sensor values.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackPointFetchResponseTrackPointSensorValueItem"},{"description":""}]}}}},"TrackPointFetchResponseTrackPointSensorValueItem":{"type":"object","description":"","properties":{"sensorId":{"type":"integer","description":"The sensor."},"value":{"type":"number","description":"The sensor value."}}},"TrackPointFetchRequestTrackerFilter":{"type":"object","description":"","properties":{"byId":{"type":"integer","description":"Filter the vehicle by the ID."},"byLicenseNumber":{"type":"string","description":"Filter the vehicle by the license plate."},"byIdentifier":{"type":"string","description":"Filter the vehicle by the customer specific ID."},"byIdentificationNumber":{"type":"string","description":"Filter the vehicle by the vehicle identification number."},"byImportKey":{"type":"string","description":"Filter the vehicle by the external vehicle ID."},"importSource":{"type":"string","description":"Name of the external data source (Standard is \u0022*API\u0022)\n\nThis parameter is only required for filtering by the external vehicle ID."}}},"StandardTrackPointFetchRequest":{"type":"object","description":"","properties":{"tracker":{"description":"Vehicle filter. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/TrackPointFetchRequestTrackerFilter"},"afterTrackPointId":{"type":"string","description":"Get the records by the specified record ID.\nUse the \u0022lastTrackPointId\u0022 value from the previous request here."},"from":{"description":"Filter by records from this point on.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filter by records up to this point.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardApprovalCenterFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The approvals.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseApprovalLogItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available approvals.\n(Calculated only if the offset is 0)"}}},"ApprovalCenterFetchResponseApprovalLogItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"assignee":{"description":"The assigneed employee.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseEmployeeItem"},"employee":{"description":"The employee.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseEmployeeItem"},"date":{"description":"Date of the approval.","type":"object","$ref":"#\/components\/schemas\/Date"},"objectType":{"type":"string","description":"The type of the approval.\n\n| Value                      | Description                                         |\n|----------------------------|-----------------------------------------------------|\n| APPROVAL_EMPLOYEE_WORKTIME | The approval is for verifying work time.            |\n| EMPLOYEE_APPLICATION       | The approval is an application of an employee.      |\n| CUSTOM_FORM_DATA           | The approval is for verifying a form.               |"},"objectId":{"type":"integer","description":"The internal ID of the object to be approved."},"status":{"type":"string","description":"The current status of the approval.\n\n| Value                     | Description                                                                                             |\n|---------------------------|---------------------------------------------------------------------------------------------------------|\n| PENDING                   | The approval is not yet in place and cannot be processed until the previous application is approved.    |\n| OPEN                      | The approval is open and unprocessed.                                                                   |\n| DONE                      | The approval has been approved.                                                                         |\n| DONE_BY_RELATION          | The approval was approved by a dependency.                                                                |\n| REJECTED                  | The approval was rejected. (Only possible for applications)                                             |\n| WITHDRAWN                 | The request for the approval was withdrawn. (Only possible for applications).                           |\n| CONSULTATION_REQUIRED     | The request for the approval requires consultation. (Only possible for applications)                    |\n| PROVISIONALLY_ACCEPTED    | The application for the approval has been provisionally approved. (Only possible for applications)      |"},"notes":{"description":"The notes of the approval.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseApprovalLogNoteItem"},{"description":""}]}},"worktimeData":{"description":"The data for the work time approval. Filled only for the type APPROVAL_EMPLOYEE_WORKTIME.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseWorktimeDataItem"},"applicationData":{"description":"The data for the approval of applications. Filled only for the type EMPLOYEE_APPLICATION.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseApplicationDataItem"},"formData":{"description":"The data for the approval of forms. Filled only for the type EMPLOYEE_APPLICATION.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseFormDataItem"},"createdAt":{"description":"Creation date of the approval.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"ApprovalCenterFetchResponseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."}}},"ApprovalCenterFetchResponseApprovalLogNoteItem":{"type":"object","description":"","properties":{"text":{"type":"string","description":"The note\u0027s text."},"createdAt":{"description":"The creation date.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"ApprovalCenterFetchResponseWorktimeDataItem":{"type":"object","description":"","properties":{"date":{"description":"The date of the shift.","type":"object","$ref":"#\/components\/schemas\/Date"},"shiftStart":{"description":"Start of shift.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"shiftEnd":{"description":"End of shift.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"project":{"description":"The project on which work was carried out.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseProjectItem"},"worktime":{"type":"integer","description":"The work time in seconds."}}},"ApprovalCenterFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"}}},"ApprovalCenterFetchResponseApplicationDataItem":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The application type.\n\n| Value                             | Description                  |\n|----------------------------------|-------------------------------|\n| EMPLOYEE_ABSENCE                 | Absence application           |\n| EMPLOYEE_STAMP                   | Stamp application             |\n| EMPLOYEE_ACCOUNTING_ENTRY        | Accounting entry application  |"},"priority":{"type":"string","description":"The application\u0027s priority.\n\n| Value                | Description        |\n|----------------------|--------------------|\n| HIGH                 | High               |\n| NORMAL               | Normal             |\n| LOW                  | Low                |"},"absenceData":{"description":"The absence application\u0027s data. Only filled for EMPLOYEE_ABSENCE applications.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseApplicationAbsenceEntryDataItem"},"stampData":{"description":"The stamp application\u0027s data. Only filled for STAMP_ABSENCE applications.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseApplicationStampDataItem"},"accountingEntryData":{"description":"The accounting entry application\u0027s data. Only filled for ACCOUNTING_ENTRY_ABSENCE applications.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseApplicationAccountingEntryDataItem"}}},"ApprovalCenterFetchResponseApplicationAbsenceEntryDataItem":{"type":"object","description":"","properties":{"salaryType":{"description":"The application\u0027s salary type.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseSalaryTypeItem"},"durationType":{"type":"string","description":"Duration type.\n\n| Value                | Description          |\n|----------------------|----------------------|\n| WHOLE_DAY            | Whole day           |\n| HALF_DAY             | Half a day            |\n| HOURS                | Hours              |"},"from":{"description":"Absence start date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Absence end date","type":"object","$ref":"#\/components\/schemas\/Date"},"duration":{"type":"integer","description":"Absence time per day in seconds. (Only for type HOURS)"}}},"ApprovalCenterFetchResponseSalaryTypeItem":{"type":"object","description":"","properties":{"name":{"type":"string","description":"The name od the salary type."},"type":{"type":"string","description":"The salary type."},"isVacationSalaryType":{"type":"boolean","description":"Whether the salary type is the holiday salary type."}}},"ApprovalCenterFetchResponseApplicationStampDataItem":{"type":"object","description":"","properties":{"time":{"description":"Stamp\u0027s time","type":"object","$ref":"#\/components\/schemas\/DateTime"},"state":{"type":"string","description":"Stamp type\n\n| Value                | Description        |\n|---------------------|--------------------|\n| S                   | Start stamp  |\n| E                   | End stamp   |"},"tracker":{"description":"Stamp\u0027s vehicle.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseTrackerItem"},"project":{"description":"Stamp\u0027s project.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseProjectItem"}}},"ApprovalCenterFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"}}},"ApprovalCenterFetchResponseApplicationAccountingEntryDataItem":{"type":"object","description":"","properties":{"salaryType":{"description":"The salary type of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseSalaryTypeItem"},"value":{"type":"number","description":"Value."},"valueUnit":{"type":"string","description":"Value unit.\n\n| Value                | Description          |\n|----------------------|----------------------|\n| HOUR                 | Hours                |\n| DAY                  | Days                 |\n| CURRENCY             | Currency             |\n| QUANTITY             | Quantity             |"},"project":{"description":"Project of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchResponseProjectItem"}}},"ApprovalCenterFetchResponseFormDataItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"customFormId":{"type":"string","description":"The internal ID."},"name":{"type":"string","description":"Name of the form"},"latLng":{"description":"Coordinates of the Location the form was filled out.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"status":{"type":"string","description":"Status of the form.\n\n | Value      | Description                           |\n |------------|---------------------------------------|\n | NEW        | Freshly created                       |\n | FILLED     | Filled out form                       |\n | REVIEW     | Approval pending                      |\n | APPROVED   | Approved via associated approval rule |\n | COMPLETED  | Manually approved via user            |\n | REJECTED   | Rejected via associated approval rule |\n | RESET      | Approval reverted                     |\n | DELETED    | Deleted                               |"}}},"ApprovalCenterFetchRequestApprovalLogFilter":{"type":"object","description":"","properties":{"byAssignee":{"type":"integer","description":"Filters the approvals by the assignee."},"byEmployee":{"type":"integer","description":"Filters the approvals by the employee."},"byStatuses":{"type":"array","items":{"type":"string"},"description":"Filters the approvals by the status.\n\n| Value                  | Description                     |\n| ---------------------- | ------------------------------- |\n| OPEN                   | Approval open                   |\n| DONE                   | Approval done                   |\n| REJECTED               | Approval rejected               |\n| CONSULTATION_REQUIRED  | Approval requires consultation  |\n| PROVISIONALLY_ACCEPTED | Approval provisionally accepted |"},"byObjectType":{"type":"string","description":"Filters the approvals by the type.\n\n| Value                      | Description                                                             |\n| -------------------------- | ----------------------------------------------------------------------- |\n| APPROVAL_EMPLOYEE_WORKTIME | If working times from stamps must be approved. Configured in Department |\n| EMPLOYEE_APPLICATION       | If the employee submits an application: e.g. absence                    |\n| CUSTOM_FORM_DATA           | If custom forms must be approved: Configured in form definition         |"},"byObjectId":{"type":"integer","description":"Filters the approvals by the object. Can be used only in conjunction with the filter \u0022byObjectType\u0022."}}},"StandardApprovalCenterFetchRequest":{"type":"object","description":"","properties":{"logs":{"description":"The approval\u0027s filter. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterFetchRequestApprovalLogFilter"},"offset":{"type":"integer","description":"Number of records to skip."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardApprovalCenterUpdateStatusResponse":{"type":"object","description":"","properties":{"logId":{"type":"integer","description":"Internal ID of the changed approval."}}},"StandardApprovalCenterUpdateStatusRequest":{"type":"object","description":"","properties":{"logId":{"type":"integer","description":"The internal ID of the approval log to be processed. This Parameter is required."},"status":{"type":"string","description":"The new status. (Required)\n\n| Value                     | Description                                                                                             |\n|---------------------------|---------------------------------------------------------------------------------------------------------|\n| OPEN                      | The approval is open and unprocessed.                                                                   |\n| DONE                      | The approval has been approved.                                                                         |\n| REJECTED                  | The approval was rejected. (Only possible for applications)                                             |\n| CONSULTATION_REQUIRED     | The request for the approval requires consultation. (Only possible for applications)                    |\n| PROVISIONALLY_ACCEPTED    | The application for the approval has been provisionally approved. (Only possible for applications)      |"},"note":{"type":"string","description":"The note for the status change. (Ignored if the new status is DONE)."}}},"StandardApprovalCenterCreateResponse":{"type":"object","description":"","properties":{"logIds":{"type":"array","items":{"type":"integer"},"description":"The internal ID of the created application."}}},"ApprovalCenterCreateRequestApplicationDataItem":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The application type. This Parameter is required."},"priority":{"type":"string","description":"The priority of the application. Default: NORMAL.\n\n| Value                | Description        |\n|----------------------|--------------------|\n| HIGH                 | High               |\n| NORMAL               | Normal             |\n| LOW                  | LOW                |"},"absenceData":{"description":"The data for absence applications. (Only needed for EMPLOYEE_ABSENCE applications)","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterCreateRequestApplicationAbsenceEntryDataItem"},"stampData":{"description":"The data for stamp applications. (Only needed for EMPLOYEE_STAMP applications)","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterCreateRequestApplicationStampDataItem"},"accountingEntryData":{"description":"The data for accounting entry applications. (Only needed for EMPLOYEE_ACCOUNTING_ENTRY applications)","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterCreateRequestApplicationAccountingEntryDataItem"}}},"ApprovalCenterCreateRequestApplicationAbsenceEntryDataItem":{"type":"object","description":"","properties":{"absenceTypeId":{"type":"integer","description":"The internal absence type ID."},"absenceTypeExternalId":{"type":"string","description":"The external id of the absence type (Used if absenceTypeId not provided)."},"durationType":{"type":"string","description":"Duration type. This Parameter is required.\n\n| Value                | Description         |\n|---------------------|---------------------|\n| WHOLE_DAY           | Whole Days          |\n| HALF_DAY            | Half Days          |\n| HOURS               | Hours             |"},"dateFrom":{"description":"Absence start date. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/Date"},"dateTo":{"description":"Absence end date. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/Date"},"duration":{"type":"integer","description":"Absence time per day in seconds. Only if duration type is HOURS."}}},"ApprovalCenterCreateRequestApplicationStampDataItem":{"type":"object","description":"","properties":{"time":{"description":"Stamp time. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"state":{"type":"string","description":"Stamp type. This Parameter is required.\n\n| Wert                | Bezeichnung        |\n|---------------------|--------------------|\n| S                   | Stay-Stamp          |\n| E                   | End-Stamp          |"},"trackerId":{"type":"integer","description":"The stamp\u0027s internal Vehicle ID."},"trackerVin":{"type":"string","description":"The stamp\u0027s vehicle identification number (Used if trackerId not provided)."},"projectId":{"type":"integer","description":"The stamp\u0027s project."},"projectReferenceSign":{"type":"string","description":"The stamp\u0027s project reference sign (Used if projectId not provided)."}}},"ApprovalCenterCreateRequestApplicationAccountingEntryDataItem":{"type":"object","description":"","properties":{"date":{"description":"The date for the accounting entry. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/Date"},"salaryTypeId":{"type":"integer","description":"The internal salary type ID for the accounting entry. (Required)"},"salaryType":{"type":"string","description":"The salary type for the accounting entry (Used if salaryTypeId not provided)."},"value":{"type":"number","description":"Value. This Parameter is required."},"projectId":{"type":"integer","description":"The internal project ID for the accounting entry."},"projectReferenceSign":{"type":"string","description":"The stamp\u0027s project reference sign (Used if projectId not provided)."}}},"StandardApprovalCenterCreateRequest":{"type":"object","description":"","properties":{"employeeId":{"type":"integer","description":"The applying employee\u0027s internal ID. This Parameter is required."},"applicationData":{"description":"The application data. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/ApprovalCenterCreateRequestApplicationDataItem"}}},"StandardTrackerHealthCheckResponse":{"type":"object","description":"","properties":{"status":{"type":"string","description":"Overall operational status of the tracker, derived from recent performance and signal data.\nPossible values:\n- `OK` \u2192 The tracker is fully operational, no issues detected.\n- `WARNING` \u2192 Minor irregularities detected that may require attention.\n- `FAILURE` \u2192 Major malfunction detected or tracker is not reporting correctly.\nThis field is intended for automated monitoring systems to quickly classify tracker health."},"issues":{"description":"A list of all identified issues affecting the tracker\u2019s performance or connectivity.\nEach issue entry includes a descriptive message, severity level, and suggested corrective action.\nIf no problems are found, this array may be empty.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerHealthCheckResponseTrackerHealthErrorItem"},{"description":""}]}}}},"TrackerHealthCheckResponseTrackerHealthErrorItem":{"type":"object","description":"","properties":{"message":{"type":"string","description":"Human-readable description of the detected issue, based on diagnostic rules.\nTypically explains the symptom."},"severity":{"type":"integer","description":"Severity level of the issue."},"recommendation":{"type":"string","description":"Recommended corrective action or troubleshooting step to resolve the issue.\nProvides practical guidance for technicians or automated maintenance systems."},"lastOccurrence":{"description":"Timestamp of the most recent detection of this issue.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardTrackerHealthCheckRequest":{"type":"object","description":"","properties":{"vehicleId":{"type":"integer","description":"The unique identifier of the vehicle whose tracker health should be checked."},"days":{"type":"integer","description":"The number of days to include in the health check analysis, counted backwards from the current date.\nFor example, `7` means the tracker data from the last seven days (including today) will be evaluated.\nUse this parameter to control how far back the system should look for anomalies or communication issues.\nDefault value (if omitted): `30` (data from the last 30 days)."}}},"StandardTrackerFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The vehicles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerFetchResponseTrackerItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skiped records."},"totalCount":{"type":"integer","description":"Total number of available vehicles.\n(Only calculated if offset is 0)"}}},"TrackerFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"description":{"type":"string","description":"The vehicle description."},"driverName":{"type":"string","description":"The driver name. (max. 255 characters)"},"driverPhoneNumber":{"type":"string","description":"The driver phone number. (max. 255 characters)"},"costCenter":{"type":"string","description":"The cost center. (max. 25 characters)"},"serialNumber":{"type":"string","description":"The serial number of the vehicle."},"manufacturingDate":{"description":"The manufacturing date of the vehicle.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"currentLatLng":{"description":"The current position.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/TrackerFetchResponseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentProjectChangedAt":{"description":"The time of the last project change.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"trackerSerialNumber":{"type":"string","description":"The serial number of the tracker."},"category":{"description":"The tracker category.","type":"object","$ref":"#\/components\/schemas\/StandardTrackerCategoryBaseTrackerCategoryListItem"},"lastSignalAt":{"description":"Time of the last signal.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"model":{"type":"string","description":"The tracker model."},"lastTrackpointId":{"type":"integer","description":"ID of the latest trackpoint."},"imei":{"type":"string","description":"IMEI of the tracker."}}},"TrackerFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."}}},"StandardTrackerCategoryBaseTrackerCategoryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tracker category."},"name":{"type":"string","description":"The name of the tracker category."},"description":{"type":"string","description":"The description of the tracker category."},"externalId":{"type":"string","description":"The external ID of the tracker category."},"costCenter":{"type":"string","description":"The cost center of the tracker category."},"createdAt":{"description":"Date when the tracker category was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"TrackerFetchRequestTrackerFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the vehicles based on the IDs."},"byLicenseNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the license plates."},"byIdentifiers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the customer-specific IDs."},"byIdentificationNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the VINs."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the vehicles based on the external vehicle IDs."},"byProjectChangedAfter":{"description":"Filter the vehicles which projectChangedAt is after the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered."},"byName":{"type":"string","description":"Filter the vehicles on their name."},"byDriver":{"type":"string","description":"Filter the vehicles on their driver."}}},"StandardTrackerFetchRequest":{"type":"object","description":"","properties":{"trackers":{"description":"The vehicle filter. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/TrackerFetchRequestTrackerFilter"},"normalizedSearch":{"type":"boolean","description":"Set this parameter to enable advanced filter methods (normalized license number, phonetic search for names)"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional."},"limit":{"type":"integer","description":"Max. number of requested records. This Parameter is optional."}}},"StandardTrackerUpsertResponse":{"type":"object","description":"","properties":{"updatedTrackers":{"description":"The changed vehicles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerUpsertResponseTrackerItem"},{"description":""}]}}}},"TrackerUpsertResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"}}},"TrackerUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value                   | Description                 |\n|------------------------|-----------------------------|\n| id                     | The internal vehicle ID     |\n| identifier             | The customer specific ID    |\n| licenseNumber          | The license plate    |\n| identificationNumber   | The vehicle identification number |\n| importKey              | The external record ID    |"},"data":{"description":"The vehicle record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/TrackerUpsertRequestRecordData"}}},"TrackerUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"description":{"type":"string","description":"The vehicle description."},"driverName":{"type":"string","description":"The driver name. (max. 255 characters)"},"driverPhoneNumber":{"type":"string","description":"The driver phone number. (max. 255 characters)"},"costCenter":{"type":"string","description":"The cost center. (max. 25 characters)"},"serialNumber":{"type":"string","description":"The serial number of the vehicle."},"manufacturingDate":{"description":"The manufacturing date of the vehicle.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"trackerProfileId":{"type":"integer","description":"The internal id of the tracker profile."},"trackerManufacturerId":{"type":"integer","description":"The internal id of the tracker manufacturer."},"model":{"type":"string","description":"The name of the model. (max. 255 characters)"},"activityType":{"type":"string","description":"The tracker activity type. (Default: DIST)\n\n| Value | Description |\n| ----- | ----------- |\n| DIST | Activity type distance |\n| TIME | Activity type duration |"},"fuelType":{"type":"string","description":"The tracker fuel type.\n\n| Value |\n| ----- |\n| DIESEL |\n| SUPER_E10 |\n| GAS |\n| BENZIN |\n| SUPER |\n| LKW_DIESEL |\n| ELECTRIC |\n| METHANOL |\n| BLUEDIESEL |"},"batteryCapacity":{"type":"number","description":"The battery capacity (only for electric vehicles)."},"consumption":{"type":"number","description":"The tracker consumption per 100 kilometers\/operating hour depending on the activity type."},"co2Emissions":{"type":"number","description":"The tracker co2 emissions in gramms per kilometer\/operating hour depending on the activity type."},"poolVehicle":{"type":"boolean","description":"Is this vehicle a pool vehicle?"},"locationId":{"type":"integer","description":"The internal id of the location."},"departmentId":{"type":"integer","description":"The internal id of the department."},"defaultDriverId":{"type":"integer","description":"The internal id of the default employee."},"usageStartDate":{"description":"The start date of this usage.","type":"object","$ref":"#\/components\/schemas\/Date"},"defaultDriverName":{"type":"string","description":"The name of the default driver. (max. 255 characters)"},"defaultDriverPhone":{"type":"string","description":"The phone number of the default driver. (max. 255 characters)"},"categoryExternalId":{"type":"string","description":"The external ID of the tracker category."}}},"StandardTrackerUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardMaintenanceFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The maintenances.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceBaseMaintenanceListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available maintenances."}}},"StandardMaintenanceBaseMaintenanceListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the maintenance."},"type":{"type":"string","description":"The maintenance type."},"description":{"type":"string","description":"The maintenance description."},"tracker":{"description":"The vehicle assigned to the maintenance.","type":"object","$ref":"#\/components\/schemas\/StandardMaintenanceBaseTrackerItem"},"tool":{"description":"The tool assigned to the maintenance.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseToolListItem"},"previousDate":{"description":"The last date of the maintenance.","type":"object","$ref":"#\/components\/schemas\/Date"},"nextDate":{"description":"The next date for the maintenance.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"MaintenanceFetchRequestMaintenanceFilter":{"type":"object","description":"","properties":{"byTrackerIds":{"type":"array","items":{"type":"integer"},"description":"Filters the maintenances based on the tracker ids."},"byToolIds":{"type":"array","items":{"type":"integer"},"description":"Filters the maintenances based on the tool ids."},"byMaintenanceTypeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the maintenances based on the maintenance type ids."}}},"StandardMaintenanceFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The maintenance filter","type":"object","$ref":"#\/components\/schemas\/MaintenanceFetchRequestMaintenanceFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardMaintenanceUpsertResponse":{"type":"object","description":"","properties":{"createdMaintenances":{"description":"The created maintenances.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceUpsertResponseMaintenanceItem"},{"description":""}]}},"updatedMaintenances":{"description":"The changed maintenances.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceUpsertResponseMaintenanceItem"},{"description":""}]}},"deletedMaintenances":{"description":"The deleted maintenances.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceUpsertResponseMaintenanceItem"},{"description":""}]}}}},"MaintenanceUpsertResponseMaintenanceItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the maintenance."},"type":{"type":"string","description":"The maintenance type."},"description":{"type":"string","description":"The maintenance description."},"tracker":{"description":"The vehicle assigned to the maintenance.","type":"object","$ref":"#\/components\/schemas\/StandardMaintenanceBaseTrackerItem"},"tool":{"description":"The tool assigned to the maintenance.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseToolListItem"},"previousDate":{"description":"The last date of the maintenance.","type":"object","$ref":"#\/components\/schemas\/Date"},"nextDate":{"description":"The next date for the maintenance.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"MaintenanceUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifier the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value | Description          |\n|-------|----------------------|\n| id    | The internal maintenance id |"},"data":{"description":"The maintenance record.\n\nFor updates only the updated fields need to be specified.","type":"object","$ref":"#\/components\/schemas\/MaintenanceUpsertRequestRecordData"}}},"MaintenanceUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the maintenance."},"description":{"type":"string","description":"The name of the maintenance. (max. 255 characters)"},"note":{"type":"string","description":"The description of the maintenance."},"maintenanceTypeId":{"type":"integer","description":"The internal id of the maintenance type."},"trackerId":{"type":"integer","description":"The internal of the vehicle for the maintenance. Only one of trackerId or toolId can be used."},"toolId":{"type":"integer","description":"The internal id of the tool for the maintenance. Only one of trackerId or toolId can be used."},"active":{"type":"boolean","description":"Wheather the maintenance shall be active or not."},"schedulerDefinition":{"description":"The scheduler.","type":"object","$ref":"#\/components\/schemas\/MaintenanceUpsertRequestSchedulerDefinition"}}},"MaintenanceUpsertRequestSchedulerDefinition":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The scheduler type.\n\n| Values               | Description                                               |\n| -------------------- | --------------------------------------------------------- |\n| performanceInterval  | Schedules the maintenances based on performance intervals |\n| performanceTotal     | Schedules the maintenances based on total performance     |\n| dateScheduler        | Schedules the maintenances based on a timed scheduler     |\n| date                 | Schedules the maintenances on a fixed date                |"},"performanceType":{"type":"string","description":"The performance type. (Used for types performanceInterval or performanteTotal)\n\n| Values   | Description                    |\n| -------- | ------------------------------ |\n| time     | Performance on operating hours |\n| distance | Performance on driven distance in kilometers |"},"performanceValue":{"type":"integer","description":"The performance value according to the performance type. (Used for types performanceInterval or performanteTotal)"},"maxHits":{"type":"integer","description":"The amount of repeats for the maintenance (default NULL) (NULL = no limit). (Used for types performanceInterval, performanteTotal or dateScheduler)"},"maxDaysAfterLastMaintenance":{"type":"integer","description":"The max amount of days after the last maintenance when the next one shall be scheduled.\n(Used for types performanceInterval or performanteTotal)"},"lastMaintenanceValue":{"type":"integer","description":"The performance value according to the performance type from the last maintenance. (Used for types performanceInterval or performanteTotal)"},"lastMaintenanceDate":{"description":"The date when the last maintenance took place. This value is required. (Default today)","type":"object","$ref":"#\/components\/schemas\/Date"},"nextMaintenanceDate":{"description":"The date for the next maintenance. (Only used for type date)","type":"object","$ref":"#\/components\/schemas\/Date"},"dateSchedulerDefinition":{"description":"The definition for type dateScheduler.","type":"object","$ref":"#\/components\/schemas\/OrderCreateRepeatRequestSchedulerDefinition"}}},"OrderCreateRepeatRequestSchedulerDefinition":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The scheduler type (See the examples for every type above).\n\n| Values             | Description                                                                           |\n| ------------------ | ------------------------------------------------------------------------------------- |\n| daily              | Every \u0027d\u0027 days                                                                        |\n| dailyEveryWorkday  | Every workday                                                                         |\n| weekly             | Every \u0027w\u0027 weeks on weekdays \u0027wd\u0027                                                      |\n| monthlyNthDay      | Every \u0027m\u0027 months on the \u0027dm\u0027 day of the month                                         |\n| monthlyNthWeekday  | Every \u0027m\u0027 months on the \u0027o\u0027 occurrence of the day of the week \u0027wd\u0027                    |\n| yearlyNthDay       | Every \u0027y\u0027 years on the specified date \u0027dm\u0027.\u0027my\u0027                                       |\n| yearlyNthWeekday   | Every \u0027y\u0027 years on the \u0027o\u0027 occurrence of the day of the week \u0027wd\u0027 in the month \u0027my\u0027   |"},"intervalDays":{"type":"integer","description":"Every x days. (d)"},"weekdays":{"type":"array","items":{"type":"integer"},"description":"Only on following weekdays: 1 = Monday, 7 = Sunday. (wd)"},"intervalWeeks":{"type":"integer","description":"Every x weeks. (w)"},"day":{"type":"integer","description":"Day of month. (dm)"},"intervalMonths":{"type":"integer","description":"Every x months. (m)"},"occurrence":{"type":"integer","description":"Every x specified weekday: 1 = first, 4 = fourth, 5 = last. (o)"},"month":{"type":"integer","description":"Month of the year: 1 = January, 12 = December. (my)"},"intervalYears":{"type":"integer","description":"Every x years. (y)"}}},"StandardMaintenanceUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/MaintenanceUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardCalendarFetchRequest":{"type":"object","description":"","properties":{"key":{"type":"string","description":"The employee key. This Parameter is optional."}}},"StandardOrderFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The orders.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderFetchResponseOrderListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available orders.\n(Only calculated if offset is 0)"}}},"OrderFetchResponseOrderListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order."},"reference":{"type":"string","description":"The customer order number."},"externalReference":{"type":"string","description":"The internal reference for the order."},"subject":{"type":"string","description":"The order subject."},"createdAt":{"description":"Date when the order was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"OrderFetchRequestOrderFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the order based on the internal IDs."},"byExternalReferences":{"type":"array","items":{"type":"string"},"description":"Filters the order based on the customer order numbers."},"from":{"description":"Filters the order based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filters the order based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"byTourIds":{"type":"array","items":{"type":"integer"},"description":"Filters the order based on the tour IDs."},"byStatusText":{"type":"string","description":"Filters the order based on the status text.\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |"},"byOrderType":{"type":"string","description":"Filters the order based on the order type.\n\n| Value                         |\n| ------------------------      |\n| REPEAT                        |\n| ORDER                         |\n| SAVED                         |\n| MACHINE_TRANSPORT             |"},"byBounds":{"description":"Filters the order based on the given rectangle.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"},"byUnassigned":{"type":"boolean","description":"Filters the order based on whether it\u0027s assigned to a tour."},"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the order based on the project IDs."},"byTeamIds":{"type":"array","items":{"type":"integer"},"description":"Filters the order based on the team IDs."}}},"StandardOrderFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The order filter. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/OrderFetchRequestOrderFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This Parameter is optional."}}},"StandardOrderFetchDataResponse":{"type":"object","description":"","properties":{"orderDetails":{"description":"The order details.","type":"object","$ref":"#\/components\/schemas\/OrderFetchDataResponseOrderDetailsItem"},"orderQualification":{"description":"The qualifications necessary for the order.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderFetchDataResponseOrderQualificationItem"},{"description":""}]}},"performanceFields":{"description":"The orders performance fields.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderFetchDataResponseOrderPerformanceFieldItem"},{"description":""}]}},"orderLog":{"description":"The order log.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderFetchDataResponseOrderStatusLogItem"},{"description":""}]}},"tourInfo":{"description":"The tour of this order.","type":"object","$ref":"#\/components\/schemas\/OrderFetchDataResponseDispoTourItem"},"schedule":{"description":"The schedule object contains all planned, estimated, and actual timestamps related to the execution of a route or order.\nIf the vehicle is equipped with a GPS device, many of these values are automatically recorded and continuously updated during the tour.","type":"object","$ref":"#\/components\/schemas\/OrderFetchDataResponseOrderScheduleItem"}}},"OrderFetchDataResponseOrderDetailsItem":{"type":"object","description":"","properties":{"reference":{"type":"string","description":"geoCapture order number."},"externalReference":{"type":"string","description":"external reference."},"customerOrderReference":{"type":"string","description":"customer order reference."},"offerReference":{"type":"string","description":"offer reference."},"orderType":{"type":"string","description":"order type."},"orderDate":{"description":"order date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"externalAddressId":{"type":"string","description":"external customer id."},"name":{"type":"string","description":"name."},"name2":{"type":"string","description":"name2."},"name3":{"type":"string","description":"name3."},"street":{"type":"string","description":"street."},"zipCode":{"type":"string","description":"zip code."},"city":{"type":"string","description":"city."},"provinceCode":{"type":"string","description":"province code."},"countryCode":{"type":"string","description":"country code."},"contactPersonName":{"type":"string","description":"contact person name."},"contactPersonEmail":{"type":"string","description":"contact person email."},"contactPersonPhoneNumber":{"type":"string","description":"contact person phone number."},"contactPersonMobileNumber":{"type":"string","description":"contact person mobile number."},"latLng":{"description":"lat\/lng.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"duration":{"type":"integer","description":"duration."},"text":{"type":"string","description":"order description."},"planningType":{"type":"string","description":"Order Planning Type."},"assignedTrackerId":{"type":"integer","description":"Tracker to which the order is assigned."},"assignedEmployeeId":{"type":"integer","description":"Employee to which the order is assigned."},"plannedDate":{"description":"Planned start date of the order.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"dueDate":{"description":"Planned end date of the order.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"openingHours":{"description":"Example: {\u0022MO\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]]}","type":"object","$ref":"#\/components\/schemas\/DynamicWeekdayTime"},"createdAt":{"description":"order creation date.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"OrderFetchDataResponseOrderQualificationItem":{"type":"object","description":"","properties":{"name":{"type":"string","description":"The order qualification."},"type":{"type":"string","description":"The order qualification type."}}},"OrderFetchDataResponseOrderPerformanceFieldItem":{"type":"object","description":"","properties":{"name":{"type":"string","description":"The name of the performance field."},"value":{"type":"number","description":"The value of the performance field."},"unit":{"type":"string","description":"The name of the unit associated with the performance field."}}},"OrderFetchDataResponseOrderStatusLogItem":{"type":"object","description":"","properties":{"status":{"type":"string","description":"The order status event."},"time":{"description":"The time of the occured event.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"name":{"type":"string","description":"The name of the user\/employee that caused the event."}}},"OrderFetchDataResponseDispoTourItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The tour id."},"type":{"type":"string","description":"The tour type."},"district":{"type":"string","description":"The tour district."},"team":{"type":"string","description":"The team for the tour."},"reference":{"type":"integer","description":"The tour reference."},"status":{"type":"string","description":"The tour status."},"startDate":{"description":"Date the tour was started.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endDate":{"description":"Date the tour was finished.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"numStops":{"type":"integer","description":"The amount of stops of this tour."},"numOrders":{"type":"integer","description":"The amount of orders of this tour."},"distance":{"type":"integer","description":"The distance of this tour in meters."}}},"OrderFetchDataResponseOrderScheduleItem":{"type":"object","description":"","properties":{"plannedArrivalAt":{"description":"The initially planned arrival time for this order, as determined by the route planning process.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"estimatedArrivalAt":{"description":"The estimated time of arrival (ETA). This value is updated based on the vehicle\u2019s GPS position or after the completion of the previous order.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"navigationStartAt":{"description":"The timestamp indicating when navigation to this order location was started.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"realArrivalAt":{"description":"The actual arrival time at the order location. Set automatically if the vehicle has a GPS device; otherwise, this field remains empty.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"finishedAt":{"description":"The time when the order status was changed to finished.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"estimatedDepartureAt":{"description":"The estimated departure time. Updated dynamically if GPS data is available or recalculated after order completion.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"realDepartureAt":{"description":"The actual departure time from the order location. Automatically set when the vehicle leaves the site (if GPS data is available).","type":"object","$ref":"#\/components\/schemas\/DateTime"},"avisSendAt":{"description":"The timestamp of the last sent avis (notification message).","type":"object","$ref":"#\/components\/schemas\/DateTime"},"avisAt":{"description":"The scheduled time included in the avis notification.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardOrderFetchDataRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order. This Parameter is required."},"order_log":{"type":"boolean","description":"Show the order log. This Parameter is optional."},"order_qualification":{"type":"boolean","description":"Show the order qualification. This Parameter is optional."},"tour_info":{"type":"boolean","description":"Show the tour info. This Parameter is optional."}}},"StandardOrderFetchDeliveryStatusResponse":{"type":"object","description":"","properties":{"deliveryStatus":{"description":"The delivery statuses for the order.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderFetchDeliveryStatusResponseOrderDeliveryStatusItem"},{"description":""}]}}}},"OrderFetchDeliveryStatusResponseOrderDeliveryStatusItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Internal order ID."},"text":{"type":"string","description":"Current delivery status message or ETA description."},"timeFrom":{"description":"Start of the estimated delivery window.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"timeTo":{"description":"End of the estimated delivery window.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardOrderFetchDeliveryStatusRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Internal unique ID of the order."},"reference":{"type":"string","description":"The order reference."},"address":{"type":"string","description":"Address associated with the order. Can be combined with radius to search nearby orders."},"radius":{"type":"integer","description":"Search radius (in meters) around the specified address. Used only when address is provided. Default: 50."},"dispoTypeId":{"type":"integer","description":"Internal id of the dispo type used to further narrow down orders when searching by address. Only applies if address is specified."},"dispoTypeName":{"type":"string","description":"Name of the dispo type used to further narrow down orders when searching by address. Only applies if address is specified."},"daysBefore":{"type":"integer","description":"Include orders created or scheduled up to this number of days before today. Default: 0."},"daysAfter":{"type":"integer","description":"Include orders created or scheduled up to this number of days after today. Default: 0."},"locale":{"type":"string","description":"Language code for the response text. Default: de.\n\n| Value | Language |\n| ----- | -------- |\n| de    | German   |\n| en    | English  |\n| es    | Spanish  |\n| fr    | French   |\n| it    | Italian  |\n| nl    | Dutch    |\n| pl    | Polish   |\n| ro    | Romanian |\n| ru    | Russian  |"}}},"StandardOrderDeleteResponse":{"type":"object","description":"","properties":{"deletedItems":{"description":"The orders that were deleted.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderDeleteResponseOrderItem"},{"description":""}]}}}},"OrderDeleteResponseOrderItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order"},"reference":{"type":"string","description":"The internal reference for the order (max. 64 characters)"},"orderType":{"type":"string","description":"The order type. This parameter is optional. The allowed value and default is \u0027ORDER\u0027"},"externalReference":{"type":"string","description":"The customer order number (max. 64 characters)"},"status":{"type":"string","description":"The order state\n\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |"},"subject":{"type":"string","description":"Order subject (max. 255 characters)"},"text":{"type":"string","description":"Order description"},"orderDate":{"description":"The order date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"duration":{"type":"integer","description":"The order duration"},"priority":{"type":"string","description":"order priority\n\n| Value                        |\n| ------------------------     |\n| LOW                          |\n| NORMAL                       |\n| HIGH                         |"},"targetDate":{"description":"The order target date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"externalAddressId":{"type":"string","description":"The external customer id."},"name":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"name2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"name3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code"},"city":{"type":"string","description":"The city"},"countryCode":{"type":"string","description":"The country code"},"latLng":{"description":"The geo-coordinates","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonName":{"type":"string","description":"The contact person name (max. 255 characters)"},"contactPersonEmail":{"type":"string","description":"The contact person email (max. 255 characters)"},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number (max. 64 characters)"},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile phone number (max. 64 characters)"},"customerOrderReference":{"type":"string","description":"The customer order reference (max. 64 characters)"},"offerReference":{"type":"string","description":"The offer reference (max. 255 characters)"},"category":{"type":"integer","description":"The id of the order category. You need to provide this Parameter or the categoryExternalId."},"categoryExternalId":{"type":"string","description":"The external id of the order category (Used if category not provided)."},"type":{"type":"string","description":"| Values         |\n| -------------- |\n| PROJECT        |\n| CUSTOM_PROJECT |"},"project":{"type":"integer","description":"The id of the project."},"projectReferenceSign":{"type":"string","description":"The reference sign of the project (Used if project not provided)."},"createdAt":{"description":"When the order was created","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardOrderDeleteRequest":{"type":"object","description":"","properties":{"filter":{"description":"The order filter. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/OrderFetchRequestOrderFilter"},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardOrderUpsertResponse":{"type":"object","description":"","properties":{"createdOrders":{"description":"The created orders.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderUpsertResponseOrderItem"},{"description":""}]}},"updatedOrders":{"description":"The changed orders.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderUpsertResponseOrderItem"},{"description":""}]}},"deletedOrders":{"description":"The deleted orders.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderUpsertResponseOrderItem"},{"description":""}]}}}},"OrderUpsertResponseOrderItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order"},"reference":{"type":"string","description":"The internal reference for the order (max. 64 characters)"},"orderType":{"type":"string","description":"The order type. This parameter is optional. The allowed value and default is \u0027ORDER\u0027"},"externalReference":{"type":"string","description":"The customer order number (max. 64 characters)"},"status":{"type":"string","description":"The order state\n\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |"},"subject":{"type":"string","description":"Order subject (max. 255 characters)"},"text":{"type":"string","description":"Order description"},"orderDate":{"description":"The order date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"duration":{"type":"integer","description":"The order duration"},"priority":{"type":"string","description":"order priority\n\n| Value                        |\n| ------------------------     |\n| LOW                          |\n| NORMAL                       |\n| HIGH                         |"},"targetDate":{"description":"The order target date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"externalAddressId":{"type":"string","description":"The external customer id."},"name":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"name2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"name3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code"},"city":{"type":"string","description":"The city"},"countryCode":{"type":"string","description":"The country code"},"latLng":{"description":"The geo-coordinates","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonName":{"type":"string","description":"The contact person name (max. 255 characters)"},"contactPersonEmail":{"type":"string","description":"The contact person email (max. 255 characters)"},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number (max. 64 characters)"},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile phone number (max. 64 characters)"},"customerOrderReference":{"type":"string","description":"The customer order reference (max. 64 characters)"},"offerReference":{"type":"string","description":"The offer reference (max. 255 characters)"},"category":{"type":"integer","description":"The id of the order category. You need to provide this Parameter or the categoryExternalId."},"categoryExternalId":{"type":"string","description":"The external id of the order category (Used if category not provided)."},"type":{"type":"string","description":"| Values         |\n| -------------- |\n| PROJECT        |\n| CUSTOM_PROJECT |"},"project":{"type":"integer","description":"The id of the project."},"projectReferenceSign":{"type":"string","description":"The reference sign of the project (Used if project not provided)."},"createdAt":{"description":"When the order was created","type":"object","$ref":"#\/components\/schemas\/DateTime"},"provinceCode":{"type":"string","description":"The province Code."},"performanceFields":{"description":"","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderUpsertRequestOrderPerformanceFieldItem"},{"description":""}]}},"openingHours":{"description":"Example: {\u0022MO\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]]}","type":"object","$ref":"#\/components\/schemas\/DynamicWeekdayTime"},"planningType":{"type":"string","description":"Order Planning Type. (TRACKER, EMPLOYEE, RESOURCE_PLANNING)"},"assignedTrackerId":{"type":"integer","description":"Tracker to which the order is assigned. Only valid if planningType is TRACKER."},"assignedEmployeeId":{"type":"integer","description":"Employee to which the order is assigned. Only valid if planningType is EMPLOYEE."},"requiredQualifications":{"description":"The required qualifications for this order.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchQualificationResponseDispoQualificationListItem"},{"description":""}]}},"rejectQualifications":{"description":"The unwated qualifications for this order.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchQualificationResponseDispoQualificationListItem"},{"description":""}]}},"requireOneQualifications":{"description":"A list of qualifications for this order of which at least one is required.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchQualificationResponseDispoQualificationListItem"},{"description":""}]}}}},"OrderUpsertRequestOrderPerformanceFieldItem":{"type":"object","description":"","properties":{"name":{"type":"string","description":"The name of the performance field."},"value":{"type":"number","description":"The value of the performance field."}}},"DispoTypeFetchQualificationResponseDispoQualificationListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the qualification."},"name":{"type":"string","description":"The name of the qualification."},"createdAt":{"description":"The date the qualification was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"OrderUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                 |\n|----------------|-----------------------------|\n| id             | The internal order ID  |\n| reference      | geoCapture order number        |\n| external_reference     | Customer order number     |"},"data":{"description":"The order record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/OrderUpsertRequestRecordData"}}},"OrderUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order"},"reference":{"type":"string","description":"The internal reference for the order (max. 64 characters)"},"orderType":{"type":"string","description":"The order type. This parameter is optional. The allowed value and default is \u0027ORDER\u0027"},"externalReference":{"type":"string","description":"The customer order number (max. 64 characters)"},"status":{"type":"string","description":"The order state\n\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |"},"subject":{"type":"string","description":"Order subject (max. 255 characters)"},"text":{"type":"string","description":"Order description"},"orderDate":{"description":"The order date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"duration":{"type":"integer","description":"The order duration"},"priority":{"type":"string","description":"order priority\n\n| Value                        |\n| ------------------------     |\n| LOW                          |\n| NORMAL                       |\n| HIGH                         |"},"targetDate":{"description":"The order target date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"externalAddressId":{"type":"string","description":"The external customer id."},"name":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"name2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"name3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code"},"city":{"type":"string","description":"The city"},"countryCode":{"type":"string","description":"The country code"},"latLng":{"description":"The geo-coordinates","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonName":{"type":"string","description":"The contact person name (max. 255 characters)"},"contactPersonEmail":{"type":"string","description":"The contact person email (max. 255 characters)"},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number (max. 64 characters)"},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile phone number (max. 64 characters)"},"customerOrderReference":{"type":"string","description":"The customer order reference (max. 64 characters)"},"offerReference":{"type":"string","description":"The offer reference (max. 255 characters)"},"category":{"type":"integer","description":"The id of the order category. You need to provide this Parameter or the categoryExternalId."},"categoryExternalId":{"type":"string","description":"The external id of the order category (Used if category not provided)."},"type":{"type":"string","description":"| Values         |\n| -------------- |\n| PROJECT        |\n| CUSTOM_PROJECT |"},"project":{"type":"integer","description":"The id of the project."},"projectReferenceSign":{"type":"string","description":"The reference sign of the project (Used if project not provided)."},"createdAt":{"description":"When the order was created","type":"object","$ref":"#\/components\/schemas\/DateTime"},"provinceCode":{"type":"string","description":"The province Code."},"performanceFields":{"description":"","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderUpsertRequestOrderPerformanceFieldItem"},{"description":""}]}},"openingHours":{"description":"Example: {\u0022MO\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]]}","type":"object","$ref":"#\/components\/schemas\/DynamicWeekdayTime"},"planningType":{"type":"string","description":"Order Planning Type. (TRACKER, EMPLOYEE, RESOURCE_PLANNING)"},"assignedTrackerId":{"type":"integer","description":"Tracker to which the order is assigned. Only valid if planningType is TRACKER."},"assignedEmployeeId":{"type":"integer","description":"Employee to which the order is assigned. Only valid if planningType is EMPLOYEE."},"requiredQualificationIds":{"type":"array","items":{"type":"integer"},"description":"The required qualifications for this order."},"rejectQualificationIds":{"type":"array","items":{"type":"integer"},"description":"The unwated qualifications for this order."},"requireOneQualificationIds":{"type":"array","items":{"type":"integer"},"description":"A list of qualifications for this order of which at least one is required."}}},"StandardOrderUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all orders missing from this request? This Parameter is optional. (default=false)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardOrderCreateTransportResponse":{"type":"object","description":"","properties":{"data":{"description":"The created orders.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderCreateTransportRequestOrderItem"},{"description":""}]}}}},"OrderCreateTransportRequestOrderItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order"},"reference":{"type":"string","description":"The internal reference for the order (max. 64 characters)"},"orderType":{"type":"string","description":"The order type. This parameter is optional. The allowed value and default is \u0027ORDER\u0027"},"externalReference":{"type":"string","description":"The customer order number (max. 64 characters)"},"status":{"type":"string","description":"The order state\n\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |"},"subject":{"type":"string","description":"Order subject (max. 255 characters)"},"text":{"type":"string","description":"Order description"},"orderDate":{"description":"The order date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"duration":{"type":"integer","description":"The order duration"},"priority":{"type":"string","description":"order priority\n\n| Value                        |\n| ------------------------     |\n| LOW                          |\n| NORMAL                       |\n| HIGH                         |"},"targetDate":{"description":"The order target date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"externalAddressId":{"type":"string","description":"The external customer id."},"name":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"name2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"name3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code"},"city":{"type":"string","description":"The city"},"countryCode":{"type":"string","description":"The country code"},"latLng":{"description":"The geo-coordinates","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonName":{"type":"string","description":"The contact person name (max. 255 characters)"},"contactPersonEmail":{"type":"string","description":"The contact person email (max. 255 characters)"},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number (max. 64 characters)"},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile phone number (max. 64 characters)"},"customerOrderReference":{"type":"string","description":"The customer order reference (max. 64 characters)"},"offerReference":{"type":"string","description":"The offer reference (max. 255 characters)"},"category":{"type":"integer","description":"The id of the order category. You need to provide this Parameter or the categoryExternalId."},"categoryExternalId":{"type":"string","description":"The external id of the order category (Used if category not provided)."},"type":{"type":"string","description":"| Values         |\n| -------------- |\n| PROJECT        |\n| CUSTOM_PROJECT |"},"project":{"type":"integer","description":"The id of the project."},"projectReferenceSign":{"type":"string","description":"The reference sign of the project (Used if project not provided)."},"createdAt":{"description":"When the order was created","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"OrderCreateTransportRequestTransportOrderAddressDataItem":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The address type (depending on this either the attribute project or customProject has to be set).\n\n| Value            |\n| -------------- |\n| PROJECT        |\n| CUSTOM_PROJECT    |"},"customProject":{"description":"The address.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingAddressInterface"},"externalAddressId":{"type":"string","description":"An external id for the address."},"project":{"type":"integer","description":"The project id."}}},"StandardOrderCreateTransportRequest":{"type":"object","description":"","properties":{"order":{"description":"The order. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/OrderCreateTransportRequestOrderItem"},"pickupLocation":{"description":"The pickup address. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/OrderCreateTransportRequestTransportOrderAddressDataItem"},"deliveryLocation":{"description":"The delivery address. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/OrderCreateTransportRequestTransportOrderAddressDataItem"}}},"StandardOrderCreateRepeatResponse":{"type":"object","description":"","properties":{"data":{"description":"The created order.","type":"object","$ref":"#\/components\/schemas\/OrderCreateRepeatRequestOrderItem"}}},"OrderCreateRepeatRequestOrderItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order"},"reference":{"type":"string","description":"The internal reference for the order (max. 64 characters)"},"orderType":{"type":"string","description":"The order type. This parameter is optional. The allowed value and default is \u0027ORDER\u0027"},"externalReference":{"type":"string","description":"The customer order number (max. 64 characters)"},"status":{"type":"string","description":"The order state\n\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |"},"subject":{"type":"string","description":"Order subject (max. 255 characters)"},"text":{"type":"string","description":"Order description"},"orderDate":{"description":"The order date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"duration":{"type":"integer","description":"The order duration"},"priority":{"type":"string","description":"order priority\n\n| Value                        |\n| ------------------------     |\n| LOW                          |\n| NORMAL                       |\n| HIGH                         |"},"targetDate":{"description":"The order target date","type":"object","$ref":"#\/components\/schemas\/DateTime"},"externalAddressId":{"type":"string","description":"The external customer id."},"name":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"name2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"name3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code"},"city":{"type":"string","description":"The city"},"countryCode":{"type":"string","description":"The country code"},"latLng":{"description":"The geo-coordinates","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonName":{"type":"string","description":"The contact person name (max. 255 characters)"},"contactPersonEmail":{"type":"string","description":"The contact person email (max. 255 characters)"},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number (max. 64 characters)"},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile phone number (max. 64 characters)"},"customerOrderReference":{"type":"string","description":"The customer order reference (max. 64 characters)"},"offerReference":{"type":"string","description":"The offer reference (max. 255 characters)"},"category":{"type":"integer","description":"The id of the order category. You need to provide this Parameter or the categoryExternalId."},"categoryExternalId":{"type":"string","description":"The external id of the order category (Used if category not provided)."},"type":{"type":"string","description":"| Values         |\n| -------------- |\n| PROJECT        |\n| CUSTOM_PROJECT |"},"project":{"type":"integer","description":"The id of the project."},"projectReferenceSign":{"type":"string","description":"The reference sign of the project (Used if project not provided)."},"createdAt":{"description":"When the order was created","type":"object","$ref":"#\/components\/schemas\/DateTime"},"schedulerDefinition":{"description":"The scheduler definition.","type":"object","$ref":"#\/components\/schemas\/OrderCreateRepeatRequestSchedulerDefinition"},"schedulerStartDate":{"description":"The start date for the repeated orders.","type":"object","$ref":"#\/components\/schemas\/Date"},"schedulerEndDate":{"description":"The end date for the repeated orders.\n(Only one of schedulerEndDate and schedulerMaxRuns can be specified)","type":"object","$ref":"#\/components\/schemas\/Date"},"schedulerMaxRuns":{"type":"integer","description":"The maximum amount of runs for this order.\n(Only one of schedulerEndDate and schedulerMaxRuns can be specified)"}}},"StandardOrderCreateRepeatRequest":{"type":"object","description":"","properties":{"order":{"description":"The order. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/OrderCreateRepeatRequestOrderItem"}}},"StandardEmployeeAbsenceTypeFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The absence types.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAbsenceTypeFetchResponseEmployeeAbsenceTypeItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available approvals.\n(Only calculated if offset is 0)"}}},"EmployeeAbsenceTypeFetchResponseEmployeeAbsenceTypeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"name":{"type":"string","description":"The name of the absence."},"isVacation":{"type":"boolean","description":"Whether the absence is a holiday absence."},"externalId":{"type":"string","description":"The external ID of the absence type."},"salaryType":{"description":"The salary type of the absence type.","type":"object","$ref":"#\/components\/schemas\/EmployeeAbsenceTypeFetchResponseSalaryTypeItem"}}},"EmployeeAbsenceTypeFetchResponseSalaryTypeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal salary type ID."},"name":{"type":"string","description":"The name of the salary type."},"type":{"type":"string","description":"The salary type."},"isVacation":{"type":"boolean","description":"Whether the salary type is the holiday salary type."}}},"EmployeeAbsenceTypeFetchRequestEmployeeAbsenceTypeFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the absence types based on the IDs."},"byExternalIds":{"type":"array","items":{"type":"integer"},"description":"Filters the absence types based on the external id."}}},"StandardEmployeeAbsenceTypeFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The form data filter.","type":"object","$ref":"#\/components\/schemas\/EmployeeAbsenceTypeFetchRequestEmployeeAbsenceTypeFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardRoutingRouteResponse":{"type":"object","description":"","properties":{"distance":{"type":"number","description":"The distance of the route in meters."},"drivingTime":{"type":"number","description":"The duration of the route in seconds."}}},"StandardRoutingRouteRequest":{"type":"object","description":"","properties":{"startLatLng":{"description":"The geo-coordinates of the starting point of the route.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"endLatLng":{"description":"The geo-coordinates of the end point of the route.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"}}},"StandardCostBookingFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The list of cost bookings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/CostBookingFetchResponseCostBookingExportLogItem"},{"description":""}]}},"totalCount":{"type":"integer","description":"Total number of cost exports."}}},"CostBookingFetchResponseCostBookingExportLogItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the cost export."},"format":{"type":"string","description":"The format of the cost export."},"filter":{"description":"The filter of the cost export.","type":"object","$ref":"#\/components\/schemas\/StandardCostBookingBaseCostBookingExportLogFilterItem"},"createdAt":{"description":"The date the cost export was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardCostBookingBaseCostBookingExportLogFilterItem":{"type":"object","description":"","properties":{"from":{"description":"The filtered start date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"The filtered end date.","type":"object","$ref":"#\/components\/schemas\/Date"},"projectIds":{"type":"array","items":{"type":"integer"},"description":"The filtered projects."},"costSources":{"type":"array","items":{"type":"string"},"description":"The filtered cost sources."},"costTypeIds":{"type":"array","items":{"type":"integer"},"description":"The filtered cost type IDs."},"trackerCategoryIds":{"type":"array","items":{"type":"integer"},"description":"The filtered tracker category IDs."},"departmentIds":{"type":"array","items":{"type":"integer"},"description":"The filtered department IDs."},"toolCategoryIds":{"type":"array","items":{"type":"integer"},"description":"The filtered tool category IDs."}}},"CostBookingFetchRequestCostBookingFilter":{"type":"object","description":"","properties":{"fromDate":{"description":"Filters the cost exports based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"toDate":{"description":"Filters the cost exports based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardCostBookingFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The cost booking filter.","type":"object","$ref":"#\/components\/schemas\/CostBookingFetchRequestCostBookingFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardCostBookingCreateExportResponse":{"type":"object","description":"","properties":{"data":{"description":"The cost export log item.","type":"object","$ref":"#\/components\/schemas\/CostBookingCreateExportResponseCostBookingExportLogItem"},"jobId":{"type":"integer","description":"The id of the cost export job. (The status of the job can be queried via the job API)"}}},"CostBookingCreateExportResponseCostBookingExportLogItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the cost export."},"format":{"type":"string","description":"The format of the cost export."},"filter":{"description":"The filter of the cost export.","type":"object","$ref":"#\/components\/schemas\/StandardCostBookingBaseCostBookingExportLogFilterItem"},"createdAt":{"description":"The date the cost export was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"CostBookingCreateExportRequestCostBookingExportLogFilter":{"type":"object","description":"","properties":{"byCostTypeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the cost bookings based on the cost type IDs."},"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the cost bookings based on the project IDs."},"byDepartmentIds":{"type":"array","items":{"type":"integer"},"description":"Filters the cost bookings based on the department IDs."},"byVehicleCategoryIds":{"type":"array","items":{"type":"integer"},"description":"Filters the cost bookings based on the vehicle category IDs."},"byToolCategoryIds":{"type":"array","items":{"type":"integer"},"description":"Filters the cost bookings based on the tool category IDs."},"byCostSources":{"type":"array","items":{"type":"string"},"description":"Filters the cost bookings based on the cost sources.\n| MATERIAL |\n| MACHINE |\n| EMPLOYEE |\n| TOOL |"},"from":{"description":"Filters the cost bookings based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the cost bookings based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"CostBookingCreateExportRequestCostBookingExportLogGroupBy":{"type":"object","description":"","properties":{"groupByField1":{"type":"string","description":"Group by for certain exports (CATEGORY_GROUPED_CSV, PDF).\n\n | Value |\n | ----- |\n | POSITION |\n | POSITION_GROUP |\n | DATE |\n | MONTH |\n | YEAR |\n | WEEK |\n | PROJECT |\n | PROJECT_COST_CENTER |\n | PROJECT_CATEGORY |"},"groupByField2":{"type":"string","description":"Group by for certain exports (CATEGORY_GROUPED_CSV, PDF).\n\n | Value |\n | ----- |\n | POSITION |\n | POSITION_GROUP |\n | DATE |\n | MONTH |\n | YEAR |\n | WEEK |\n | PROJECT |\n | PROJECT_COST_CENTER |\n | PROJECT_CATEGORY |"},"groupByField3":{"type":"string","description":"Group by for certain exports (CATEGORY_GROUPED_CSV, PDF).\n\n | Value |\n | ----- |\n | POSITION |\n | POSITION_GROUP |\n | DATE |\n | MONTH |\n | YEAR |\n | WEEK |\n | PROJECT |\n | PROJECT_COST_CENTER |\n | PROJECT_CATEGORY |"}}},"StandardCostBookingCreateExportRequest":{"type":"object","description":"","properties":{"filter":{"description":"Filters the cost bookings for this export.","type":"object","$ref":"#\/components\/schemas\/CostBookingCreateExportRequestCostBookingExportLogFilter"},"groupBy":{"description":"Groups cost bookings for this export.","type":"object","$ref":"#\/components\/schemas\/CostBookingCreateExportRequestCostBookingExportLogGroupBy"},"format":{"type":"string","description":"The export format.\n\n| Value | Description |\n| ----- | ----------- |\n| CSV | Simple csv file |\n| DATAFLOR | Dataflor xml format |\n| CATEGORY_GROUPED_CSV | Grouped csv file |\n| PDF | Grouped pdf file |\n| BRZ_TIME_SHEETS | BRZ csv file |\n| SBS | SBS xml file |"},"mark_as_exported":{"type":"boolean","description":"Whether the exported cost booking should be marked as exported or not.\nDefault value is true."}}},"StandardCostBookingStartExportResponse":{"type":"object","description":"","properties":{"jobId":{"type":"integer","description":"The id of the cost export job. (The status of the job can be queried via the job API)"}}},"StandardCostBookingStartExportRequest":{"type":"object","description":"","properties":{"exportId":{"type":"integer","description":"The cost export ID."}}},"StandardCostBookingFetchExportDataRequest":{"type":"object","description":"","properties":{"jobId":{"type":"integer","description":"The job id for the cost export."}}},"StandardCustomFormDataFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The form data.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFormDataFetchResponseCustomFormDataItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available form data.\n(Only calculated if offset is 0)"}}},"CustomFormDataFetchResponseCustomFormDataItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"name":{"type":"string","description":"Name of the form"},"latLng":{"description":"Coordinates of the Location the form was filled out.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"status":{"type":"string","description":"Status of the form.\n\n | Value      | Description                           |\n |------------|---------------------------------------|\n | NEW        | Freshly created                       |\n | FILLED     | Filled out form                       |\n | REVIEW     | Approval pending                      |\n | APPROVED   | Approved via associated approval rule |\n | COMPLETED  | Manually approved via user            |\n | REJECTED   | Rejected via associated approval rule |\n | RESET      | Approval reverted                     |\n | DELETED    | Deleted                               |"},"createdAt":{"description":"Form data creation date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"project":{"description":"Form\u0027s project.","type":"object","$ref":"#\/components\/schemas\/StandardCustomFormDataBaseProjectItem"},"employee":{"description":"Form\u0027s employee.","type":"object","$ref":"#\/components\/schemas\/StandardCustomFormDataBaseEmployeeItem"},"definitionVersion":{"type":"integer","description":"Version of the form definition."},"employees":{"description":"Form\u0027s employees.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataBaseEmployeeItem"},{"description":""}]}},"trackers":{"description":"Form\u0027s vehicles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataBaseTrackerItem"},{"description":""}]}},"beacons":{"description":"Form\u0027s beacons.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataBaseBeaconItem"},{"description":""}]}},"countMediaData":{"type":"integer","description":"Count of form\u0027s media data."}}},"StandardCustomFormDataBaseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"}}},"StandardCustomFormDataBaseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."}}},"StandardCustomFormDataBaseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"}}},"StandardCustomFormDataBaseBeaconItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"uuid":{"type":"string","description":"The beacon UUID as hexadecimal value."},"macAddress":{"type":"string","description":"The beacon MAC address."},"name":{"type":"string","description":"The name of the beacon. (max. 255 characters)"},"objectIdentifier":{"type":"string","description":"External, customer specific ID of the object the beacon is attached to. (max. 64 characters)"},"objectSerialNumber":{"type":"string","description":"Serial number of object, the beacon is attached to. (max. 128 characters)"}}},"CustomFormDataFetchRequestCustomFormDataFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal IDs."},"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on in internal project IDs."},"byEmployeeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal employee IDs."},"byTrackerIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal vehicle IDs."},"byBeaconIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal beacon IDs."},"byText":{"type":"string","description":"Filters the form data based on the text passed."},"byFormDefinitionIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the form definition IDs."},"byExternalReference":{"type":"string","description":"Filters the form data based on the external reference."},"byStatus":{"type":"string","description":"Filters the form data based on the status.\n\n| Value     | Description                  |\n| --------- | ---------------------------- |\n| NEW       | New form data                |\n| FILLED    | Already filled form data     |\n| REVIEW    | Check form data              |\n| APPROVED  | Approved by test distributor |\n| COMPLETED | Completed form data          |\n| RESET     | Resetted form data           |\n| BOOKED    | Booked form data             |"},"byOrderIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the order IDs."},"from":{"description":"Filters the form data based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filters the form data based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"byBounds":{"description":"Filters the form data based on the given rectangle","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"}}},"StandardCustomFormDataFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The form data filter.","type":"object","$ref":"#\/components\/schemas\/CustomFormDataFetchRequestCustomFormDataFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardCustomFormDataFetchDataResponse":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"customFormId":{"type":"string","description":"The internal ID."},"name":{"type":"string","description":"Name of the form"},"latLng":{"description":"Coordinates of the Location the form was filled out.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"status":{"type":"string","description":"Status of the form.\n\n | Value      | Description                           |\n |------------|---------------------------------------|\n | NEW        | Freshly created                       |\n | FILLED     | Filled out form                       |\n | REVIEW     | Approval pending                      |\n | APPROVED   | Approved via associated approval rule |\n | COMPLETED  | Manually approved via user            |\n | REJECTED   | Rejected via associated approval rule |\n | RESET      | Approval reverted                     |\n | DELETED    | Deleted                               |"},"createdAt":{"description":"Form data creation date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"project":{"description":"Form\u0027s project.","type":"object","$ref":"#\/components\/schemas\/StandardCustomFormDataBaseProjectItem"},"employee":{"description":"Form\u0027s employee.","type":"object","$ref":"#\/components\/schemas\/StandardCustomFormDataBaseEmployeeItem"},"definitionVersion":{"type":"integer","description":"Version of the form definition."},"data":{"type":"array","items":{"type":"integer"},"description":"The form\u0027s values as a JSON Object."}}},"StandardCustomFormDataFetchDataRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the form data. This Parameter is required."},"log_access":{"type":"boolean","description":"Log the access in the changelog."}}},"StandardCustomFormDataPdfRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID of the form data. This Parameter is required."},"log_access":{"type":"boolean","description":"Log the access in the changelog."},"export_base64":{"type":"boolean","description":"Export the file as a base64 encoded string."}}},"StandardCustomFormDataLogResponse":{"type":"object","description":"","properties":{"data":{"description":"Changelog.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFormDataLogResponseCustomFormDataChangelogItem"},{"description":""}]}}}},"CustomFormDataLogResponseCustomFormDataChangelogItem":{"type":"object","description":"","properties":{"action":{"type":"string","description":"Action that was performed on the form\n\n| Value                    |\n| ------------------------ |\n| CREATE                   |\n| UPDATE                   |\n| VIEW                     |\n| COMPLETED                |\n| SENT                     |\n| BOOK                     |\n| RESET                    |"},"updatedAt":{"description":"Date of the action","type":"object","$ref":"#\/components\/schemas\/DateTime"},"payload":{"type":"array","items":{"type":"integer"},"description":"Additional information"},"user":{"type":"string","description":"User that performed the action"}}},"StandardCustomFormDataLogRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the form data. This Parameter is required."},"from":{"description":"Filters the form log data based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filters the form log data based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardCustomFormDataMediaResponse":{"type":"object","description":"","properties":{"files":{"description":"The found images.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFormDataMediaResponseCustomFormDataMediaListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available media files."}}},"CustomFormDataMediaResponseCustomFormDataMediaListItem":{"type":"object","description":"","properties":{"customFormDataId":{"type":"integer","description":"The internal id of the form data."},"filename":{"type":"string","description":"The filename of the image."}}},"CustomFormDataMediaRequestCustomFormDataFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal IDs."},"byProjectIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on in internal project IDs."},"byEmployeeIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal employee IDs."},"byTrackerIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal vehicle IDs."},"byBeaconIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the internal beacon IDs."},"byText":{"type":"string","description":"Filters the form data based on the text passed."},"byFormDefinitionIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the form definition IDs."},"byExternalReference":{"type":"string","description":"Filters the form data based on the external reference."},"byStatus":{"type":"string","description":"Filters the form data based on the status.\n\n| Value     | Description                  |\n| --------- | ---------------------------- |\n| NEW       | New form data                |\n| FILLED    | Already filled form data     |\n| REVIEW    | Check form data              |\n| APPROVED  | Approved by test distributor |\n| COMPLETED | Completed form data          |\n| RESET     | Resetted form data           |\n| BOOKED    | Booked form data             |"},"byOrderIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form data based on the order IDs."},"from":{"description":"Filters the form data based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filters the form data based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"byBounds":{"description":"Filters the form data based on the given rectangle","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"}}},"StandardCustomFormDataMediaRequest":{"type":"object","description":"","properties":{"filter":{"description":"The form data filter.","type":"object","$ref":"#\/components\/schemas\/CustomFormDataMediaRequestCustomFormDataFilter"},"fieldName":{"type":"string","description":"Fieldname of the form."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with default value set at 50 records."},"offset":{"type":"integer","description":"Number of media data to be skipped."}}},"StandardCustomFormDataMediaDataRequest":{"type":"object","description":"","properties":{"formDataId":{"type":"integer","description":"The internal id of the form data. This Parameter is required."},"filename":{"type":"string","description":"The filename. This Parameter is required."}}},"StandardCustomFormDataStatusResponse":{"type":"object","description":"","properties":{"data":{"type":"string","description":"response."}}},"StandardCustomFormDataStatusRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the form data. This Parameter is required."},"status_text":{"type":"string","description":"Status of the form. This Parameter is required.\n\n| Value     |\n| --------- |\n| COMPLETED |\n| BOOKED    |"}}},"StandardCostDistributionHistoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tracker cost settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostDistributionHistoryBaseCostDistributionHistoryItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tracker cost settings."}}},"StandardCostDistributionHistoryBaseCostDistributionHistoryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tracker cost setting."},"tracker":{"description":"The tracker that this setting is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardCostDistributionHistoryBaseTrackerItem"},"trackerCategory":{"description":"The tracker category that this setting is assigned to or the historic tracker category for the tracker if a\ntracker is given.","type":"object","$ref":"#\/components\/schemas\/StandardTrackerCategoryBaseTrackerCategoryListItem"},"costTypeSource":{"type":"string","description":"The source of the cost type."},"costType":{"type":"string","description":"The cost type."},"costDistribution":{"type":"string","description":"The cost distribution."},"logisticsKmDistribution":{"type":"string","description":"The distribution of costs to projects for the day."},"logisticsKmRate":{"type":"number","description":"The costs per kilometer."},"logisticsHourlyRate":{"type":"number","description":"The costs per operating hour."},"logisticsDailyRate":{"type":"number","description":"A fixed cost amount per day."},"machineHourlyRate":{"type":"number","description":"The costs per operating hour."},"machineDailyRate":{"type":"number","description":"A fixed cost amount per day."},"machineTransportDayDistribution":{"type":"string","description":"The cost distribution for transport days."},"from":{"description":"The first day from which the new cost configuration is valid.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"The last day from which the new cost configuration is valid.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardCostDistributionHistoryBaseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"description":{"type":"string","description":"The vehicle description."},"driverName":{"type":"string","description":"The driver name. (max. 255 characters)"},"driverPhoneNumber":{"type":"string","description":"The driver phone number. (max. 255 characters)"},"costCenter":{"type":"string","description":"The cost center. (max. 25 characters)"},"serialNumber":{"type":"string","description":"The serial number of the vehicle."},"manufacturingDate":{"description":"The manufacturing date of the vehicle.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"CostDistributionHistoryFetchRequestCostDistributionHistoryFilter":{"type":"object","description":"","properties":{"byTrackerId":{"type":"integer","description":"Filters the tracker cost settings based on the tracker id.\nOnly one filter will be applied."},"byTrackerCategoryId":{"type":"integer","description":"Filters the tracker cost settings based on the tracker category id.\nOnly one filter will be applied."}}},"StandardCostDistributionHistoryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The tracker cost setting filter.","type":"object","$ref":"#\/components\/schemas\/CostDistributionHistoryFetchRequestCostDistributionHistoryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardCostDistributionHistoryUpsertResponse":{"type":"object","description":"","properties":{"createdTrackerCostSettings":{"description":"The created tracker cost settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostDistributionHistoryBaseCostDistributionHistoryItem"},{"description":""}]}}}},"CostDistributionHistoryUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal tracker cost setting ID |"},"data":{"description":"The tracker cost setting record.","type":"object","$ref":"#\/components\/schemas\/CostDistributionHistoryUpsertRequestRecordData"}}},"CostDistributionHistoryUpsertRequestRecordData":{"type":"object","description":"","properties":{"trackerId":{"type":"integer","description":"The internal id of the tracker if the setting is meant to be for a tracker."},"trackerCategoryId":{"type":"integer","description":"The internal id of the tracker category if the setting is meant to be for a tracker category."},"costTypeSource":{"type":"string","description":"The source for the cost type.\n\n| Value | Description |\n|------|-------------|\n| COST_TYPE | cost type is defined at this entry |\n| VEHICLE_CATEGORY | cost type is defined at the tracker category |\n\nThe value \u0022VEHICLE_CATEGORY\u0022 can only be set if a trackerId is given. This will link the settings cost type to\nthe one of the trackers category. If a trackerId is given the value can also be set to \u0022COST_TYPE\u0022. This will\nset the cost type for this specific tracker. In that case a costTypeId\/costTypeReference also has to be given.\nFor a tracker category this value is obsolete."},"costTypeId":{"type":"integer","description":"The internal cost type id for this setting.\nValue is needed for settings if a trackerCategoryId is given or the costTypeSource is set to \u0022COST_TYPE\u0022.\nEither costTypeId or costTypeReference can be supplied."},"costTypeReference":{"type":"integer","description":"The cost type reference for this setting.\nValue is needed for settings if a trackerCategoryId is given or the costTypeSource is set to \u0022COST_TYPE\u0022.\nEither costTypeId or costTypeReference can be supplied."},"costDistribution":{"type":"string","description":"The cost distribution.\n\n| Value                    | Description                             |\n|--------------------------|-----------------------------------------|\n| VEHICLE_CATEGORY         | Take the value of the tracker category |\n| LOGISTICS                | Distribute as a logistics vehicle. Supply fields |\n|| costDistributionLogisticsKmToProject, costDistributionLogisticsKm and costDistributionLogisticsOperatingHour |\n| MACHINE                  | Distribute as a machine vehicle. Supply fields costDistributionMachineHour, |\n|| costDistributionMachineDay and costDistributionMachineTransportDay |"},"logisticsKmDistribution":{"type":"string","description":"The distribution of costs to projects for the day.\nOnly supply if costDistribution = LOGISTICS.\n\n| Value                    | Description                             |\n|--------------------------|-----------------------------------------|\n| DURATION                  | Distribution according to the duration of the stops at the projects |\n| AMOUNT                      | Distribution equally for each project |\n| DRIVE                      | Distribute costs by project approached |"},"logisticsKmRate":{"type":"number","description":"The costs per kilometer.\nOnly supply if costDistribution = LOGISTICS."},"logisticsHourlyRate":{"type":"number","description":"The costs per operating hour.\nOnly supply if costDistribution = LOGISTICS."},"logisticsDailyRate":{"type":"number","description":"The costs per day.\nOnly supply if costDistribution = LOGISTICS."},"machineHourlyRate":{"type":"number","description":"The costs per operating hour.\nOnly supply if costDistribution = MACHINE."},"machineDailyRate":{"type":"number","description":"A fixed cost amount per day.\nOnly supply if costDistribution = MACHINE."},"machineTransportDayDistribution":{"type":"string","description":"The cost distribution for transport days.\nOnly supply if costDistribution = MACHINE.\n\n| Value                    | Description                             |\n|--------------------------|-----------------------------------------|\n| IGNORE                   | transport days will be ignored            |\n| FULL_DAY                 | Destination gets full costs            |\n| HALF_DAY                 | Costs will be split between start and destination |"},"automaticBooking":{"type":"boolean","description":"This value indicates whether this setting should be used to create automatic bookings.\nCan be set to false if this setting is supposed to be used for form data bookings."},"fallbackProjectId":{"type":"integer","description":"This project will be used for cost bookings that have no assigned project."},"releaseOnInactivity":{"type":"boolean","description":"This setting will prevent empty bookings for days where this tracker has no events."},"operatingHourSource":{"type":"string","description":"The source for the operating hours.\nOnly supply if costDistribution = LOGISTICS.\n\n| Value | Description |\n|------|-------------|\n| SHIFT_TIME | time from the first till the last event for the day |\n| DRIVE_TIME | Sum of the movement events |"},"minDuration":{"type":"number","description":"The minimum duration (in s) for an event to be used for the calculation."},"minDistance":{"type":"number","description":"The minimum distance (in m) for an event to be used for the calculation.\nOnly supply if costDistribution = LOGISTICS."},"from":{"description":"The first day from which the new cost configuration is valid.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardCostDistributionHistoryUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The tracker cost setting data.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/CostDistributionHistoryUpsertRequestRecord"},{"description":""}]}},"startCostCalculation":{"type":"boolean","description":"If true a cost calculation will be started from the start date of this setting on."},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardProjectTimesFetchResponse":{"type":"object","description":"","properties":{"employeeWorkActivities":{"description":"Employee work activities.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectTimesFetchResponseEmployeeWorkActivity"},{"description":""}]}},"trackerWorkActivities":{"description":"Tracker operating activities.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectTimesFetchResponseTrackerWorkActivity"},{"description":""}]}},"trackerVisitActivities":{"description":"Tracker visit activities.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectTimesFetchResponseTrackerVisitActivity"},{"description":""}]}},"accountingEntries":{"description":"Accounting entries.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectTimesFetchResponseEmployeeAccountingEntryItem"},{"description":""}]}}}},"ProjectTimesFetchResponseEmployeeWorkActivity":{"type":"object","description":"","properties":{"employee":{"description":"The employee.","type":"object","$ref":"#\/components\/schemas\/ProjectTimesFetchResponseEmployeeItem"},"startTime":{"description":"The start time.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"duration":{"type":"integer","description":"The duration."},"salaryType":{"type":"string","description":"The salary type of the activity."}}},"ProjectTimesFetchResponseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."}}},"ProjectTimesFetchResponseTrackerWorkActivity":{"type":"object","description":"","properties":{"tracker":{"description":"The vehicle.","type":"object","$ref":"#\/components\/schemas\/ProjectTimesFetchResponseTrackerItem"},"startTime":{"description":"The start time.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"startLatLng":{"description":"The stat coordinate.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"endTime":{"description":"The end time.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endLatLng":{"description":"The end coordinate.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"duration":{"type":"integer","description":"The duration."}}},"ProjectTimesFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"}}},"ProjectTimesFetchResponseTrackerVisitActivity":{"type":"object","description":"","properties":{"tracker":{"description":"The vehicle.","type":"object","$ref":"#\/components\/schemas\/ProjectTimesFetchResponseTrackerItem"},"startTime":{"description":"The start time.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"duration":{"type":"integer","description":"The duration."}}},"ProjectTimesFetchResponseEmployeeAccountingEntryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal accounting entry ID."},"date":{"description":"The date of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/Date"},"description":{"type":"string","description":"The description of the accounting entry."},"salaryType":{"type":"string","description":"The salary type of the accounting entry."},"value":{"type":"number","description":"The value of the accounting entry."},"valueUnit":{"type":"string","description":"The value unit of the accounting entry.\n\n| Value                     |  Description                           |\n| ------------------------- | -------------------------------------- |\n| HOUR                      | Hours                                  |\n| DAY                       | Days                                   |\n| CURRENCY                  | Currency                               |\n| QUANTITY                  | Quantity                               |"},"employee":{"description":"The employee","type":"object","$ref":"#\/components\/schemas\/ProjectTimesFetchResponseEmployeeItem"}}},"StandardProjectTimesFetchRequest":{"type":"object","description":"","properties":{"projectReference":{"type":"string","description":"The project number. Either this parameter or projectImportKey is required."},"projectImportKey":{"type":"string","description":"The project import key. Either this parameter or projectReference is required."},"from":{"description":"Start date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"End date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardJobFetchStatusResponse":{"type":"object","description":"","properties":{"data":{"description":"The Job.","type":"object","$ref":"#\/components\/schemas\/JobFetchStatusRequestJobItem"}}},"JobFetchStatusRequestJobItem":{"type":"object","description":"","properties":{"status":{"type":"string","description":"The Job status.\n\n| Value             | Description                                                           |\n|-------------------|-----------------------------------------------------------------------|\n| WAITING           | The job is waiting in the queue and is not started yet.               |\n| STARTING          | The job is getting started by the jobmanager but not running yet.     |\n| RUNNING           | The job is currently running.                                         |\n| SUCCESS           | The job is succesfully finished.                                      |\n| ERROR             | The job exited with an error.                                         |"},"returnValue":{"type":"array","items":{"type":"integer"},"description":"The return value of the job."},"progress":{"type":"number","description":"The progress of the job."},"startedAt":{"description":"The start time of the job.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"finishedAt":{"description":"The end time of the job.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardJobFetchStatusRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the job. This Parameter is required."}}},"StandardBeaconFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The Beacons.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BeaconFetchResponseBeaconItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available beacons.\n(Calculated only if the offset is 0)"}}},"BeaconFetchResponseBeaconItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"uuid":{"type":"string","description":"The beacon UUID as hexadecimal value."},"macAddress":{"type":"string","description":"The beacon MAC address."},"name":{"type":"string","description":"The name of the beacon. (max. 255 characters)"},"objectIdentifier":{"type":"string","description":"External, customer specific ID of the object the beacon is attached to. (max. 64 characters)"},"objectSerialNumber":{"type":"string","description":"Serial number of object, the beacon is attached to. (max. 128 characters)"},"protocol":{"type":"string","description":"Thee beacon protocol."},"serialNumber":{"type":"string","description":"The serial number of the beacon."},"batteryPercentage":{"type":"integer","description":"The beacon\u0027s battery charge in percent."},"status":{"type":"string","description":"The current status of the beacon.\n\n| Value                | Description         |\n|---------------------|---------------------|\n| DEACTIVATED         | The beacon is deactivated.                                                      |\n| LOST                | The Beacon is reported lost.           |\n| FOUND               | The Beacon was reported lost but has now been found.        |\n| DRIVING             | The beacon is transported in a vehicle.                                 |\n| HALT                | The beacon is not connected to any project or gateway                                   |\n| HALT_AT_GATEWAY     | The beacon is at a gateway. The gateway is the currentTracker.              |\n| HALT_AT_PROJECT     | The Beacon is at a project.                                              |"},"currentLoss":{"description":"The current loss of the Beacon.","type":"object","$ref":"#\/components\/schemas\/BeaconFetchResponseBeaconLossItem"},"currentProject":{"description":"The current project.","type":"object","$ref":"#\/components\/schemas\/BeaconFetchResponseProjectItem"},"multipleProjectsPossible":{"type":"boolean","description":"Indicates if multiple current projects were possible."},"currentTracker":{"description":"The current vehicle\/gateway of the beacon.","type":"object","$ref":"#\/components\/schemas\/BeaconFetchResponseTrackerItem"},"latLng":{"description":"The current position of the beacon.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"estimatedLatLng":{"description":"The estimated position of the beacon.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"estimatedTracker":{"description":"The vehicle from which the estimated position of the beacon originates.","type":"object","$ref":"#\/components\/schemas\/BeaconFetchResponseTrackerItem"},"temperature":{"type":"number","description":"The current outside temperature."},"lastSignalAt":{"description":"Time of the last signal.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"estimatedLastSignalAt":{"description":"Time of the estimated position.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"BeaconFetchResponseBeaconLossItem":{"type":"object","description":"","properties":{"description":{"type":"string","description":"Description of the loss."},"lastTracker":{"description":"The last signal was received from this vehicle.","type":"object","$ref":"#\/components\/schemas\/BeaconFetchResponseTrackerItem"},"lastLatLng":{"description":"Last position of the beacon.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"lostAt":{"description":"The time of the loss.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"BeaconFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"}}},"BeaconFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"}}},"BeaconFetchRequestBeaconFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the beacons based on the IDs."},"byUuids":{"type":"array","items":{"type":"string"},"description":"Filters the beacons based on the UUIDs."},"byToolIds":{"type":"array","items":{"type":"string"},"description":"Filters the beacons based on the tool IDs."}}},"StandardBeaconFetchRequest":{"type":"object","description":"","properties":{"beacons":{"description":"The beacon filter. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/BeaconFetchRequestBeaconFilter"},"offset":{"type":"integer","description":"Number of records to skip. This Parameter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This Parameter is optional."}}},"StandardBeaconUpdateResponse":{"type":"object","description":"","properties":{"updatedBeacons":{"description":"The changed beacons.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BeaconUpdateResponseBeaconItem"},{"description":""}]}}}},"BeaconUpdateResponseBeaconItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"uuid":{"type":"string","description":"The beacon UUID as hexadecimal value."},"macAddress":{"type":"string","description":"The beacon MAC address."}}},"BeaconUpdateRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal beacon ID      |\n| uuid           | The UUID                    |"},"data":{"description":"The beacon record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/BeaconUpdateRequestRecordData"}}},"BeaconUpdateRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"uuid":{"type":"string","description":"The beacon UUID as hexadecimal value."},"macAddress":{"type":"string","description":"The beacon MAC address."},"name":{"type":"string","description":"The name of the beacon. (max. 255 characters)"},"objectIdentifier":{"type":"string","description":"External, customer specific ID of the object the beacon is attached to. (max. 64 characters)"},"objectSerialNumber":{"type":"string","description":"Serial number of object, the beacon is attached to. (max. 128 characters)"}}},"StandardBeaconUpdateRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is required.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BeaconUpdateRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardEmployeeTimeTrackingFetchResponse":{"type":"object","description":"","properties":{"timeSheet":{"description":"The time sheet.","type":"object","$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseEmployeeTimeSheetItem"},"timeAccountBalance":{"type":"integer","description":"The time account at the time of the last monthly closing before the end date."},"vacationBalance":{"type":"integer","description":"The vacation balance at the time of the last monthly closing before the end date."},"accountBalanceDate":{"description":"The date of the monthly closing before the end date.","type":"object","$ref":"#\/components\/schemas\/Date"},"lastAccountBalanceDate":{"description":"The date of the last monthly closing.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"EmployeeTimeTrackingFetchResponseEmployeeTimeSheetItem":{"type":"object","description":"","properties":{"employee":{"description":"The employee.","type":"object","$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseEmployeeItem"},"from":{"description":"Start date of the time sheet.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"End date of the time sheet.","type":"object","$ref":"#\/components\/schemas\/Date"},"days":{"description":"Days of the time sheet.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseEmployeeTimeSheetDayItem"},{"description":""}]}},"targetWorktime":{"type":"integer","description":"Target worktime."},"worktime":{"type":"integer","description":"Worktime."},"paidWorktime":{"type":"integer","description":"Paid worktime."},"actualWorktime":{"type":"integer","description":"The rounded worktime without absences, holidays and accounting entries."},"absentWorktime":{"type":"integer","description":"The worktime created by absences."},"absentPaidWorktime":{"type":"integer","description":"The paid worktime created by absences."},"accountingWorktime":{"type":"integer","description":"The worktime created by accounting entries."},"accountingPaidWorktime":{"type":"integer","description":"The paid worktime created by accounting entries."},"holidayWorktime":{"type":"integer","description":"The worktime created by holidays."},"stampedWorktime":{"type":"integer","description":"The worktime created by time stamping."},"breakDuration":{"type":"integer","description":"The break time."},"driveWorktime":{"type":"integer","description":"The worktime created by driving rules."},"driveDuration":{"type":"integer","description":"The drive time determined by driving rules."},"driveDistance":{"type":"integer","description":"The drive distance determined by driving rules."},"setupTimeWorktime":{"type":"integer","description":"The worktime within the set-up time."},"setupTimeDuration":{"type":"integer","description":"The set-up time."},"overtime":{"type":"integer","description":"The overtime."},"roundingDifference":{"type":"integer","description":"The time difference after the overtime rounding."},"subtractedOvertime":{"type":"integer","description":"The subtracted time due to the agreed overtime.\nThis value is filled only when a full month is evaluated."}}},"EmployeeTimeTrackingFetchResponseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."}}},"EmployeeTimeTrackingFetchResponseEmployeeTimeSheetDayItem":{"type":"object","description":"","properties":{"date":{"description":"The date.","type":"object","$ref":"#\/components\/schemas\/Date"},"timeRecords":{"description":"","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseEmployeeTimeRecordItem"},{"description":""}]}},"driveClassifications":{"description":"","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseDriveClassificationItem"},{"description":""}]}},"absences":{"description":"","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseEmployeeAbsenceItem"},{"description":""}]}},"accountingEntries":{"description":"","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseEmployeeAccountingEntryItem"},{"description":""}]}},"isHoliday":{"type":"boolean","description":"Holiday"},"shiftStart":{"description":"Shift start","type":"object","$ref":"#\/components\/schemas\/DateTime"},"shiftEnd":{"description":"Shift end","type":"object","$ref":"#\/components\/schemas\/DateTime"},"targetWorktime":{"type":"integer","description":"Target worktime"},"worktime":{"type":"integer","description":"Worktime"},"paidWorktime":{"type":"integer","description":"Paid worktime"},"actualWorktime":{"type":"integer","description":"Rounded worktime without absences, holidays and accounting entries."},"absentWorktime":{"type":"integer","description":"The worktime created by absences."},"absentPaidWorktime":{"type":"integer","description":"The paid worktime created by absences."},"accountingWorktime":{"type":"integer","description":"The worktime created by accounting entries."},"accountingPaidWorktime":{"type":"integer","description":"The paid worktime created by accounting entries."},"holidayWorktime":{"type":"integer","description":"The worktime created by holidays."},"stampedWorktime":{"type":"integer","description":"The worktime created by time stamping."},"breakDuration":{"type":"integer","description":"The break time."},"driveWorktime":{"type":"integer","description":"The worktime created by driving rules."},"driveDuration":{"type":"integer","description":"The drive time determined by driving rules."},"driveDistance":{"type":"integer","description":"The drive distance determined by driving rules."},"setupTimeWorktime":{"type":"integer","description":"The worktime within the set-up time."},"setupTimeDuration":{"type":"integer","description":"The set-up time."},"overtime":{"type":"integer","description":"The overtime."},"roundingDifference":{"type":"integer","description":"The time difference after the overtime rounding."}}},"EmployeeTimeTrackingFetchResponseEmployeeTimeRecordItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal time record ID."},"date":{"description":"The date of the time record.","type":"object","$ref":"#\/components\/schemas\/Date"},"type":{"type":"string","description":"The type of the time record.\n\n| Value                     |  Description                          |\n| ------------------------- | ------------------------------------- |\n| WORK                      | Work                                  |\n| BREAK                     | Break                                 |"},"salaryType":{"type":"string","description":"The salarytype of the time record."},"startTime":{"description":"The start time of the time record.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time of the time record.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"worktime":{"type":"integer","description":"The work time of the time record."},"breakDuration":{"type":"integer","description":"The break time of the time record."},"project":{"description":"The break time of the time pair.","type":"object","$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseProjectItem"},"isApproved":{"type":"boolean","description":"Shows if the time pair is approved."}}},"EmployeeTimeTrackingFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"}}},"EmployeeTimeTrackingFetchResponseDriveClassificationItem":{"type":"object","description":"","properties":{"driveType":{"type":"string","description":"The Drive Type.\n\nClassifies the type of drive activity:\n- ARRIVAL: Drive to the work location\n- DEPARTURE: Drive away from the work location\n- MOVE: Drive between locations during working hours"},"distance":{"type":"integer","description":"The driving distance.\n\nTotal distance traveled in meters."},"worktime":{"type":"integer","description":"The working time in hours.\n\nTime spent driving that counts towards working hours."},"totalWorktime":{"type":"integer","description":"The total working time in hours.\n\nAggregate of all working time for this drive classification."},"drives":{"description":"All drive records associated with this classification.\n\nCollection of individual drive instances that belong to this classification.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseTimeSheetDriveItem"},{"description":""}]}},"durationPassenger":{"type":"integer","description":"The duration as passenger in seconds.\n\nTotal time spent as a passenger during drives."},"durationDriver":{"type":"integer","description":"The duration as driver in seconds.\n\nTotal time spent actively driving the vehicle."},"totalDuration":{"type":"integer","description":"The total duration of all drives in seconds.\n\nSum of all drive durations including both driver and passenger time."},"worktimeBySalaryType":{"type":"array","items":{"type":"integer"},"description":"The working time broken down by salary type for each drive."},"totalWorktimeBySalaryType":{"type":"array","items":{"type":"integer"},"description":"The total working time aggregated by salary type."},"totalSetupTimeBySalaryType":{"type":"array","items":{"type":"integer"},"description":"The total setup time aggregated by salary type."},"totalSetupTimeBySalaryTypeAndCostCenter":{"type":"array","items":{"type":"integer"},"description":"The total setup time aggregated by salary type and cost center."},"setupTimeDuration":{"type":"integer","description":"The total setup time duration in seconds."},"totalSetupTimeWorktime":{"type":"integer","description":"The total setup time working hours."}}},"EmployeeTimeTrackingFetchResponseTimeSheetDriveItem":{"type":"object","description":"","properties":{"startTime":{"description":"The start time of the drive.\n\nBeginning timestamp of the drive activity.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time of the drive.\n\nEnding timestamp of the drive activity.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"distanceDriver":{"type":"integer","description":"The distance traveled as driver in meters.\n\nTotal distance covered while actively driving the vehicle."},"durationDriver":{"type":"integer","description":"The duration as driver in seconds.\n\nTotal time spent actively driving the vehicle."},"durationWithinWorktimeDriver":{"type":"integer","description":"The duration as driver within worktime in seconds.\n\nTime spent driving that counts towards paid working hours."},"distancePassenger":{"type":"integer","description":"The distance traveled as passenger in meters.\n\nTotal distance covered while traveling as a passenger."},"durationPassenger":{"type":"integer","description":"The duration as passenger in seconds.\n\nTotal time spent as a passenger during the drive."},"durationWithinWorktimePassenger":{"type":"integer","description":"The duration as passenger within worktime in seconds.\n\nTime spent as a passenger that counts towards paid working hours."},"licenseNumber":{"type":"string","description":"The license plate of the vehicle."},"projectReferenceSign":{"type":"string","description":"The reference sign of the project."}}},"EmployeeTimeTrackingFetchResponseEmployeeAbsenceItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"importSource":{"type":"string","description":"External data source from which this absence originates. (max. 20 characters)"},"importKey":{"type":"string","description":"External ID of the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The name of the absence."},"salaryType":{"type":"string","description":"The salary type of the absence."},"duration":{"type":"integer","description":"The salary type of the absence."},"worktime":{"type":"integer","description":"The salary type of the absence."}}},"EmployeeTimeTrackingFetchResponseEmployeeAccountingEntryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal accounting entry ID."},"date":{"description":"The date of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/Date"},"description":{"type":"string","description":"The description of the accounting entry."},"salaryType":{"type":"string","description":"The salary type of the accounting entry."},"value":{"type":"number","description":"The value of the accounting entry."},"valueUnit":{"type":"string","description":"The value unit of the accounting entry.\n\n| Value                     |  Description                           |\n| ------------------------- | -------------------------------------- |\n| HOUR                      | Hours                                  |\n| DAY                       | Days                                   |\n| CURRENCY                  | Currency                               |\n| QUANTITY                  | Quantity                               |"},"project":{"description":"The project of the accounting entry.","type":"object","$ref":"#\/components\/schemas\/EmployeeTimeTrackingFetchResponseProjectItem"},"costCenter":{"type":"string","description":"The cost center of the accounting entry."}}},"StandardEmployeeTimeTrackingFetchRequest":{"type":"object","description":"","properties":{"employeeReference":{"type":"string","description":"The personnel number of the employee. The employeeReference or importKey is required."},"importKey":{"type":"string","description":"The external id of the employee. The employeeReference or importKey is required."},"from":{"description":"Start date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"End date","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardCustomFormDefinitionFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The form definitions.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFormDefinitionFetchResponseCustomFormDefinitionItem"},{"description":""}]}},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"totalCount":{"type":"integer","description":"Total number of available form definitions.\n(Only calculated if offset is 0)"}}},"CustomFormDefinitionFetchResponseCustomFormDefinitionItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"name":{"type":"string","description":"Name of the form definition."},"version":{"type":"integer","description":"Version of the form definition."},"createdAt":{"description":"Creation date of the form definition.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"updatedAt":{"description":"Date of the last update of the form definition.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"externalReference":{"type":"string","description":"The external reference of the form definition."}}},"CustomFormDefinitionFetchRequestCustomFormDefinitionFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the form definition based on the internal IDs."},"byText":{"type":"string","description":"Filters the form definition based on the text passed."},"byExternalReference":{"type":"string","description":"Filters the form definition based on the external reference."}}},"StandardCustomFormDefinitionFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The form definition filter.","type":"object","$ref":"#\/components\/schemas\/CustomFormDefinitionFetchRequestCustomFormDefinitionFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardVideoWallFetchResponse":{"type":"object","description":"","properties":{"beacons":{"description":"The beacons.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseBeaconItem"},{"description":""}]}},"trackers":{"description":"The vehicles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseTrackerItem"},{"description":""}]}},"trackerCategories":{"description":"The vehicle categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseTrackerCategoryItem"},{"description":""}]}},"trackPoints":{"description":"The geo coordinate list.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseTrackPointList"},{"description":""}]}},"events":{"description":"The event list.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseEventList"},{"description":""}]}},"concentrationPointProjects":{"description":"The concentration point projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseProjectItem"},{"description":""}]}},"projects":{"description":"The projects.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseProjectItem"},{"description":""}]}},"autoRefresh":{"type":"integer","description":"The configured refresh interval in seconds."},"clock":{"type":"boolean","description":"Show the current time?"},"showDrivingTimeOnMap":{"type":"boolean","description":"Show the driving time on the map?"},"showDrivingTimeOnInfo":{"type":"boolean","description":"Show the driving time in the window?"},"drivingTimeShowLicenseNumber":{"type":"boolean","description":"Show the license plate at the driving time?"},"drivingTimeShowTrackerName":{"type":"boolean","description":"Show the vehicle name at the driving time?"},"drivingTimeShowDriver":{"type":"boolean","description":"Show the driver name at the driving time?"},"beaconTextColor":{"type":"string","description":"Beacon text color."},"progressBar":{"type":"boolean","description":"Show progress bar? (Shows time till next refresh)\nOb die ProgressBar angezeigt wird. Zeigt die Zeit bis zur n\u00e4chsten Aktualisiering."}}},"VideoWallFetchResponseBeaconItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"uuid":{"type":"string","description":"The beacon UUID as hexadecimal value."},"macAddress":{"type":"string","description":"The beacon MAC address."},"name":{"type":"string","description":"The name of the beacon. (max. 255 characters)"},"objectIdentifier":{"type":"string","description":"External, customer specific ID of the object the beacon is attached to. (max. 64 characters)"},"objectSerialNumber":{"type":"string","description":"Serial number of object, the beacon is attached to. (max. 128 characters)"},"categoryId":{"type":"integer","description":"The beacon category ID."},"latLng":{"description":"The current position.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"}}},"VideoWallFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"},"categoryId":{"type":"integer","description":"The vehicle category ID."},"color":{"type":"string","description":"The defined route color."},"latLng":{"description":"The current positions.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"iconUrl":{"type":"string","description":"The URL for the icon."},"drivingTimeImageUrl":{"type":"string","description":"The URL for the driving time image."},"iconSize":{"type":"array","items":{"type":"integer"},"description":"The icon size in pixels."},"driverName":{"type":"string","description":"The driver name."},"sensors":{"description":"Thee available sensors..","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseTrackerSensorItem"},{"description":""}]}},"hasDriverKey":{"type":"boolean","description":"The current driver uses an iButton or RFID key."},"latLngBounds":{"description":"The rectangle of the route.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"}}},"VideoWallFetchResponseTrackerSensorItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal sensor ID."},"name":{"type":"string","description":"The sensor name."},"type":{"type":"string","description":"The sensor type.\n\n| Value                     |  Description                               |\n| ------------------------ | ------------------------------------------- |\n| ALTITUDE                 | Height                                      |\n| SPEED                    | Speed                                       |\n| DIRECTION                | Direction                                   |\n| GPS_SIGNAL_QUALITY       | GPS signal strength (Number of satellites)  |\n| GSM_SIGNAL_QUALITY       | GSM signal strength                         |\n| POWER_SUPPLY_VOLTAGE     | Voltage                                     |\n| EMPLOYEE                 | Employee                                    |\n| PIECE                    | Piece                                       |\n| SECOND                   | Second                                      |\n| MINUTE                   | Minute                                      |\n| DEGREE                   | Degree                                      |\n| MILLIVOLT                | Millivolt                                   |\n| METER                    | Meter                                       |\n| METER_PER_SEC2           | Meter\/s\u00b2                                    |\n| KILOMETER                | Kilometer                                   |\n| KILOMETER_PER_HOUR       | Kilometer\/h                                 |\n| LITER                    | Liter                                       |\n| LITER_PER_100KM          | Liter\/100 km                                |\n| VOLT                     | Volt                                        |\n| AMPERE                   | Ampere                                      |\n| MILLIAMPERE              | Milliampere                                 |\n| PERCENT                  | Percent                                     |\n| DEGREE_CELSIUS           | Degrees Celsius (\u00b0C)                        |\n| BOOLEAN                  | On\/Off                                      |\n| ID                       | ID                                          |\n| NUMBER                   | Number                                      |\n| METER2                   | Meter\u00b2                                      |\n| HECTARE                  | Hectar                                      |"}}},"VideoWallFetchResponseTrackerCategoryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Vehicle category ID."},"name":{"type":"string","description":"Vehicle category name."},"color":{"type":"string","description":"Color."},"iconUrl":{"type":"string","description":"Icon."}}},"VideoWallFetchResponseTrackPointList":{"type":"object","description":"","properties":{"trackerId":{"type":"integer","description":"The internal vehicle ID this list belongs to."},"data":{"description":"The individual points.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseTrackPointItem"},{"description":""}]}}}},"VideoWallFetchResponseTrackPointItem":{"type":"object","description":"","properties":{"time":{"description":"The timestamp.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"latLng":{"description":"The position.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"sensorValues":{"description":"The sensor values.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseTrackPointSensorValueItem"},{"description":""}]}}}},"VideoWallFetchResponseTrackPointSensorValueItem":{"type":"object","description":"","properties":{"sensorId":{"type":"integer","description":"The sensor."},"value":{"type":"number","description":"The value."},"displayValue":{"type":"string","description":"The formatted value."}}},"VideoWallFetchResponseEventList":{"type":"object","description":"","properties":{"trackerId":{"type":"integer","description":"The internal vehicle ID this List belongs to."},"data":{"description":"The individual points.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/VideoWallFetchResponseEventItem"},{"description":""}]}}}},"VideoWallFetchResponseEventItem":{"type":"object","description":"","properties":{"type":{"type":"string","description":"The event type\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| MOVE                     | Move                                 |\n| STOP                     | Stop                                 |\n| STAMP                    | Stamp                                |\n| IGNITION                 | Ignition                             |\n| SENSOR                   | Sensor                               |"},"sensorValueTypeName":{"type":"string","description":"The event value type name."},"startTime":{"description":"The timestamp at the event start.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"startLatLng":{"description":"The geo coordinates of the vehicle at the event start.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"startProjectId":{"type":"integer","description":"The project the vehicle was located at the event start."},"endTime":{"description":"The timestamp at the event end.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endLatLng":{"description":"The geo coordinates of the vehicle at the event end.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"endProjectId":{"type":"integer","description":"The project the vehicle was located at the event start."},"distance":{"type":"integer","description":"The driven distance in meters."},"employeeId":{"type":"integer","description":"For MOVE events the driver. For STAMP events the employee."},"beaconIds":{"type":"integer","description":"The beacon\u0027s IDs of the event."}}},"VideoWallFetchResponseProjectItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal project ID."},"reference":{"type":"string","description":"The project number."},"importSource":{"type":"string","description":"External data source from which this project originated."},"importKey":{"type":"string","description":"External ID from the respective data source."},"name":{"type":"string","description":"The project name. (max. 255 characters)"},"description":{"type":"string","description":"The project description."},"extraName1":{"type":"string","description":"The name1 address addition. (max. 255 characters)"},"extraName2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"extraName3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"latLng":{"description":"The geo-coordinate. An array of two double values, representing the latitude and longitude.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"costCenter":{"type":"string","description":"The cost center. (max. 64 characters)"},"contactPerson":{"type":"string","description":"Contact person."},"phoneNumber":{"type":"string","description":"Phone number."},"validFrom":{"description":"Valid from.","type":"object","$ref":"#\/components\/schemas\/Date"},"validTo":{"description":"Valid to.","type":"object","$ref":"#\/components\/schemas\/Date"},"fenceBounds":{"description":"The rough project fence.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"},"fences":{"description":"The project fences.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ProjectFetchResponseProjectFence"},{"description":""}]}},"fenceType":{"type":"string","description":"(Deprecated, use fences instead)\nProjct fence type.\n\n| Value         | Description         |\n|---------------|---------------------|\n| RADIUS        | Radius              |\n| POLYGON       | Polygon             |","deprecated":true},"fenceRadius":{"type":"integer","description":"(Deprecated, use fences instead)\nProject fence as radius. (In meters)","deprecated":true},"fencePolygon":{"description":"(Deprecated, use fences instead)\nProject fence as polygon.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},{"description":""}]},"deprecated":true},"iconUrl":{"type":"string","description":"Icon url."}}},"StandardVideoWallFetchRequest":{"type":"object","description":"","properties":{"screen":{"type":"string","description":""},"bounds":{"description":"","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"}}},"StandardVideoWallViewRequest":{"type":"object","description":"","properties":{"screen":{"type":"string","description":"Screen ID."}}},"StandardFileFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The list of files.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/FileFetchResponseFileListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available files.\n(Only calculated if offset is 0)"}}},"FileFetchResponseFileListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the file."},"externalId":{"type":"string","description":"The external id of the file."},"subject":{"type":"string","description":"The subject of the file."},"description":{"type":"string","description":"The description of the file."},"type":{"type":"string","description":"The name of the file type."},"ownerType":{"type":"string","description":"The type of object which the file is assigned to\n\nVEHICLE, ORDER, PROJECT, TOOL, EMPLOYEE OR NONE"},"ownerId":{"type":"integer","description":"The id of the object which the file is assigned to"},"date":{"description":"The assigned date of the file.","type":"object","$ref":"#\/components\/schemas\/Date"},"validTo":{"description":"The date until which the file is valid.","type":"object","$ref":"#\/components\/schemas\/Date"},"fileSize":{"type":"integer","description":"The size of the file in bytes."},"extension":{"type":"string","description":"The extension of the file."}}},"FileFetchRequestFileFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the file based on the internal IDs."},"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters the file based on the external IDs."},"byTypeId":{"type":"array","items":{"type":"integer"},"description":"Filters the file based on the file type id."},"byTypeReferences":{"type":"array","items":{"type":"string"},"description":"Filters the file based on the file type reference."},"ownerType":{"type":"string","description":"Filters the file based on the object type it is attached to. (required if ownerId is provided)\n\nVEHICLE, ORDER, PROJECT, TOOL or EMPLOYEE"},"ownerId":{"type":"integer","description":"Filters the file based on the object id it is attached to. (required if ownerType is provided)"},"from":{"description":"Filters the file based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the file based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardFileFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The file filter. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/FileFetchRequestFileFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single API request, with a\nlimit and default value set at 500 records. This Parameter is optional."}}},"StandardFileFetchFileRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID of the file. This Parameter or the external ID is required."},"externalId":{"type":"string","description":"The external ID of the file. This Parameter or the id is required."},"log_access":{"type":"boolean","description":"Log the access in the access log. This Parameter is optional."}}},"StandardFileCreateResponse":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID of the file"},"objectType":{"type":"string","description":"Object type of the object to which the file was added.\n\nVEHICLE, ORDER, PROJECT, TOOL or EMPLOYEE"},"objectId":{"type":"integer","description":"The internal ID of the object to which the file was added."}}},"StandardFileCreateRequest":{"type":"object","description":"","properties":{"externalId":{"type":"string","description":"The files external id. The external id is unique across all files. This paramter is optional."},"objectType":{"type":"string","description":"The object Type. This Parameter is required.\n\nVEHICLE, ORDER, PROJECT, TOOL or EMPLOYEE"},"targetId":{"type":"integer","description":"Id of the object to attach the file to.  This paramter is optional."},"targetReference":{"type":"string","description":"Reference of the object to attach the file to (Used if targetId not provided). This paramter is optional."},"typeId":{"type":"integer","description":"Id of the file type. This paramter is optional."},"typeReference":{"type":"string","description":"Reference of the file type (Used if typeId not provided). This paramter is optional."},"filename":{"type":"string","description":"Filename with extension This paramter is required."},"description":{"type":"string","description":"The file description. This paramter is required."},"date":{"description":"The assigned date of the file. If nothing is provided, the current date is used.","type":"object","$ref":"#\/components\/schemas\/Date"},"data":{"type":"string","description":"The data of the file (base64 encoded). This paramter is required."}}},"StandardFileUpsertResponse":{"type":"object","description":"","properties":{"createdFiles":{"description":"The created files.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/FileUpsertResponseFileItem"},{"description":""}]}},"updatedFiles":{"description":"The changed files.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/FileUpsertResponseFileItem"},{"description":""}]}},"deletedFiles":{"description":"The deleted files.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/FileUpsertResponseFileItem"},{"description":""}]}}}},"FileUpsertResponseFileItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID of the file."},"objectType":{"type":"string","description":"Object type of the object to which the file was added.\n\nVEHICLE, ORDER, PROJECT, TOOL or EMPLOYEE"},"objectId":{"type":"integer","description":"The internal ID of the object to which the file was added."}}},"FileUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                 |\n|-----------------|-----------------------------|\n| id              | The internal file ID        |\n| externalId      | The external id             |"},"data":{"description":"The order record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/FileUpsertRequestRecordData"}}},"FileUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The file id."},"externalId":{"type":"string","description":"The files external id. (max. 128 characters)"},"objectType":{"type":"string","description":"The object Type. This Parameter is required.\n\nVEHICLE, ORDER, PROJECT, TOOL or EMPLOYEE"},"targetId":{"type":"integer","description":"Id of the object to attach the file to.  This paramter is optional."},"targetReference":{"type":"string","description":"Reference of the object to attach the file to (Used if targetId not provided). This paramter is optional."},"typeId":{"type":"integer","description":"Id of the file type. This paramter is optional."},"typeReference":{"type":"string","description":"Reference of the file type (Used if typeId not provided). This paramter is optional."},"filename":{"type":"string","description":"Filename with extension. This paramter is required. (max. 255 characters)"},"description":{"type":"string","description":"The file description. This paramter is required."},"date":{"description":"The assigned date of the file. If nothing is provided, the current date is used.","type":"object","$ref":"#\/components\/schemas\/Date"},"validTo":{"description":"The date until which the file is valid.","type":"object","$ref":"#\/components\/schemas\/Date"},"data":{"type":"string","description":"The data of the file (base64 encoded). This paramter is required."}}},"StandardFileUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/FileUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardFileDeleteResponse":{"type":"object","description":"","properties":{"deletedIds":{"type":"array","items":{"type":"integer"},"description":"The files that were deleted"}}},"StandardFileDeleteRequest":{"type":"object","description":"","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"The internal ids of the files to be deleted. This paramter is required."}}},"StandardFileFetchTypeResponse":{"type":"object","description":"","properties":{"data":{"description":"The file types.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/FileFetchTypeResponseObjectFileTypeListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available file types.\n(Only calculated if offset is 0)"}}},"FileFetchTypeResponseObjectFileTypeListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the file type."},"objectType":{"type":"string","description":"The object type for the file type."},"name":{"type":"string","description":"The name of the file type."},"externalReference":{"type":"string","description":"The reference of the file type."},"description":{"type":"string","description":"The description of the file type."},"createdAt":{"description":"The date the file type was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardFileFetchTypeRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional"},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This Parameter is optional"}}},"StandardEmployeeFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The employees.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeFetchResponseEmployeeItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available employees.\n(Only calculated if the offset is 0)"}}},"EmployeeFetchResponseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."},"phoneNumber":{"type":"string","description":"The phone number (max. 128 characters)"},"ibutton":{"type":"string","description":"The iButton as hexadecimal value."},"ibuttonNumber":{"type":"integer","description":"The iButton as number. (max. 32 characters)"},"email":{"type":"string","description":"The e-mail address. (max. 128 characters)"},"costCenter":{"type":"string","description":"The cost center. (max. 32 characters)"},"entryDate":{"description":"The entry date.","type":"object","$ref":"#\/components\/schemas\/Date"},"dayOfBirth":{"description":"The employee\u0027s birthday.","type":"object","$ref":"#\/components\/schemas\/Date"},"gender":{"type":"string","description":"The employee\u0027s gender. (MALE, FEMALE, NONBINARY)"},"numVacationDays":{"type":"number","description":"The number of vacation days the employee has per year."},"terminationDate":{"description":"The exit date.","type":"object","$ref":"#\/components\/schemas\/Date"},"socialSecurityNumber":{"type":"string","description":"The social security number for the employee. (max. 25 characters)"},"healthInsuranceFromDate":{"description":"The date of joining the health insurance.","type":"object","$ref":"#\/components\/schemas\/Date"},"healthInsuranceType":{"type":"string","description":"The health insurance type (STATUTORY\/PRIVATE)."},"healthInsuranceName":{"type":"string","description":"The name of the employees health insurance"},"cardExpiresOn":{"description":"The expiry date of the tacho card.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"department":{"description":"The department the employee is assigned to.","type":"object","$ref":"#\/components\/schemas\/DepartmentFetchResponseDepartmentItem"},"location":{"description":"The location the employee is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardLocationBaseLocationListItem"},"assignedDispoQualifications":{"description":"All dispo qualifications assigned to the employee.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoQualificationBaseDispoQualificationListItem"},{"description":""}]}}}},"StandardLocationBaseLocationListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the location category."},"name":{"type":"string","description":"The name of the location."},"externalId":{"type":"string","description":"The external ID of the location."},"createdAt":{"description":"Date when the location was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardDispoQualificationBaseDispoQualificationListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the dispo qualification."},"name":{"type":"string","description":"The name of the dispo qualification."},"createdAt":{"description":"Date when the dispo qualification was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"EmployeeFetchRequestEmployeeFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the employee based on the IDs."},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the personal numbers."},"byCardNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the driver card numbers."},"byIbuttonNumbers":{"type":"array","items":{"type":"integer"},"description":"Filters the employees based on the iButton numbers."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the employee import IDs."},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered."}}},"StandardEmployeeFetchRequest":{"type":"object","description":"","properties":{"employees":{"description":"The employee filter. This paramter is optional.","type":"object","$ref":"#\/components\/schemas\/EmployeeFetchRequestEmployeeFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional."}}},"StandardEmployeeFetchImageRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID of the employee. This Parameter is required."}}},"StandardEmployeeUpsertResponse":{"type":"object","description":"","properties":{"createdEmployees":{"description":"The created employees.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeUpsertResponseEmployeeItem"},{"description":""}]}},"updatedEmployees":{"description":"The changed employees.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeUpsertResponseEmployeeItem"},{"description":""}]}},"deletedEmployees":{"description":"The deleted employees.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeUpsertResponseEmployeeItem"},{"description":""}]}}}},"EmployeeUpsertResponseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"}}},"EmployeeUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                         |\n|----------------|--------------------------------------|\n| id             | The internal employee ID             |\n| reference      | The personnel number of the employee |\n| cardNumber     | The driver card number               |\n| ibuttonNumber  | The iButton number                   |\n| importKey      | The external record ID               |"},"data":{"description":"The employee record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/EmployeeUpsertRequestRecordData"}}},"EmployeeUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."},"phoneNumber":{"type":"string","description":"The phone number (max. 128 characters)"},"ibutton":{"type":"string","description":"The iButton as hexadecimal value."},"ibuttonNumber":{"type":"integer","description":"The iButton as number. (max. 32 characters)"},"email":{"type":"string","description":"The e-mail address. (max. 128 characters)"},"costCenter":{"type":"string","description":"The cost center. (max. 32 characters)"},"entryDate":{"description":"The entry date.","type":"object","$ref":"#\/components\/schemas\/Date"},"dayOfBirth":{"description":"The employee\u0027s birthday.","type":"object","$ref":"#\/components\/schemas\/Date"},"gender":{"type":"string","description":"The employee\u0027s gender. (MALE, FEMALE, NONBINARY)"},"numVacationDays":{"type":"number","description":"The number of vacation days the employee has per year."},"terminationDate":{"description":"The exit date.","type":"object","$ref":"#\/components\/schemas\/Date"},"socialSecurityNumber":{"type":"string","description":"The social security number for the employee. (max. 25 characters)"},"healthInsuranceFromDate":{"description":"The date of joining the health insurance.","type":"object","$ref":"#\/components\/schemas\/Date"},"healthInsuranceType":{"type":"string","description":"The health insurance type (STATUTORY\/PRIVATE)."},"healthInsuranceCompanyNumber":{"type":"string","description":"The company number for the health insurance."},"locationExternalId":{"type":"string","description":"The external ID of the location."},"departmentId":{"type":"string","description":"The identifier of the department."},"timeTracking":{"type":"boolean","description":"Activates time tracking for the employee. (Default = true)"},"imageName":{"type":"string","description":"The name of the image with extension."},"imageData":{"type":"string","description":"The data of the employee image (base64 encoded)."},"assignedDispoQualifiationIds":{"type":"array","items":{"type":"integer"},"description":"The ids of the dispo qualifications, that should be assigned to the employee."}}},"StandardEmployeeUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This paramter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all employees missing from this request? This paramter is optional."},"deleteImportSource":{"type":"string","description":"The data source from which the missing employees can be deleted. This paramter is optional.\n(Standard is \u0022*API\u0022)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardEmployeeDeleteResponse":{"type":"object","description":"","properties":{"deletedEmployees":{"description":"The deleted employees.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeDeleteResponseEmployeeItem"},{"description":""}]}}}},"EmployeeDeleteResponseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"}}},"EmployeeDeleteRequestEmployeeFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the employee based on the IDs."},"byReferences":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the personal numbers."},"byCardNumbers":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the driver card numbers."},"byIbuttonNumbers":{"type":"array","items":{"type":"integer"},"description":"Filters the employees based on the iButton numbers."},"byImportKeys":{"type":"array","items":{"type":"string"},"description":"Filters the employees based on the employee import IDs."},"importSource":{"type":"string","description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered."}}},"StandardEmployeeDeleteRequest":{"type":"object","description":"","properties":{"employees":{"description":"The employee filter. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/EmployeeDeleteRequestEmployeeFilter"},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardOrderImporterImportFileResponse":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID of the import job."}}},"StandardOrderImporterImportFileRequest":{"type":"object","description":"","properties":{"filename":{"type":"string","description":"Filename with file extension (required)"},"data":{"type":"string","description":"base64 encoded File (required)"}}},"StandardSalaryTypeFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The absence types.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/SalaryTypeFetchResponseSalaryTypeItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skiped records."},"totalCount":{"type":"integer","description":"Total number of available salary types.\n(Only calculated if offset is 0)"}}},"SalaryTypeFetchResponseSalaryTypeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal salary type ID."},"name":{"type":"string","description":"The name of the salary type."},"type":{"type":"string","description":"The salary type."},"isVacation":{"type":"boolean","description":"Whether the salary type is the holiday salary type."}}},"SalaryTypeFetchRequestSalaryTypeFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the salary types based on the IDs."}}},"StandardSalaryTypeFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The salary type filter.","type":"object","$ref":"#\/components\/schemas\/SalaryTypeFetchRequestSalaryTypeFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardOrderCategoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The order categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/OrderCategoryFetchResponseOrderCategoryListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available order categories.\n(Only calculated if offset is 0)"}}},"OrderCategoryFetchResponseOrderCategoryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order category"},"dispoType":{"type":"string","description":"The name of the dispo type"},"name":{"type":"string","description":"The name of the order category"},"externalId":{"type":"string","description":"The external id of the order category"},"createdAt":{"description":"The date the order category was created","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"OrderCategoryFetchRequestOrderCategoryFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the order category based on the internal IDs."},"from":{"description":"Filters the order category  based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"to":{"description":"Filters the order category based on the given date.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"byName":{"type":"string","description":"Filters the order category based on the name."}}},"StandardOrderCategoryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The order category filter.","type":"object","$ref":"#\/components\/schemas\/OrderCategoryFetchRequestOrderCategoryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardToolCategoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tool categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolCategoryFetchRequestToolCategoryListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tool categories."}}},"ToolCategoryFetchRequestToolCategoryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool category."},"name":{"type":"string","description":"The name of the tool category."},"description":{"type":"string","description":"The description of the tool category."},"externalId":{"type":"string","description":"The external id of the tool category."},"createdAt":{"description":"Date when the tool category was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"ToolCategoryFetchRequestToolCategoryFilter":{"type":"object","description":"","properties":{"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters the tool categories based on the externalIds."}}},"StandardToolCategoryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The bill of quantities filter.","type":"object","$ref":"#\/components\/schemas\/ToolCategoryFetchRequestToolCategoryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardTrackerProfileFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tracker profiles.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerProfileBaseTrackerProfileItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tracker profiles."}}},"StandardTrackerProfileBaseTrackerProfileItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The tracker profile id."},"name":{"type":"string","description":"The tracker profile name."}}},"StandardTrackerProfileFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records."}}},"StandardDispoTypeFetchTypeResponse":{"type":"object","description":"","properties":{"data":{"description":"The dispo types.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchTypeResponseDispoTypeListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available dispo types.\n(Only calculated if offset is 0)"}}},"DispoTypeFetchTypeResponseDispoTypeListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the dispo type."},"name":{"type":"string","description":"The name of the dispo type."},"createdAt":{"description":"The date the dispo type was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardDispoTypeFetchTypeRequest":{"type":"object","description":"","properties":{"name":{"type":"string","description":"Filters the list of disposition types by name. Supports partial matches (case-insensitive). If not specified, all disposition types are returned."},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardDispoTypeFetchTypeDataResponse":{"type":"object","description":"","properties":{"data":{"description":"The dispo type.","type":"object","$ref":"#\/components\/schemas\/DispoTypeFetchTypeDataResponseDispoTypeItem"}}},"DispoTypeFetchTypeDataResponseDispoTypeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the dispo type."},"name":{"type":"string","description":"The name of the dispo type."},"createdAt":{"description":"The date the dispo type was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"routingMode":{"type":"string","description":"The routing mode."},"optimizationGenerations":{"type":"integer","description":"The amount of optimizations to run. The higher the number of runs selected, the better the optimization result,\nalthough this also increases the calculation time. (Default: 1500)"},"maxRouteDistance":{"type":"integer","description":"The maximal distance for which the routes should be calculated.\nThe air distance between two stops below which an exact route will be calculated. The higher the value, the better\nthe optimization. However, this also increases the calculation time. (Default: 5, 9999 = always)"},"optimizationGoal1":{"type":"string","description":"The optimization goal 1."},"optimizationGoal2":{"type":"string","description":"The optimization goal 2."},"optimizationGoal3":{"type":"string","description":"The optimization goal 3."},"optimizationGoal4":{"type":"string","description":"The optimization goal 4."},"optimizationGoal5":{"type":"string","description":"The optimization goal 5."},"optimizationGoalThreshold1":{"type":"string","description":"The optimization goal threshold 1."},"optimizationGoalThreshold2":{"type":"string","description":"The optimization goal threshold 2."},"optimizationGoalThreshold3":{"type":"string","description":"The optimization goal threshold 3."},"optimizationGoalThreshold4":{"type":"string","description":"The optimization goal threshold 4."},"optimizationGoalThreshold5":{"type":"string","description":"The optimization goal threshold 5."},"districts":{"description":"The dispo districts.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchTypeDataResponseDispoDistrictItem"},{"description":""}]}}}},"DispoTypeFetchTypeDataResponseDispoDistrictItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the district."},"name":{"type":"string","description":"The name of the district."},"reference":{"type":"string","description":"The reference."},"bounds":{"description":"The geo-coordinates.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngBoundsInterface"},"group":{"type":"string","description":"The group."},"createdAt":{"description":"The date the dispo district was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardDispoTypeFetchTypeDataRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the dispo type. The \u0027fetch dispo type list\u0027 endpoint allows you to retrieve the id of a\nspecific dispo type. This Parameter is required."}}},"StandardDispoTypeFetchTeamResponse":{"type":"object","description":"","properties":{"data":{"description":"The dispo teams.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchTeamResponseDispoTeamListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available dispo teams.\n(Only calculated if offset is 0)"}}},"DispoTypeFetchTeamResponseDispoTeamListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the team."},"name":{"type":"string","description":"The name of the team."},"description":{"type":"string","description":"The description of the team."},"externalReference":{"type":"string","description":"The external reference for the team."},"createdAt":{"description":"The date the team was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardDispoTypeFetchTeamRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional."}}},"StandardDispoTypeFetchQualificationResponse":{"type":"object","description":"","properties":{"data":{"description":"The dispo qualifications.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchQualificationResponseDispoQualificationListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available dispo qualifications.\n(Only calculated if offset is 0)"}}},"StandardDispoTypeFetchQualificationRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardDispoTypeFetchDistrictResponse":{"type":"object","description":"","properties":{"data":{"description":"The dispo district.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTypeFetchTypeDataResponseDispoDistrictItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available dispo districts.\n(Only calculated if offset is 0)"}}},"StandardDispoTypeFetchDistrictRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional."}}},"StandardTrackerManufacturerFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tracker manufacturers.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerManufacturerBaseTrackerManufacturerItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tracker manufacturers."}}},"StandardTrackerManufacturerBaseTrackerManufacturerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal tracker id."},"name":{"type":"string","description":"The tracker manufacturer name. (max. 255 characters)"},"description":{"type":"string","description":"The tracker manufacturer description. (max. 255 characters)"}}},"StandardTrackerManufacturerFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records."}}},"StandardTrackerManufacturerUpsertResponse":{"type":"object","description":"","properties":{"createdTrackerManufacturers":{"description":"The created tracker manufacturers.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerManufacturerBaseTrackerManufacturerItem"},{"description":""}]}},"updatedTrackerManufacturers":{"description":"The changed tracker manufacturers.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerManufacturerBaseTrackerManufacturerItem"},{"description":""}]}},"deletedTrackerManufacturers":{"description":"The deleted tracker manufacturers.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerManufacturerBaseTrackerManufacturerItem"},{"description":""}]}}}},"TrackerManufacturerUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal tracker manufacturer ID        |"},"data":{"description":"The tracker manufacturer record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/TrackerManufacturerUpsertRequestRecordData"}}},"TrackerManufacturerUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal tracker id."},"name":{"type":"string","description":"The tracker manufacturer name. (max. 255 characters)"},"description":{"type":"string","description":"The tracker manufacturer description. (max. 255 characters)"}}},"StandardTrackerManufacturerUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerManufacturerUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all tracker manufacturers missing from this request? This Parameter is optional. (Default: false)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardEmployeeAbsenceFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The absences.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAbsenceFetchResponseEmployeeAbsenceListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available approvals.\n(Only calculated if offset is 0)"}}},"EmployeeAbsenceFetchResponseEmployeeAbsenceListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the absence."},"employeeId":{"type":"integer","description":"The internal id of the employee."},"employeeReference":{"type":"string","description":"The employee personal number."},"name":{"type":"string","description":"The employee name."},"date":{"description":"The date of the absence.","type":"object","$ref":"#\/components\/schemas\/Date"},"absenceType":{"type":"string","description":"The absence type."},"absenceTypeId":{"type":"integer","description":"The internal id of the absence."},"absenceExternalId":{"type":"string","description":"The external id of the absence."},"halfDay":{"type":"boolean","description":"Is it only a half day absence."},"actualDuration":{"type":"integer","description":"The actual duration of the absence. If a absence is a full day absence the duration represents the target worktime on that day."},"externalId":{"type":"string","description":"External-ID of the absence type."},"updatedAt":{"description":"The date when the absence was updated.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"EmployeeAbsenceFetchRequestEmployeeAbsenceFilter":{"type":"object","description":"","properties":{"byEmployeeReference":{"type":"array","items":{"type":"string"},"description":"Filters the absences based on the employee personal number."},"from":{"description":"Filters the absences based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the absences based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"byAbsenceTypeId":{"type":"array","items":{"type":"integer"},"description":"Filters the absences based in the absence types"},"byDepartmentIds":{"type":"array","items":{"type":"integer"},"description":"Filters the absences based on the given departments"},"updatedFrom":{"description":"Filters the absences based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"updatedTo":{"description":"Filters the absences based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardEmployeeAbsenceFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The absences filter.","type":"object","$ref":"#\/components\/schemas\/EmployeeAbsenceFetchRequestEmployeeAbsenceFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardEmployeeAbsenceDeleteResponse":{"type":"object","description":"","properties":{"deletedAbsences":{"description":"The absences.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAbsenceDeleteResponseEmployeeAbsenceListItem"},{"description":""}]}}}},"EmployeeAbsenceDeleteResponseEmployeeAbsenceListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the absence."},"employeeId":{"type":"integer","description":"The internal id of the employee."},"employeeReference":{"type":"string","description":"The employee personal number."},"name":{"type":"string","description":"The employee name."},"date":{"description":"The date of the absence.","type":"object","$ref":"#\/components\/schemas\/Date"},"absenceType":{"type":"string","description":"The absence type."},"absenceTypeId":{"type":"integer","description":"The internal id of the absence."},"absenceExternalId":{"type":"string","description":"The external id of the absence."},"halfDay":{"type":"boolean","description":"Is it only a half day absence."},"actualDuration":{"type":"integer","description":"The actual duration of the absence. If a absence is a full day absence the duration represents the target worktime on that day."},"externalId":{"type":"string","description":"External-ID of the absence type."},"updatedAt":{"description":"The date when the absence was updated.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"EmployeeAbsenceDeleteRequestEmployeeAbsenceFilter":{"type":"object","description":"","properties":{"byEmployeeReference":{"type":"array","items":{"type":"string"},"description":"Filters the absences based on the employee personal number."},"from":{"description":"Filters the absences based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the absences based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"byAbsenceTypeId":{"type":"array","items":{"type":"integer"},"description":"Filters the absences based in the absence types"},"byId":{"type":"array","items":{"type":"integer"},"description":"Filters the absences based on the internal id."}}},"StandardEmployeeAbsenceDeleteRequest":{"type":"object","description":"","properties":{"filter":{"description":"The absences filter.","type":"object","$ref":"#\/components\/schemas\/EmployeeAbsenceDeleteRequestEmployeeAbsenceFilter"},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardEmployeeAbsenceUpsertResponse":{"type":"object","description":"","properties":{"createdAbsences":{"description":"The created absences.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAbsenceUpsertResponseEmployeeAbsenceListItem"},{"description":""}]}},"updatedAbsences":{"description":"The changed absences.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAbsenceUpsertResponseEmployeeAbsenceListItem"},{"description":""}]}},"deletedAbsencecs":{"description":"The deleted absences.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAbsenceUpsertResponseEmployeeAbsenceListItem"},{"description":""}]}}}},"EmployeeAbsenceUpsertResponseEmployeeAbsenceListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the absence."},"employeeId":{"type":"integer","description":"The internal id of the employee."},"employeeReference":{"type":"string","description":"The employee personal number."},"name":{"type":"string","description":"The employee name."},"date":{"description":"The date of the absence.","type":"object","$ref":"#\/components\/schemas\/Date"},"absenceType":{"type":"string","description":"The absence type."},"absenceTypeId":{"type":"integer","description":"The internal id of the absence."},"absenceExternalId":{"type":"string","description":"The external id of the absence."},"halfDay":{"type":"boolean","description":"Is it only a half day absence."},"actualDuration":{"type":"integer","description":"The actual duration of the absence. If a absence is a full day absence the duration represents the target worktime on that day."},"externalId":{"type":"string","description":"External-ID of the absence type."},"updatedAt":{"description":"The date when the absence was updated.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"EmployeeAbsenceUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                 |\n|----------------|-----------------------------|\n| id             | The internal employee ID  |\n| importKey      | The external record ID    |"},"data":{"description":"The absence record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/EmployeeAbsenceUpsertRequestRecordData"}}},"EmployeeAbsenceUpsertRequestRecordData":{"type":"object","description":"","properties":{"importSource":{"type":"string","description":"External data source from which this absence originates. (max. 20 characters)"},"importKey":{"type":"string","description":"External ID of the respective data source. (max. 64 characters)"},"id":{"type":"integer","description":"The internal id for the absence."},"employee":{"type":"integer","description":"The internal id for the employee."},"employeeReference":{"type":"string","description":"The employee personal number (Used if employee not provided)."},"type":{"type":"integer","description":"The internal id of the absence type."},"typeExternalId":{"type":"string","description":"The external id of the absence type (Used if type not provided)."},"date":{"description":"The date of the absence.","type":"object","$ref":"#\/components\/schemas\/Date"},"halfDay":{"type":"boolean","description":"Is this a half day absence."}}},"StandardEmployeeAbsenceUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/EmployeeAbsenceUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all absences missing from this request?"},"deleteImportSource":{"type":"string","description":"The data source from which the missing absences can be deleted.\n(Standard is \u0022*API\u0022)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardWageGroupCostHistoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The wage group cost settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupCostHistoryBaseWageGroupCostHistoryItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available wage group cost settings."}}},"StandardWageGroupCostHistoryBaseWageGroupCostHistoryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the wage group cost setting."},"wageGroup":{"description":"The wage group that this setting is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardWageGroupBaseWageGroupListItem"},"projectCostsPerHour":{"type":"number","description":"The costs per work hour."},"projectCostType":{"type":"string","description":"The name of the cost type for work."},"logisticsCostsPerHour":{"type":"number","description":"The costs per drive hour."},"logisticCostType":{"type":"string","description":"The name of the cost type for drives."},"from":{"description":"First date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Last date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardWageGroupBaseWageGroupListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the wage group."},"name":{"type":"string","description":"The name of the wage group."},"externalId":{"type":"string","description":"The external id of the wage group."},"createdAt":{"description":"Date when the wage group was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"WageGroupCostHistoryFetchRequestWageGroupCostHistoryFilter":{"type":"object","description":"","properties":{"byWageGroupId":{"type":"integer","description":"Filters the wage group cost settings based on the wage group id.\nOnly one filter will be applied."}}},"StandardWageGroupCostHistoryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The wage group cost setting filter.","type":"object","$ref":"#\/components\/schemas\/WageGroupCostHistoryFetchRequestWageGroupCostHistoryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardWageGroupCostHistoryUpsertResponse":{"type":"object","description":"","properties":{"createdWageGroupCostSettings":{"description":"The created wage group cost settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupCostHistoryBaseWageGroupCostHistoryItem"},{"description":""}]}}}},"WageGroupCostHistoryUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal wage group cost setting ID        |"},"data":{"description":"The wage group cost setting record.","type":"object","$ref":"#\/components\/schemas\/WageGroupCostHistoryUpsertRequestRecordData"}}},"WageGroupCostHistoryUpsertRequestRecordData":{"type":"object","description":"","properties":{"wageGroupId":{"type":"integer","description":"The internal id of the wage group that this setting is assigned to."},"projectCostsPerHour":{"type":"number","description":"The costs per work hour."},"projectCostTypeId":{"type":"integer","description":"The internal cost type id for work for this setting."},"logisticsCostsPerHour":{"type":"number","description":"The costs per drive hour."},"logisticsCostTypeId":{"type":"integer","description":"The internal cost type id for drives for this setting."},"from":{"description":"First date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardWageGroupCostHistoryUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The wage group cost setting data.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WageGroupCostHistoryUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardGeocoderGeocodeRequest":{"type":"object","description":"","properties":{"query":{"type":"string","description":"The address. This Parameter is required."}}},"StandardGeocoderReverseGeocodeRequest":{"type":"object","description":"","properties":{"latLng":{"description":"The geo coordinate. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"}}},"StandardDispoTourFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The list of tours.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchResponseDispoTourListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tours.\n(Only calculated if offset is 0)"}}},"DispoTourFetchResponseDispoTourListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour."},"startDate":{"description":"The start date of the tour.","type":"object","$ref":"#\/components\/schemas\/Date"},"team":{"type":"string","description":"The name of the team."},"teamId":{"type":"integer","description":"The internal id of the team."},"district":{"type":"string","description":"The name of the district."},"districtId":{"type":"integer","description":"The internal id of the district."},"numStops":{"type":"integer","description":"The amount of stops of the tour."},"numOrders":{"type":"integer","description":"The amount of orders of the tour."},"duration":{"type":"integer","description":"The total duration of the tour."},"distance":{"type":"integer","description":"The total distance of the tour."},"status":{"type":"string","description":"The status of the tour."}}},"DispoTourFetchRequestDispoTourFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the tour based on the internal IDs."},"byDistrict":{"type":"array","items":{"type":"integer"},"description":"Filters the tour based on the area."},"byTeam":{"type":"array","items":{"type":"integer"},"description":"Filters the tour based on the team."},"byStatus":{"type":"string","description":"Filters the tour based on its status."},"from":{"description":"Filters the tour based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Filters the tour based on the given date.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardDispoTourFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The tour filter. This paramter is optional.","type":"object","$ref":"#\/components\/schemas\/DispoTourFetchRequestDispoTourFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardDispoTourFetchDataResponse":{"type":"object","description":"","properties":{"data":{"description":"The tour details.","type":"object","$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourItem"}}},"DispoTourFetchDataResponseDispoTourItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour."},"startDate":{"description":"The start date of the tour.","type":"object","$ref":"#\/components\/schemas\/Date"},"team":{"type":"string","description":"The name of the team."},"teamId":{"type":"integer","description":"The internal id of the team."},"district":{"type":"string","description":"The name of the district."},"districtId":{"type":"integer","description":"The internal id of the district."},"numStops":{"type":"integer","description":"The amount of stops of the tour."},"numOrders":{"type":"integer","description":"The amount of orders of the tour."},"duration":{"type":"integer","description":"The total duration of the tour."},"distance":{"type":"integer","description":"The total distance of the tour."},"status":{"type":"string","description":"The status of the tour."},"reference":{"type":"integer","description":"The reference of the tour."},"dispoType":{"type":"string","description":"The name of the dispo type."},"dispoTypeId":{"type":"integer","description":"The internal id of the dispoType."},"stops":{"description":"The stops of the tour.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourStopItem"},{"description":""}]}},"startTime":{"description":"The start time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"costs":{"description":"","type":"object","$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourCostItem"},"teamHeadEmployee":{"description":"The head employee of the team.","type":"object","$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoEmployeeItem"},"numEmployees":{"type":"integer","description":"The number of employees of the team."},"employee":{"description":"The employee of the tour.","type":"object","$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoEmployeeItem"}}},"DispoTourFetchDataResponseDispoTourStopItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the stop."},"sequence":{"type":"integer","description":"The sequence of the stop."},"type":{"type":"string","description":"The stop type.\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| HOME                     | Home Stop used to identify the start and end of the tour            |\n| ORDER                     | Use this type for a normal stop with orders                               |\n| SUB                     | Used for sub stops                               |\n| TBREAK                    | Break Stop                           |\n| HOTEL                 | Used for overnight stays                              |\n| FUEL                 | Used for fueling                              |\n| LOAD                 | Used for pickup and delivery orders.                              |\n| UNLOAD                 | Used for pickup and delivery orders.                     |"},"name":{"type":"string","description":"The name address addition."},"name2":{"type":"string","description":"The name2 address addition."},"name3":{"type":"string","description":"The name3 address addition."},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"provinceCode":{"type":"string","description":"The province code."},"latLng":{"description":"The geo-coordinates of the stop.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonName":{"type":"string","description":"The contact person name."},"contactPersonEmail":{"type":"string","description":"The contact person e-mail."},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number."},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile number."},"noteDriver":{"type":"string","description":"A note for the driver. This info is shown to the driver in his app."},"notePlanner":{"type":"string","description":"A note for the planner."},"estimatedDrivingDuration":{"type":"integer","description":"The estimated driving duration in seconds between the previos and this stop."},"estimatedDrivingDistance":{"type":"integer","description":"The estimated driving distance in meters between the previos and this stop."},"estimatedTollCosts":{"type":"number","description":"The estimated toll costs between the previos and this stop."},"eta":{"description":"The estimated time of arrival at the stop.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"etd":{"description":"The estimated time of departure at the stop.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"ata":{"description":"The actual time of arrival at the stop.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"atd":{"description":"The actual time of departure at the stop.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"etc":{"type":"integer","description":"The estimated time in seconds to completion of the stop."},"totalSubEtc":{"type":"integer","description":"The estimated time in seconds to completion of all sub stops."},"atc":{"type":"integer","description":"The actual time in seconds to completion of the stop."},"orders":{"description":"The orders of the stop.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourOrderItem"},{"description":""}]}},"subStops":{"description":"The sub stops of the stop.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourSubStopItem"},{"description":""}]}},"masterStopId":{"type":"integer","description":"The internal id of the master stop."},"masterTourId":{"type":"integer","description":"The internal id of the tour from the master stop."},"masterEtc":{"type":"integer","description":"The internal id of the tour from the master stop."}}},"DispoTourFetchDataResponseDispoTourOrderItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the order."},"reference":{"type":"string","description":"The customer order number."},"externalReference":{"type":"string","description":"The internal reference for the order."},"subject":{"type":"string","description":"The order subject."},"createdAt":{"description":"Date when the order was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"project":{"type":"integer","description":"The id of the project."},"projectReferenceSign":{"type":"string","description":"The reference sign of the project."}}},"DispoTourFetchDataResponseDispoTourSubStopItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the sub stop."},"tourId":{"type":"integer","description":"The internal id of the tour from the sub stop."},"etc":{"type":"integer","description":"The estimated time in seconds to completion of the sub stop."}}},"DispoTourFetchDataResponseDispoTourCostItem":{"type":"object","description":"","properties":{"distance":{"type":"integer","description":""},"idleDuration":{"type":"integer","description":""},"driveDuration":{"type":"integer","description":""},"workDuration":{"type":"integer","description":""},"breakDuration":{"type":"integer","description":""},"sleepDuration":{"type":"integer","description":""},"benchmarkCosts":{"type":"array","items":{"type":"integer"},"description":""},"totalDriveKmCost":{"type":"number","description":""},"totalDriveTimeCost":{"type":"number","description":""},"totalTollCost":{"type":"number","description":""},"totalWorkTimeCost":{"type":"number","description":""},"totalIdleTimeCost":{"type":"number","description":""},"totalAdditionalCost":{"type":"number","description":""},"totalCost":{"type":"number","description":""},"dates":{"description":"","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourCostByDateItem"},{"description":""}]}}}},"DispoTourFetchDataResponseDispoTourCostByDateItem":{"type":"object","description":"","properties":{"distance":{"type":"integer","description":""},"idleDuration":{"type":"integer","description":""},"driveDuration":{"type":"integer","description":""},"workDuration":{"type":"integer","description":""},"breakDuration":{"type":"integer","description":""},"sleepDuration":{"type":"integer","description":""},"benchmarkCosts":{"type":"array","items":{"type":"integer"},"description":""},"totalDriveKmCost":{"type":"number","description":""},"totalDriveTimeCost":{"type":"number","description":""},"totalTollCost":{"type":"number","description":""},"totalWorkTimeCost":{"type":"number","description":""},"totalIdleTimeCost":{"type":"number","description":""},"totalAdditionalCost":{"type":"number","description":""},"totalCost":{"type":"number","description":""},"date":{"description":"","type":"object","$ref":"#\/components\/schemas\/Date"}}},"DispoTourFetchDataResponseDispoEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"}}},"StandardDispoTourFetchDataRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour. This Parameter is required."}}},"StandardDispoTourDeleteResponse":{"type":"object","description":"","properties":{"deletedIds":{"type":"array","items":{"type":"integer"},"description":"The tours that were deleted"}}},"StandardDispoTourDeleteRequest":{"type":"object","description":"","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"The internal ids of the tours to be deleted. This Parameter is required."}}},"StandardDispoTourDeleteStopResponse":{"type":"object","description":"","properties":{"deletedIds":{"type":"array","items":{"type":"integer"},"description":"The orders that were deleted"}}},"StandardDispoTourDeleteStopRequest":{"type":"object","description":"","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"The internal ids of the stops to be deleted. This Parameter is required."}}},"StandardDispoTourSetStatusResponse":{"type":"object","description":"","properties":{"data":{"description":"The tour.","type":"object","$ref":"#\/components\/schemas\/DispoTourSetStatusResponseDispoTourItem"}}},"DispoTourSetStatusResponseDispoTourItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour."},"startDate":{"description":"The start date of the tour.","type":"object","$ref":"#\/components\/schemas\/Date"},"team":{"type":"string","description":"The name of the team."},"teamId":{"type":"integer","description":"The internal id of the team."},"district":{"type":"string","description":"The name of the district."},"districtId":{"type":"integer","description":"The internal id of the district."},"numStops":{"type":"integer","description":"The amount of stops of the tour."},"numOrders":{"type":"integer","description":"The amount of orders of the tour."},"duration":{"type":"integer","description":"The total duration of the tour."},"distance":{"type":"integer","description":"The total distance of the tour."},"status":{"type":"string","description":"The status of the tour."},"reference":{"type":"integer","description":"The reference of the tour."},"dispoType":{"type":"string","description":"The name of the dispo type."},"dispoTypeId":{"type":"integer","description":"The internal id of the dispoType."},"stops":{"description":"The stops of the tour.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourStopItem"},{"description":""}]}},"startTime":{"description":"The start time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardDispoTourSetStatusRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour. This Parameter is required."},"status":{"type":"string","description":"The status to be set. This Parameter is required.\n\n| Values         |\n| -------------- |\n| NEW            |\n| CALCULATED     |\n| FIXED          |\n| READY          |\n| STARTED        |\n| FINISHED       |"}}},"StandardDispoTourOptimizeResponse":{"type":"object","description":"","properties":{"jobId":{"type":"integer","description":"The id of the optimization job. (The status of the job can be queried via the job API)"}}},"StandardDispoTourOptimizeRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour. This Parameter is required."},"fromSequence":{"type":"integer","description":"Optimize the tour from this stop sequence on."},"toSequence":{"type":"integer","description":"Optimize the tour until this stop sequence."}}},"StandardDispoTourCalculateResponse":{"type":"object","description":"","properties":{"jobId":{"type":"integer","description":"The id of the calculation job. (The status of the job can be queried via the job API)"}}},"StandardDispoTourCalculateRequest":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour. This Parameter is required."}}},"StandardDispoTourAssignOrderResponse":{"type":"object","description":"","properties":{"data":{"description":"The tour.","type":"object","$ref":"#\/components\/schemas\/DispoTourAssignOrderResponseDispoTourItem"},"newStop":{"description":"The internal id of the new stop created for the order.","type":"object","$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourStopItem"}}},"DispoTourAssignOrderResponseDispoTourItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour."},"startDate":{"description":"The start date of the tour.","type":"object","$ref":"#\/components\/schemas\/Date"},"team":{"type":"string","description":"The name of the team."},"teamId":{"type":"integer","description":"The internal id of the team."},"district":{"type":"string","description":"The name of the district."},"districtId":{"type":"integer","description":"The internal id of the district."},"numStops":{"type":"integer","description":"The amount of stops of the tour."},"numOrders":{"type":"integer","description":"The amount of orders of the tour."},"duration":{"type":"integer","description":"The total duration of the tour."},"distance":{"type":"integer","description":"The total distance of the tour."},"status":{"type":"string","description":"The status of the tour."},"reference":{"type":"integer","description":"The reference of the tour."},"dispoType":{"type":"string","description":"The name of the dispo type."},"dispoTypeId":{"type":"integer","description":"The internal id of the dispoType."},"stops":{"description":"The stops of the tour.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourStopItem"},{"description":""}]}},"startTime":{"description":"The start time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardDispoTourAssignOrderRequest":{"type":"object","description":"","properties":{"orderId":{"type":"integer","description":"The internal id of the order to be added to the tour."},"orderExternalReference":{"type":"string","description":"The external reference for the order to be added to the tour (Used if orderId not provided)."},"tourId":{"type":"integer","description":"The internal id of the tour to be updated. This parameter is required."},"beforeStopId":{"type":"integer","description":"The id of the stop before which to insert the new order."},"afterStopId":{"type":"integer","description":"The id of the stop after which to insert the new order."}}},"StandardDispoTourUpsertStopResponse":{"type":"object","description":"","properties":{"createdStops":{"description":"The created stops.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertStopResponseDispoTourStopItem"},{"description":""}]}},"updatedStops":{"description":"The changed stops.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertStopResponseDispoTourStopItem"},{"description":""}]}},"deletedStops":{"description":"The deleted stops.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertStopResponseDispoTourStopItem"},{"description":""}]}}}},"DispoTourUpsertStopResponseDispoTourStopItem":{"type":"object","description":"","properties":{"tourId":{"type":"integer","description":"The id of the tour the stop is assigned."},"id":{"type":"integer","description":"The internal id of the stop."},"sequence":{"type":"integer","description":"The sequence of the stop."},"type":{"type":"string","description":"The stop type.\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| HOME                     | Home Stop used to identify the start and end of the tour            |\n| ORDER                     | Use this type for a normal stop with orders                               |\n| TBREAK                    | Break Stop                           |\n| HOTEL                 | Used for overnight stays                              |\n| FUEL                 | Used for fueling                              |\n| LOAD                 | Used for pickup and delivery orders.                              |\n| UNLOAD                 | Used for pickup and delivery orders.                     |"},"name":{"type":"string","description":"The name address addition."},"name2":{"type":"string","description":"The name2 address addition."},"name3":{"type":"string","description":"The name3 address addition."},"street":{"type":"string","description":"The street."},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"provinceCode":{"type":"string","description":"The province code."},"latLng":{"description":"The geo-coordinates of the stop.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"contactPersonName":{"type":"string","description":"The contact person name."},"contactPersonEmail":{"type":"string","description":"The contact person e-mail."},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number."},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile number."},"noteDriver":{"type":"string","description":"A note for the driver. This info is shown to the driver in his app."},"notePlanner":{"type":"string","description":"A note for the planner."},"additionalCosts":{"type":"number","description":"Field for additional costs."},"duration":{"type":"integer","description":"The duration in seconds for the new stop.\nUse this only when the duration is not equal with the work duration of the orders.\nIf the stop is a break it\u0027s used as break duration, if not it\u0027s the work duration."},"fixedArrivalDate":{"description":"Fixed arrival date.","type":"object","$ref":"#\/components\/schemas\/Date"},"fixedArrivalTime":{"description":"Fixed arrival time.","type":"object","$ref":"#\/components\/schemas\/Time"},"fixedDepartureDate":{"description":"Fixed departure date.","type":"object","$ref":"#\/components\/schemas\/Date"},"fixedDepartureTime":{"description":"Fixed departure time.","type":"object","$ref":"#\/components\/schemas\/Time"}}},"DispoTourUpsertStopRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                 |\n|----------------|-----------------------------|\n| id             | The internal tour stop ID  |"},"data":{"description":"The stop record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/DispoTourUpsertStopRequestRecordData"}}},"DispoTourUpsertStopRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the stop."},"tourId":{"type":"integer","description":"The id of the tour the stop is assigned. (mandatory)"},"sequence":{"type":"integer","description":"The sequence of the stop."},"type":{"type":"string","description":"The stop type.\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| HOME                     | Home Stop used to identify the start and end of the tour            |\n| ORDER                     | Use this type for a normal stop with orders                               |\n| TBREAK                    | Break Stop                           |\n| HOTEL                 | Used for overnight stays                              |\n| FUEL                 | Used for fueling                              |\n| LOAD                 | Used for pickup and delivery orders.                              |\n| UNLOAD                 | Used for pickup and delivery orders.                     |"},"name":{"type":"string","description":"The name address addition. (max. 255 characters)"},"name2":{"type":"string","description":"The name2 address addition. (max. 255 characters)"},"name3":{"type":"string","description":"The name3 address addition. (max. 255 characters)"},"street":{"type":"string","description":"The street. (max. 255 characters)"},"zipCode":{"type":"string","description":"The zip code."},"city":{"type":"string","description":"The city."},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code."},"provinceCode":{"type":"string","description":"The province code."},"latLng":{"description":"The geo-coordinates of the stop.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"orderIds":{"type":"array","items":{"type":"integer"},"description":"The internal id of the order to be added to the tour."},"contactPersonName":{"type":"string","description":"The contact person name. (max. 255 characters)"},"contactPersonEmail":{"type":"string","description":"The contact person e-mail. (max. 255 characters)"},"contactPersonPhoneNumber":{"type":"string","description":"The contact person phone number. (max. 64 characters)"},"contactPersonMobileNumber":{"type":"string","description":"The contact person mobile number. (max. 64 characters)"},"duration":{"type":"integer","description":"The duration in seconds for the new stop.\nUse this only when the duration is not equal with the work duration of the orders."},"breakDuration":{"type":"integer","description":"The duration in seconds for the break."},"noteDriver":{"type":"string","description":"A note for the driver. This info is shown to the driver in his app."},"notePlanner":{"type":"string","description":"A note for the planner."},"additionalCosts":{"type":"number","description":"Field for additional costs."},"fixedArrivalDate":{"description":"Fixed arrival date. If a stop has a fixed date for arrival put this info here.","type":"object","$ref":"#\/components\/schemas\/Date"},"fixedArrivalTime":{"description":"Fixed arrival time. If a stop has a fixed time for arrival put this info here.","type":"object","$ref":"#\/components\/schemas\/Time"},"fixedDepartureDate":{"description":"Fixed departure date. If a stop has a fixed date for departure put this info here.","type":"object","$ref":"#\/components\/schemas\/Date"},"fixedDepartureTime":{"description":"Fixed departure time. If a stop has a fixed time for departure put this info here.","type":"object","$ref":"#\/components\/schemas\/Time"},"beforeStopId":{"type":"integer","description":"The id of the stop, the new stop should be inserted before."},"afterStopId":{"type":"integer","description":"The id of the stop, the new stop should be inserted after."}}},"StandardDispoTourUpsertStopRequest":{"type":"object","description":"","properties":{"records":{"description":"The stop records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertStopRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardDispoTourUpsertResponse":{"type":"object","description":"","properties":{"createdTours":{"description":"The created tours.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertResponseDispoTourItem"},{"description":""}]}},"updatedTours":{"description":"The changed tours.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertResponseDispoTourItem"},{"description":""}]}},"deletedTours":{"description":"The deleted tours.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertResponseDispoTourItem"},{"description":""}]}}}},"DispoTourUpsertResponseDispoTourItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour."},"startDate":{"description":"The start date of the tour.","type":"object","$ref":"#\/components\/schemas\/Date"},"team":{"type":"string","description":"The name of the team."},"teamId":{"type":"integer","description":"The internal id of the team."},"district":{"type":"string","description":"The name of the district."},"districtId":{"type":"integer","description":"The internal id of the district."},"numStops":{"type":"integer","description":"The amount of stops of the tour."},"numOrders":{"type":"integer","description":"The amount of orders of the tour."},"duration":{"type":"integer","description":"The total duration of the tour."},"distance":{"type":"integer","description":"The total distance of the tour."},"status":{"type":"string","description":"The status of the tour."},"reference":{"type":"integer","description":"The reference of the tour."},"dispoType":{"type":"string","description":"The name of the dispo type."},"dispoTypeId":{"type":"integer","description":"The internal id of the dispoType."},"stops":{"description":"The stops of the tour.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourFetchDataResponseDispoTourStopItem"},{"description":""}]}},"startTime":{"description":"The start time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"endTime":{"description":"The end time of the tour.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"DispoTourUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                 |\n|----------------|-----------------------------|\n| id             | The internal tour ID  |\n| reference      | The reference            |"},"data":{"description":"The tour record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/DispoTourUpsertRequestRecordData"}}},"DispoTourUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tour."},"reference":{"type":"integer","description":"The internal reference of the tour."},"startDate":{"description":"The start date of the tour.","type":"object","$ref":"#\/components\/schemas\/Date"},"team":{"type":"integer","description":"The id of the team."},"teamExternalReference":{"type":"string","description":"The external reference for the team (Used if team not provided)."},"district":{"type":"integer","description":"The id of the district."},"districtReference":{"type":"string","description":"The reference of the district (Used if district not provided)."},"status":{"type":"string","description":"The status of the tour."},"orders":{"type":"array","items":{"type":"integer"},"description":"The order ids to be added to the tour."},"orderExternalReferences":{"type":"array","items":{"type":"string"},"description":"The order references to be added to the tour (Used if orders not provided)."}}},"StandardDispoTourUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoTourUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all tours missing from this request?"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardToolManufacturerFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tool categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolManufacturerFetchRequestToolManufacturerListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tool categories."}}},"ToolManufacturerFetchRequestToolManufacturerListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool manufacturer."},"name":{"type":"string","description":"The name of the tool manufacturer."},"description":{"type":"string","description":"The description of the tool manufacturer."},"createdAt":{"description":"Date when the tool manufacturer was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardToolManufacturerFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardToolCostHistoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tool cost settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolCostHistoryFetchResponseToolCostHistoryItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tool cost settings."}}},"ToolCostHistoryFetchResponseToolCostHistoryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool cost setting."},"tool":{"description":"The tool that this setting is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseToolListItem"},"toolCategory":{"description":"The tool category that this setting is assigned to or the historic tool category for the tool if a tool is given.","type":"object","$ref":"#\/components\/schemas\/StandardToolCategoryBaseToolCategoryListItem"},"costTypeSource":{"type":"string","description":"The source of the cost type for this setting."},"costType":{"type":"string","description":"The cost type for this setting."},"dailyRateSource":{"type":"string","description":"The Source of the daily rate for this setting."},"dailyRate":{"type":"number","description":"The daily rate for the tool for this setting."},"hourlyRate":{"type":"number","description":"The hourly rate for the tool for this setting."},"fallbackProject":{"type":"number","description":"The fallback project for this setting."},"automaticBooking":{"type":"number","description":"This indicates whether this setting should be used to create cost bookings automatically."},"from":{"description":"First date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Last date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardToolCategoryBaseToolCategoryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool category."},"name":{"type":"string","description":"The name of the tool category."},"description":{"type":"string","description":"The description of the tool category."},"externalId":{"type":"string","description":"The external id of the tool category."},"createdAt":{"description":"Date when the tool category was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"ToolCostHistoryFetchRequestToolCostHistoryFilter":{"type":"object","description":"","properties":{"byToolId":{"type":"integer","description":"Filters the tool cost settings based on the tool id.\nOnly one filter will be applied."},"byToolCategoryId":{"type":"integer","description":"Filters the tool cost settings based on the tool category id.\nOnly one filter will be applied."}}},"StandardToolCostHistoryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The tool cost setting filter.","type":"object","$ref":"#\/components\/schemas\/ToolCostHistoryFetchRequestToolCostHistoryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardToolCostHistoryUpsertResponse":{"type":"object","description":"","properties":{"createdToolCostSettings":{"description":"The created tool cost settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolCostHistoryUpsertResponseToolCostHistoryItem"},{"description":""}]}}}},"ToolCostHistoryUpsertResponseToolCostHistoryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool cost setting."},"tool":{"description":"The tool that this setting is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardToolBaseToolListItem"},"toolCategory":{"description":"The tool category that this setting is assigned to or the historic tool category for the tool if a tool is given.","type":"object","$ref":"#\/components\/schemas\/StandardToolCategoryBaseToolCategoryListItem"},"costTypeSource":{"type":"string","description":"The source of the cost type for this setting."},"costType":{"type":"string","description":"The cost type for this setting."},"dailyRateSource":{"type":"string","description":"The Source of the daily rate for this setting."},"dailyRate":{"type":"number","description":"The daily rate for the tool for this setting."},"hourlyRate":{"type":"number","description":"The hourly rate for the tool for this setting."},"fallbackProject":{"type":"number","description":"The fallback project for this setting."},"automaticBooking":{"type":"number","description":"This indicates whether this setting should be used to create cost bookings automatically."},"from":{"description":"First date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Last date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"ToolCostHistoryUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal tool cost setting ID        |"},"data":{"description":"The tool cost setting record.","type":"object","$ref":"#\/components\/schemas\/ToolCostHistoryUpsertRequestRecordData"}}},"ToolCostHistoryUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tool cost setting."},"toolId":{"type":"integer","description":"The internal id of the tool if the setting is meant to be for a tool."},"toolCategoryId":{"type":"integer","description":"The internal id of the tool category if the setting is meant to be for a tool category."},"from":{"description":"The first date the tool cost setting is valid.","type":"object","$ref":"#\/components\/schemas\/Date"},"costTypeSource":{"type":"string","description":"The source for the cost type.\n\n| Value | Description |\n|------|-------------|\n| TOOL | cost type is defined at this entry |\n| TOOL_CATEGORY | cost type is defined at the tool category |\n\nThe value \u0022TOOL_CATEGORY\u0022 can only be set if a toolId is given. This will link the settings cost type to the one\nof the tools category.\nIf a toolId is given the value can also be set to \u0022TOOL\u0022. This will set the cost type for\nthis specific tool. In that case a costTypeId\/costTypeReference also has to be given.\nFor a tool category this value is obsolete."},"costTypeId":{"type":"integer","description":"The internal cost type id for this setting.\nValue is needed for settings if a toolCategoryId is given or the costTypeSource is set to \u0022TOOL\u0022.\nEither costTypeId or costTypeReference can be supplied."},"costTypeReference":{"type":"integer","description":"The cost type reference for this setting.\nValue is needed for settings if a toolCategoryId is given or the costTypeSource is set to \u0022TOOL\u0022.\nEither costTypeId or costTypeReference can be supplied."},"dailyRateSource":{"type":"string","description":"The source for the daily rate.\n\n| Value | Description |\n|------|-------------|\n| TOOL | daily rate is defined at this entry |\n| TOOL_CATEGORY | daily rate is defined at the tool category |\n\nThe value \u0022TOOL_CATEGORY\u0022 can only be set if a toolId is given. This will link the settings daily rate to the one\nof the tools category.\nIf a toolId is given the value can also be set to \u0022TOOL\u0022. This will set the daily rate for\nthis specific tool. In that case a daily rate also has to be given.\nFor a tool category this value is obsolete."},"dailyRate":{"type":"number","description":"The daily rate for this setting.\nValue is can be set for settings if a toolCategoryId is given or the dailyRateSource is set to \u0022TOOL\u0022."},"hourlyRate":{"type":"number","description":"The hourly rate for this setting.\nValue is can be set for settings if a toolCategoryId is given or the dailyRateSource is set to \u0022TOOL\u0022.\n\nThis value is only used for form data bookings."},"fallbackProjectId":{"type":"integer","description":"This project will be used for cost bookings that have no assigned project."},"automaticBooking":{"type":"boolean","description":"This value indicates whether this setting should be used to create automatic bookings.\nCan be set to false if this setting is supposed to be used for form data bookings."}}},"StandardToolCostHistoryUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The tool cost setting data.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/ToolCostHistoryUpsertRequestRecord"},{"description":""}]}},"startCostCalculation":{"type":"boolean","description":"If true a cost calculation will be started from the start date of this setting on."},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardDispoQualificationFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The dispo qualifications.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/DispoQualificationFetchRequestDispoQualificationListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available dispo qualifications."}}},"DispoQualificationFetchRequestDispoQualificationListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the dispo qualification."},"name":{"type":"string","description":"The name of the dispo qualification."},"createdAt":{"description":"Date when the dispo qualification was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardDispoQualificationFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardWageGroupEmployeeHistoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The wage group employee settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupEmployeeHistoryBaseWageGroupEmployeeHistoryItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available wage group employee settings."}}},"StandardWageGroupEmployeeHistoryBaseWageGroupEmployeeHistoryItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the wage group employee setting."},"employee":{"description":"The employee that this setting is assigned to.","type":"object","$ref":"#\/components\/schemas\/StandardWageGroupEmployeeHistoryBaseEmployeeItem"},"department":{"description":"The department that this setting is assigned to or the historic department for the employee if a employee is\ngiven.","type":"object","$ref":"#\/components\/schemas\/DepartmentFetchResponseDepartmentItem"},"wageGroupSource":{"type":"string","description":"The source of the wage group for this setting."},"wageGroup":{"description":"The name of the wage group for this setting.","type":"object","$ref":"#\/components\/schemas\/StandardWageGroupBaseWageGroupListItem"},"fallbackProject":{"type":"number","description":"The fallback project for this setting."},"automaticBooking":{"type":"number","description":"This indicates whether this setting should be used to create cost bookings automatically."},"from":{"description":"First date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"},"to":{"description":"Last date that this setting is valid for.","type":"object","$ref":"#\/components\/schemas\/Date"}}},"StandardWageGroupEmployeeHistoryBaseEmployeeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal employee ID."},"reference":{"type":"string","description":"The personal number. (max. 20 characters)"},"cardNumber":{"type":"string","description":"The driver card number."},"importSource":{"type":"string","description":"External data source from which this employee originates. (max. 16 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"firstName":{"type":"string","description":"The first name of the employee. (max. 128 characters)"},"lastName":{"type":"string","description":"The last name of the Employee. (max. 128 characters)"},"name":{"type":"string","description":"This field is deprecated. Please use firstName\nThe complete Name of the Employee\nIf first name or last name is set, name is ignored."}}},"WageGroupEmployeeHistoryFetchRequestWageGroupEmployeeHistoryFilter":{"type":"object","description":"","properties":{"byEmployeeId":{"type":"integer","description":"Filters the wage group employee settings based on the employee id.\nOnly one filter will be applied."},"byDepartmentId":{"type":"integer","description":"Filters the wage group employee settings based on the department id.\nOnly one filter will be applied."}}},"StandardWageGroupEmployeeHistoryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The wage group employee setting filter.","type":"object","$ref":"#\/components\/schemas\/WageGroupEmployeeHistoryFetchRequestWageGroupEmployeeHistoryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardWageGroupEmployeeHistoryUpsertResponse":{"type":"object","description":"","properties":{"createdWageGroupEmployeeSettings":{"description":"The created wage group employee settings.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupEmployeeHistoryBaseWageGroupEmployeeHistoryItem"},{"description":""}]}}}},"WageGroupEmployeeHistoryUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                |\n|----------------|-----------------------------|\n| id             | The internal employee cost setting ID        |"},"data":{"description":"The wage group employee setting record.","type":"object","$ref":"#\/components\/schemas\/WageGroupEmployeeHistoryUpsertRequestRecordData"}}},"WageGroupEmployeeHistoryUpsertRequestRecordData":{"type":"object","description":"","properties":{"employeeId":{"type":"integer","description":"The internal id of the employee if the setting is meant to be for a employee."},"departmentId":{"type":"integer","description":"The internal id of the department if the setting is meant to be for a department."},"from":{"description":"The first date the setting is valid.","type":"object","$ref":"#\/components\/schemas\/Date"},"wageGroupSource":{"type":"string","description":"The source for the wage group.\n\n| Value | Description |\n|------|-------------|\n| EMPLOYEE | wage group is defined at this entry |\n| DEPPARTMENT | wage group is defined at the department |\n\nThe value \u0022DEPARTMENT\u0022 can only be set if an employeeId is given. This will link the settings wage group to the one\nof the departments.\nIf an employeeId is given the value can also be set to \u0022EMPLOYEE\u0022. This will set the wage group for\nthis specific employee. In that case a wage group also has to be given.\nFor a department this value is obsolete."},"wageGroupId":{"type":"integer","description":"The wage group for this setting.\nValue is needed for settings if a departmentId is given or the wageGroupSource is set to \u0022EMPLOYEE\u0022."},"fallbackProjectId":{"type":"integer","description":"This project will be used for cost bookings that have no assigned project."},"automaticBooking":{"type":"boolean","description":"This value indicates whether this setting should be used to create automatic bookings.\nCan be set to false if this setting is supposed to be used for form data bookings."}}},"StandardWageGroupEmployeeHistoryUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The wage group employee setting data.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WageGroupEmployeeHistoryUpsertRequestRecord"},{"description":""}]}},"startCostCalculation":{"type":"boolean","description":"If true a cost calculation will be started from the start date of this setting on."},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardLocationFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tool categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/LocationFetchRequestLocationListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tool categories."}}},"LocationFetchRequestLocationListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the location category."},"name":{"type":"string","description":"The name of the location."},"externalId":{"type":"string","description":"The external ID of the location."},"createdAt":{"description":"Date when the location was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardLocationFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardLocationUpsertResponse":{"type":"object","description":"","properties":{"createdLocations":{"description":"The created locations.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardLocationBaseLocationItem"},{"description":""}]}},"updatedLocations":{"description":"The changed locations.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardLocationBaseLocationItem"},{"description":""}]}},"deletedLocations":{"description":"The deleted locations.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardLocationBaseLocationItem"},{"description":""}]}}}},"StandardLocationBaseLocationItem":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the location."},"externalId":{"type":"string","description":"The external id of the location. (max. 255 characters)"},"name":{"type":"string","description":"The name of the location. (max. 255 characters)"},"identifier":{"type":"string","description":"The internal id of the location. (max. 255 characters)"},"sequence":{"type":"integer","description":"The sequence of the location. This Parameter is optional. (Default: 0)"},"zipCode":{"type":"string","description":"The zip code in which the location is located. This Parameter is optional."},"city":{"type":"string","description":"The city in which the location is located. This Parameter is optional."},"street":{"type":"string","description":"The street in which the location is located. This Parameter is optional. (max. 255 characters)"},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code. This Parameter is optional."},"accountingClient":{"type":"string","description":"The accounting client of the location. This Parameter is optional. (max. 25 characters)"},"worktimeApprovalRuleId":{"type":"string","description":"The worktime approval rule id of the location. This Parameter is optional."},"stampApplicationApprovalRuleId":{"type":"string","description":"The stamp approval rule id of the location. This Parameter is optional."},"absenceApplicationApprovalRuleId":{"type":"string","description":"The absence approvale rule id of the location. This Parameter is optional."},"sicknessApplicationApprovalRuleId":{"type":"string","description":"The sickness approval rule id of the location. This Parameter is optional."},"accountingEntryApplicationApprovalRuleId":{"type":"string","description":"The accounting entry approval rule id of the location. This Parameter is optional."},"createdAt":{"description":"Date when the location was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"LocationUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value          | Description                      |\n|----------------|----------------------------------|\n| id             | The internal location id         |\n| externalid     | The external ID of the location  |"},"data":{"description":"The locations record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/LocationUpsertRequestRecordData"}}},"LocationUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the location."},"externalId":{"type":"string","description":"The external id of the location. (max. 255 characters)"},"name":{"type":"string","description":"The name of the location. (max. 255 characters)"},"identifier":{"type":"string","description":"The internal id of the location. (max. 255 characters)"},"sequence":{"type":"integer","description":"The sequence of the location. This Parameter is optional. (Default: 0)"},"zipCode":{"type":"string","description":"The zip code in which the location is located. This Parameter is optional."},"city":{"type":"string","description":"The city in which the location is located. This Parameter is optional."},"street":{"type":"string","description":"The street in which the location is located. This Parameter is optional. (max. 255 characters)"},"countryCode":{"type":"string","description":"The two-digit ISO 3166 country code. This Parameter is optional."},"accountingClient":{"type":"string","description":"The accounting client of the location. This Parameter is optional. (max. 25 characters)"},"worktimeApprovalRuleId":{"type":"string","description":"The worktime approval rule id of the location. This Parameter is optional."},"stampApplicationApprovalRuleId":{"type":"string","description":"The stamp approval rule id of the location. This Parameter is optional."},"absenceApplicationApprovalRuleId":{"type":"string","description":"The absence approvale rule id of the location. This Parameter is optional."},"sicknessApplicationApprovalRuleId":{"type":"string","description":"The sickness approval rule id of the location. This Parameter is optional."},"accountingEntryApplicationApprovalRuleId":{"type":"string","description":"The accounting entry approval rule id of the location. This Parameter is optional."},"createdAt":{"description":"Date when the location was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"StandardLocationUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/LocationUpsertRequestRecord"},{"description":""}]}},"deleteMissing":{"type":"boolean","description":"Do you want to delete all locations missing from this request? This Parameter is optional. (Default: false)"},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardWebhookFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The webhooks.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookBaseWebhookItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of records."}}},"StandardWebhookBaseWebhookItem":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the webhook."},"application":{"description":"The application.","type":"object","$ref":"#\/components\/schemas\/StandardWebhookApplicationBaseWebhookApplicationReference"},"externalId":{"type":"string","description":"The external id of the webhook."},"externalName":{"type":"string","description":"The external name."},"resolvedUrl":{"type":"string","description":"The resolved url of the webhook."},"url":{"type":"string","description":"The configured url."},"configuration":{"type":"array","items":{"type":"integer"},"description":"The configuration as a JSON Object."},"active":{"type":"string","description":"Is the webhook active?"},"sequence":{"type":"integer","description":"The sequence."}}},"StandardWebhookApplicationBaseWebhookApplicationReference":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the application."},"name":{"type":"string","description":"The name of the application."},"externalId":{"type":"string","description":"The external id of the application."}}},"WebhookFetchRequestWebhookFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the internal IDs."},"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the external IDs."},"byApplicationIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the internal application IDs."},"byApplicationExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the external application IDs."}}},"StandardWebhookFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The filter. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/WebhookFetchRequestWebhookFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records. This Parameter is optional."}}},"StandardWebhookUpsertResponse":{"type":"object","description":"","properties":{"createdWebhooks":{"description":"The created webhooks.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookBaseWebhookItem"},{"description":""}]}},"updatedWebhooks":{"description":"The changed webhooks.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookBaseWebhookItem"},{"description":""}]}}}},"WebhookUpsertRequestRecord":{"type":"object","description":"","properties":{"keyField":{"type":"string","description":"This parameter specifies the name of the unique key used to distinctly assign each dataset in the API.\n\n| Value           | Description                       |\n|----------------|------------------------------------|\n| id             | The internal webhook ID            |\n| externalid     | The external webhook ID            |"},"data":{"description":"The webhook record.\n\nFor updates, only the updated fields need to be specified.\n\nThe primary key to be used must **always** be specified.","type":"object","$ref":"#\/components\/schemas\/WebhookUpsertRequestRecordData"}}},"WebhookUpsertRequestRecordData":{"type":"object","description":"","properties":{"id":{"type":"string","description":"The internal id of the webhook."},"externalId":{"type":"string","description":"The external id of the webhook. (max. 255 characters)"},"externalName":{"type":"string","description":"The external name of the webhook. (max. 255 characters)"},"applicationId":{"type":"string","description":"The internal id of the application."},"applicationExternalId":{"type":"string","description":"The external id of the application."},"configuration":{"type":"array","items":{"type":"integer"},"description":"The configuration as a JSON Object."},"active":{"type":"boolean","description":"The active flag."},"url":{"type":"string","description":"The url of the webhook. (max. 255 characters)\n\nThe url may be relative to the application base url."},"sequence":{"type":"integer","description":"The sequence."},"applicationName":{"type":"string","description":"The name of the application, if it were to be created in combination of applicationExternalId."},"applicationBaseUrl":{"type":"string","description":"The base url of the application, if it were to be created in combination of applicationExternalId."}}},"StandardWebhookUpsertRequest":{"type":"object","description":"","properties":{"records":{"description":"The records. This Parameter is optional.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/WebhookUpsertRequestRecord"},{"description":""}]}},"dryRun":{"type":"boolean","description":"Simulate the operation.\n(No records will be created or changed) This Parameter is optional."}}},"StandardWebhookDeleteResponse":{"type":"object","description":"","properties":{"deletedWebhooks":{"description":"The webhooks that were deleted.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookBaseWebhookItem"},{"description":""}]}}}},"WebhookDeleteRequestWebhookFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the internal IDs."},"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters based on the external IDs."}}},"StandardWebhookDeleteRequest":{"type":"object","description":"","properties":{"filter":{"description":"The beacon filter. This parameter is required.","type":"object","$ref":"#\/components\/schemas\/WebhookDeleteRequestWebhookFilter"},"dryRun":{"type":"boolean","description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional."}}},"StandardTrackerCategoryFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The tracker categories.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/TrackerCategoryFetchRequestTrackerCategoryListItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available tracker categories."}}},"TrackerCategoryFetchRequestTrackerCategoryListItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal id of the tracker category."},"name":{"type":"string","description":"The name of the tracker category."},"description":{"type":"string","description":"The description of the tracker category."},"externalId":{"type":"string","description":"The external ID of the tracker category."},"costCenter":{"type":"string","description":"The cost center of the tracker category."},"createdAt":{"description":"Date when the tracker category was created.","type":"object","$ref":"#\/components\/schemas\/DateTime"}}},"TrackerCategoryFetchRequestTrackerCategoryFilter":{"type":"object","description":"","properties":{"byExternalIds":{"type":"array","items":{"type":"string"},"description":"Filters the tracker categories based on the externalIds."}}},"StandardTrackerCategoryFetchRequest":{"type":"object","description":"","properties":{"filter":{"description":"The tracker category filter.","type":"object","$ref":"#\/components\/schemas\/TrackerCategoryFetchRequestTrackerCategoryFilter"},"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"StandardMaintenanceTypeFetchResponse":{"type":"object","description":"","properties":{"data":{"description":"The maintenance types.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceTypeBaseMaintenanceTypeItem"},{"description":""}]}},"offset":{"type":"integer","description":"Number of skipped records."},"totalCount":{"type":"integer","description":"Total number of available maintenance types."}}},"StandardMaintenanceTypeBaseMaintenanceTypeItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The maintenance type id."},"name":{"type":"string","description":"The maintenance type name."}}},"StandardMaintenanceTypeFetchRequest":{"type":"object","description":"","properties":{"offset":{"type":"integer","description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set."},"limit":{"type":"integer","description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records."}}},"BeaconMapFetchRequestBeaconFilter":{"type":"object","description":"","properties":{"byIds":{"type":"array","items":{"type":"integer"},"description":"Filters the beacons based on the IDs."},"byUuids":{"type":"array","items":{"type":"string"},"description":"Filters the beacons based on the UUIDs."},"byToolIds":{"type":"array","items":{"type":"string"},"description":"Filters the beacons based on the tool IDs."}}},"StandardBeaconMapViewRequest":{"type":"object","description":"","properties":{"controls":{"type":"boolean","description":"Select whether the controls are displayed. This Parameter is optional."},"center":{"description":"Set the center of the map. This Parameter is optional.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"zoom":{"type":"integer","description":"Set zoom level. This Parameter is optional. This Parameter is optional."},"logo":{"type":"string","description":"Display the logo.\n\n| Value            | Description         |\n|-----------------|---------------------|\n| GEOCAPTURE      | geoCapture-Logo     |\n| CUSTOMER        | Customer-Logo       |"},"beacons":{"description":"Filter for beacons. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/BeaconMapFetchRequestBeaconFilter"},"estimated_position":{"type":"boolean","description":"Show estimated position of the beacon."}}},"StandardBeaconMapFetchResponse":{"type":"object","description":"","properties":{"beacons":{"description":"The beacons.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/BeaconMapFetchResponseBeaconItem"},{"description":""}]}},"autoRefresh":{"type":"integer","description":"The configured refresh interval in seconds."}}},"BeaconMapFetchResponseBeaconItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal ID."},"uuid":{"type":"string","description":"The beacon UUID as hexadecimal value."},"macAddress":{"type":"string","description":"The beacon MAC address."},"name":{"type":"string","description":"The name of the beacon. (max. 255 characters)"},"objectIdentifier":{"type":"string","description":"External, customer specific ID of the object the beacon is attached to. (max. 64 characters)"},"objectSerialNumber":{"type":"string","description":"Serial number of object, the beacon is attached to. (max. 128 characters)"},"latLng":{"description":"The current position.","type":"object","$ref":"#\/components\/schemas\/ComponentGeocodingLatLngInterface"},"lastSignalAt":{"description":"Time of the last signal.","type":"object","$ref":"#\/components\/schemas\/DateTime"},"lastTracker":{"description":"Previous tracker.","type":"object","$ref":"#\/components\/schemas\/BeaconMapFetchResponseTrackerItem"},"iconUrl":{"type":"string","description":"The URL for the icon."}}},"BeaconMapFetchResponseTrackerItem":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"The internal vehicle ID."},"identifier":{"type":"string","description":"The customer-specific ID. (max. 64 characters)"},"inventoryNumber":{"type":"string","description":"The inventory number. (max. 128 characters)"},"licenseNumber":{"type":"string","description":"The vehicle license plate. (max. 255 characters)"},"identificationNumber":{"type":"string","description":"The vehicle identification number. (max. 24 characters)"},"importSource":{"type":"string","description":"External data source from which this vehicle originates. (max. 64 characters)"},"importKey":{"type":"string","description":"External ID from the respective data source. (max. 64 characters)"},"name":{"type":"string","description":"The vehicle name. (max. 255 characters)"}}},"StandardBeaconMapFetchRequest":{"type":"object","description":"","properties":{"beacons":{"description":"Filter for beacons. This Parameter is required.","type":"object","$ref":"#\/components\/schemas\/BeaconMapFetchRequestBeaconFilter"},"estimated_position":{"type":"boolean","description":"Show estimated position of the beacon."}}},"StandardCoreTypeDynamicWeekdayTimeDay":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}},"StandardCoreTypeDynamicWeekdayTimes":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}},"StandardCoreTypeDynamicWeekdayTime":{"example":"{\u0022MO\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]],\u0022WE\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]],\u0022FR\u0022:[[\u002208:00\u0022,\u002213:00\u0022],[\u002215:00\u0022,\u002218:00\u0022]]}","description":"Represents dynamic weekday times","type":"object","properties":{"MO":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}},"DI":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}},"MI":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}},"DO":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}},"FR":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}},"SA":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}},"SO":{"type":"array","example":[["08:00","13:00"]],"items":{"example":"[\u002208:00\u0022,\u002213:00\u0022]","description":"Represents dynamic weekday times","type":"array","items":{"type":"string"}}}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"apitoken","in":"query"}}},"paths":{"\/container\/fetch":{"get":{"tags":["Containers|Container"],"summary":"Fetch container list.","description":"This endpoint enables you to retrieve a list of containers that are under geoCapture\u0027s management.","operationId":"Containers|Container_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the containers based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byReferences][]","in":"query","required":false,"description":"Filters the containers based on the references.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerFetchResponse"}]}}}}}}},"\/container_inquiry\/fetch":{"get":{"tags":["Containers|Container inquiry"],"summary":"Fetch container inquiry list.","description":"This endpoint enables you to retrieve a list of container inquirys.","operationId":"Containers|Container inquiry_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the container inquirys based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byContainerIds][]","in":"query","required":false,"description":"Filters the container inquirys based on the container ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byContainerReferences][]","in":"query","required":false,"description":"Filters the container inquirys based on the container references.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byContainerTypeIds][]","in":"query","required":false,"description":"Filters the container inquirys based on the container type IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerInquiryFetchResponse"}]}}}}}}},"\/container_inquiry\/upsert":{"post":{"tags":["Containers|Container inquiry"],"summary":"Create\/Update container inquirys.","description":"This method can be used to create and update container inquirys.\n\nAn effort is made to locate an existing container inquiry using the selected primary key. If found, it will be modified,\nwhereas if no container inquiry is found, a new one is created. If the `deleteMissing` flag is set to true, all container inquirys absent\nfrom the request shall be purged. Please note that removed container inquirys may not be reinstated. You can enable the\n`dryRun` setting to simulate the action without altering any live data.","operationId":"Containers|Container inquiry_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerInquiryUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerInquiryUpsertRequest"}]}}}}}},"\/container_type\/fetch":{"get":{"tags":["Containers|Container type"],"summary":"Fetch container type list.","description":"This endpoint enables you to retrieve a list of container types that are under geoCapture\u0027s management.","operationId":"Containers|Container type_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardContainerTypeFetchResponse"}]}}}}}}},"\/cost_booking\/fetch":{"get":{"tags":["Cost control|Cost Booking"],"summary":"Fetch a list of previous cost exports.","description":"","operationId":"Cost control|Cost Booking_fetchAction","parameters":[{"name":"filter[fromDate]","in":"query","required":false,"description":"Filters the cost exports based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[toDate]","in":"query","required":false,"description":"Filters the cost exports based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostBookingFetchResponse"}]}}}}}}},"\/cost_booking\/createExport":{"post":{"tags":["Cost control|Cost Booking"],"summary":"Create an export for cost bookings.","description":"This endpoint allows you to create an export for cost booking data. You will receive a job id which will be used\nto collect the exported data after the job has finished.","operationId":"Cost control|Cost Booking_createExportAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostBookingCreateExportResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostBookingCreateExportRequest"}]}}}}}},"\/cost_booking\/startExport":{"get":{"tags":["Cost control|Cost Booking"],"summary":"Start the export of an already existing cost export.","description":"This export enables you to start a new export for the data that you already exported. This will only include the\ndata that was included in the original export.","operationId":"Cost control|Cost Booking_startExportAction","parameters":[{"name":"exportId","in":"query","required":false,"description":"The cost export ID.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostBookingStartExportResponse"}]}}}}}}},"\/cost_booking\/fetchExportData":{"get":{"tags":["Cost control|Cost Booking"],"summary":"Fetch cost export data.","description":"This endpoint enables you to retrieve the data for a cost export if its job is finished.","operationId":"Cost control|Cost Booking_fetchExportData","parameters":[{"name":"jobId","in":"query","required":true,"description":"The job id for the cost export.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentHttpFoundationResponse"}]}}}}}}},"\/tool_cost_setting\/fetch":{"get":{"tags":["Cost control|Tool cost setting"],"summary":"Fetch tools\/tool categories and their cost settings.","description":"This endpoint enables you to retrieve a list of tool cost settings.","operationId":"Cost control|Tool cost setting_fetchAction","parameters":[{"name":"filter[byToolId]","in":"query","required":false,"description":"Filters the tool cost settings based on the tool id.\nOnly one filter will be applied.","schema":{"type":"integer"}},{"name":"filter[byToolCategoryId]","in":"query","required":false,"description":"Filters the tool cost settings based on the tool category id.\nOnly one filter will be applied.","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolCostHistoryFetchResponse"}]}}}}}}},"\/tool_cost_setting\/upsert":{"post":{"tags":["Cost control|Tool cost setting"],"summary":"Create tool cost settings.","description":"This endpoint enables you to create new tool cost settings.","operationId":"Cost control|Tool cost setting_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolCostHistoryUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolCostHistoryUpsertRequest"}]}}}}}},"\/tracker_cost_setting\/fetch":{"get":{"tags":["Cost control|Tracker cost setting"],"summary":"Fetch trackers\/tracker categories and their cost settings.","description":"This endpoint enables you to retrieve a list of tracker cost settings.","operationId":"Cost control|Tracker cost setting_fetchAction","parameters":[{"name":"filter[byTrackerId]","in":"query","required":false,"description":"Filters the tracker cost settings based on the tracker id.\nOnly one filter will be applied.","schema":{"type":"integer"}},{"name":"filter[byTrackerCategoryId]","in":"query","required":false,"description":"Filters the tracker cost settings based on the tracker category id.\nOnly one filter will be applied.","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostDistributionHistoryFetchResponse"}]}}}}}}},"\/tracker_cost_setting\/upsert":{"post":{"tags":["Cost control|Tracker cost setting"],"summary":"Create tracker cost settings.","description":"This endpoint enables you to create new tracker cost settings.","operationId":"Cost control|Tracker cost setting_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostDistributionHistoryUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCostDistributionHistoryUpsertRequest"}]}}}}}},"\/wage_group\/fetch":{"get":{"tags":["Cost control|Wage group"],"summary":"Fetch wage group list.","description":"This endpoint enables you to retrieve a list of wage groups.","operationId":"Cost control|Wage group_fetchAction","parameters":[{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters the wage groups based on the externalIds.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupFetchResponse"}]}}}}}}},"\/wage_group\/upsert":{"post":{"tags":["Cost control|Wage group"],"summary":"Upsert wage groups.","description":"This endpoint enables you to create\/update wage groups.","operationId":"Cost control|Wage group_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupUpsertRequest"}]}}}}}},"\/wage_group_cost_setting\/fetch":{"get":{"tags":["Cost control|Wage group cost setting"],"summary":"Fetch wage group cost setting list.","description":"This endpoint enables you to retrieve a list of wage group cost settings.","operationId":"Cost control|Wage group cost setting_fetchAction","parameters":[{"name":"filter[byWageGroupId]","in":"query","required":false,"description":"Filters the wage group cost settings based on the wage group id.\nOnly one filter will be applied.","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupCostHistoryFetchResponse"}]}}}}}}},"\/wage_group_cost_setting\/upsert":{"post":{"tags":["Cost control|Wage group cost setting"],"summary":"Create wage group cost settings.","description":"This endpoint enables you to create new wage group cost settings.","operationId":"Cost control|Wage group cost setting_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupCostHistoryUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupCostHistoryUpsertRequest"}]}}}}}},"\/wage_group_employee_setting\/fetch":{"get":{"tags":["Cost control|Wage group employee setting"],"summary":"Fetch employees\/departments and their wage group settings.","description":"This endpoint enables you to retrieve a list of wage group employee settings.","operationId":"Cost control|Wage group employee setting_fetchAction","parameters":[{"name":"filter[byEmployeeId]","in":"query","required":false,"description":"Filters the wage group employee settings based on the employee id.\nOnly one filter will be applied.","schema":{"type":"integer"}},{"name":"filter[byDepartmentId]","in":"query","required":false,"description":"Filters the wage group employee settings based on the department id.\nOnly one filter will be applied.","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupEmployeeHistoryFetchResponse"}]}}}}}}},"\/wage_group_employee_setting\/upsert":{"post":{"tags":["Cost control|Wage group employee setting"],"summary":"Create wage group employee settings.","description":"This endpoint enables you to create new wage group employee settings.","operationId":"Cost control|Wage group employee setting_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupEmployeeHistoryUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWageGroupEmployeeHistoryUpsertRequest"}]}}}}}},"\/dispo_type\/fetch_type":{"get":{"tags":["Disposition|Dispo type"],"summary":"Fetch dispo type list.","description":"Dispo types within geoCapture are utilized to establish fundamental settings for tour planning. They define a\nnaming scheme for tours (relevant for batch processing in geoCapture) and set required and non required\nqualifications for the tours planned with this dispo type.\n\nWithin the dispo type, you define districts. Districts in geoCapture are designated areas where specific teams\ncarry out their operations. In addition, you can include additional qualifications for each district. Orders are\nlinked to a dispo type by setting a dispo type within an order type. All orders from the selected\norder types will be available for tour planning within the specified dispatch types. Additionally, optimization\ngoals can be established for tours of this type of disposition. Potential optimization targets for tours might\ninvolve increasing the total number of orders fulfilled within the working hours of a team. Another\npossible objective is to minimize the cost associated with each tour. In adition you can select the type of\nroute planning you want to use: car, truck, pedestrian, or bike.\n\n\nNote that you must use the `\/dispo_type\/fetch_type_data` endpoint for detailed information, such as the\noptimization goals.","operationId":"Disposition|Dispo type_fetchTypeAction","parameters":[{"name":"name","in":"query","required":false,"description":"Filters the list of disposition types by name. Supports partial matches (case-insensitive). If not specified, all disposition types are returned.","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTypeFetchTypeResponse"}]}}}}}}},"\/dispo_type\/fetch_type_data":{"get":{"tags":["Disposition|Dispo type"],"summary":"Request details for a dispo type.","description":"This endpoint allows you to retrieve details of a dispo type.\nWithin the dispo type, you define districts. Districts in geoCapture are designated areas where specific teams\ncarry out their operations. In addition, you can include additional qualifications for each district.\nOrders are linked to a dispo type by setting a dispo type within an order type.\n\nAll orders from the selected order types will be available for tour planning within the specified dispo types.\nAdditionally, optimization goals can be established for tours of this dispo type. Optimization goals for tours\ncould be to do as many orders as possible in the provided work time of a team. Another goal could be low cost for\na tour. You can select the type of route planning you want to use: car, truck, pedestrian, or bike.","operationId":"Disposition|Dispo type_fetchTypeDataAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the dispo type. The \u0027fetch dispo type list\u0027 endpoint allows you to retrieve the id of a\nspecific dispo type. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTypeFetchTypeDataResponse"}]}}}}}}},"\/dispo_type\/fetch_team":{"get":{"tags":["Disposition|Dispo type"],"summary":"Fetch dispo team list.","description":"This endpoint allows you to fetch a list of dispo teams.\n\nA dispo team is responsible for executing tours. It consists of a team leader and optional additional team\nmembers. These members are not configured in geoCapture. The team leader plays a crucial role by using a mobile\napplication to view assigned tours, navigate to each destination, carry out orders,  mark them as completed\nand move on to subsequent stops.\n\n\nDispo teams allow administrators to set team qualifications, assign vehicles and schedule working hours for dispo\nteams. Such customization ensures that tasks are allocated to teams based on their qualifications and\navailability, improving operational workflows. By following this approach, the system ensures that dispatch teams\nare utilized efficiently, thus maximizing both operational efficiency and cost-effectiveness.","operationId":"Disposition|Dispo type_fetchTeamAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTypeFetchTeamResponse"}]}}}}}}},"\/dispo_type\/fetch_qualification":{"get":{"tags":["Disposition|Dispo type"],"summary":"Fetch dispo qualification list.","description":"\nThis endpoint allows you to fetch a list of qualifications used for tour planning in geoCapture.\nQualifications are a set of criteria that define the capabilities required of teams or individuals to carry out\nspecific tasks. These could include professional licenses, technical skills, physical abilities, or even\nknowledge of certain geographic areas. In geoCapture, qualifications are used to match the requirements of an\norder with the abilities of the workforce.\n\n\nWhen planning tours a manager or dispatcher uses geoCapture to:\u003Cbr\u003E\n\n\u003Cb\u003EAssign Qualifications to a Team:\u003C\/b\u003E\u003Cbr\u003E\nTeams are assigned qualifications based on their skills and certifications. This ensures that only\nthose who meet the order requirements are considered for assignment.\n\n\u003Cb\u003EMatch Orders with Qualified Teams:\u003C\/b\u003E\u003Cbr\u003E\nWhen an order is planned in a tour, geoCapture filters through the team database to find a match between the\norder\u0027s requirements and the qualifications of available teams.","operationId":"Disposition|Dispo type_fetchQualificationAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTypeFetchQualificationResponse"}]}}}}}}},"\/dispo_type\/fetch_district":{"get":{"tags":["Disposition|Dispo type"],"summary":"Fetch dispo district list.","description":"This endpoint allows you to fetch a list of districts used in the tour planning.\n\nDistricts in geoCapture help organize and manage orders geographically. They are used to group tasks and\nassignments in specific areas, allowing for more efficient planning and execution of field operations. Orders\nare automatically associated with the correct district based on their geographical location. This automatic\nassignment ensures that orders are managed within their respective areas, streamlining the process of planning\nand executing tasks.","operationId":"Disposition|Dispo type_fetchDistrictAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTypeFetchDistrictResponse"}]}}}}}}},"\/dispo_qualification\/fetch":{"get":{"tags":["Disposition|Qualifications"],"summary":"Fetch dispo qualification list.","description":"This endpoint enables you to retrieve a list of dispo qualifications, including the name and the id of the\nretrieved qualifications. To modify or add new qualifications, configuration must be performed in geoCapture.","operationId":"Disposition|Qualifications_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoQualificationFetchResponse"}]}}}}}}},"\/tour\/fetch":{"get":{"tags":["Disposition|Tour"],"summary":"Fetch tour list.","description":"This endpoint enables you to access a list of tours. You may add various filter options to ensure that you\nobtain the desired data. The response will provide you with fundamental details about the tour, including a team\nreference, the number of orders, and the number of stops.\n\n\nA tour comprises various stops determined by the addresses of assigned orders. Through an optimization function,\nstops are sequenced for optimal efficiency, considering distances and travel times. Stops can be manually\nsequenced and calculated or optimized. Tour costs are automatically computed, including any user-adjusted\narrival and departure times, which may result in calculated waiting times for the team. These waiting times are\nalso factored into the cost calculation.\n\n\nIf you require more detailed information, such as the list of the stops, please make use of the\n`\/tour\/fetch_data` endpoint.","operationId":"Disposition|Tour_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the tour based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byDistrict][]","in":"query","required":false,"description":"Filters the tour based on the area.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTeam][]","in":"query","required":false,"description":"Filters the tour based on the team.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byStatus]","in":"query","required":false,"description":"Filters the tour based on its status.","schema":{"type":"string"}},{"name":"filter[from]","in":"query","required":false,"description":"Filters the tour based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[to]","in":"query","required":false,"description":"Filters the tour based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourFetchResponse"}]}}}}}}},"\/tour\/fetch_data":{"get":{"tags":["Disposition|Tour"],"summary":"Fetch tour details.","description":"This endpoint is able to provide you with details of a tour like detailed information for all stops and\nassociated tour costs. In addition to that you will recieve the `teamHeadEmployee` and the executing employee.\nYou recieve the id of a tour from the list tour endpoint.\n\n\nThe Sub-Stop function in tour planning allows for the division of a single work stop among multiple teams,\nensuring efficient task allocation for larger jobs. It involves assigning specific time durations to different\nteams for a shared job, based on the total estimated time required for the stop. If a stop with substops is\nremoved, all substops are also removed.","operationId":"Disposition|Tour_fetchDataAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the tour. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourFetchDataResponse"}]}}}}}}},"\/tour\/delete":{"get":{"tags":["Disposition|Tour"],"summary":"Delete tours.","description":"This endpoint allows you to delete multiple tours simultaneously by submitting multiple tour ids in one\nrequest. Afterward, you will receive a response with an array of deleted tour ids. Keep in mind that you may\ndelete any tours, irrespective of their status. Please note that deleted tours cannot be restored.","operationId":"Disposition|Tour_deleteAction","parameters":[{"name":"ids[]","in":"query","required":true,"description":"The internal ids of the tours to be deleted. This Parameter is required.","schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourDeleteResponse"}]}}}}}}},"\/tour\/delete_stop":{"get":{"tags":["Disposition|Tour"],"summary":"Delete stops.","description":"This endpoint allows you to delete multiple stops simultaneously by submitting multiple stop ids in one\nrequest. Afterward, you will receive a response with an array of deleted stop ids. Keep in mind that you may\ndelete any stops, irrespective of their status. Please note that deleted stops cannot be restored.","operationId":"Disposition|Tour_deleteStopAction","parameters":[{"name":"ids[]","in":"query","required":true,"description":"The internal ids of the stops to be deleted. This Parameter is required.","schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourDeleteStopResponse"}]}}}}}}},"\/tour\/set_status":{"get":{"tags":["Disposition|Tour"],"summary":"Set the status of the tour.","description":"This endpoint allows you to set the status of a tour in geoCapture with the ID of the tour and the new status.\nThe `NEW` status describes new tours that have not yet been calculated or tours that have been changed. The\n`FIXED` status of the tour alerts the user if they want to change the tour details. The `CALCULATED` status is\ndesignated for calculated tours. Tours with the status `READY` are displayed to drivers in their app.","operationId":"Disposition|Tour_setStatusAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the tour. This Parameter is required.","schema":{"type":"integer"}},{"name":"status","in":"query","required":true,"description":"The status to be set. This Parameter is required.\n\n| Values         |\n| -------------- |\n| NEW            |\n| CALCULATED     |\n| FIXED          |\n| READY          |\n| STARTED        |\n| FINISHED       |","schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourSetStatusResponse"}]}}}}}}},"\/tour\/optimize":{"get":{"tags":["Disposition|Tour"],"summary":"Optimize a tour.","description":"This endpoint allows you to start a job to optimize a tour by providing an `id`. Upon successful request, a\n`jobId` is provided in the response. geoCapture jobs are tasks that may take some time to calculate, therefore\nthey are executed in the background. You can to inquire about the status of the job through the\nMiscellaneous|Job endpoint. After optimizing the tour, the calculation is performed automatically.\n\nDuring route optimization, the system considers travel times. Additionally, it incorporates team working hours\nand the duration of each order to determine the estimated arrival and departure times at each stop, as well as\nthe distances to and between the stops.\n\nFor optimization purposes, it can be helpful to establish parameters for the sequence that a tour should be\noptimized between. For example, you may want to select a gas station to refuel your vehicle at the end of your\ntour. You can retrieve the sequence of stops for a tour by accessing the `\/tour\/fetch_data` endpoint.","operationId":"Disposition|Tour_optimizeAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the tour. This Parameter is required.","schema":{"type":"integer"}},{"name":"fromSequence","in":"query","required":false,"description":"Optimize the tour from this stop sequence on.","schema":{"type":"integer"}},{"name":"toSequence","in":"query","required":false,"description":"Optimize the tour until this stop sequence.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourOptimizeResponse"}]}}}}}}},"\/tour\/calculate":{"get":{"tags":["Disposition|Tour"],"summary":"Calculate a tour.","description":"This endpoint allows you to start a job to calculate a tour by providing its `id`.\nA job in geoCapture is a task executed in the background that may take some time to complete. Jobs may require\nseveral minutes to calculate. Upon a successful request, a `jobId` is provided in the response, which can be used\nto inquire about the status of the job through the Miscellaneous|Job endpoint.\nWhen calculating a tour, the arrival and departure times, along with the driving duration and distances, are\ncomputed in the order they were assigned to the tour. If applicable, the calculation follows the arranged\nsequence of the orders. To adjust the sequence of stops within a tour, utilize the `\/tour\/upsert_stop` endpoint\nand specify the `beforeStopId` or `afterStopId`.\nTo hand a tour to its driver\/team, it must be calculated. Optimization of the tour is optional. Please note that\na calculated tour is not optimized.","operationId":"Disposition|Tour_calculateAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the tour. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourCalculateResponse"}]}}}}}}},"\/tour\/assign_order":{"get":{"tags":["Disposition|Tour"],"summary":"Assign an order to a tour.","description":"This endpoint allows an order to be associated with a tour. The system will attempt to find a stop at the address\nof the order. If no existing stop is found, a new stop is added to the tour.\n\n\nWhen a new stop is added to the tour, it must be recalculated or optimzed if desired. The status of the tour will\nbe reset to `NEW`. This is because the distances, durations, and departure and arrival times of the jobs may\nchange when a new job is added, and the values need to be calculated for the new stop as well. You must do that\nat the `\/tour\/calculate` endpoint.","operationId":"Disposition|Tour_assignOrderAction","parameters":[{"name":"orderId","in":"query","required":false,"description":"The internal id of the order to be added to the tour.","schema":{"type":"integer"}},{"name":"orderExternalReference","in":"query","required":false,"description":"The external reference for the order to be added to the tour (Used if orderId not provided).","schema":{"type":"string"}},{"name":"tourId","in":"query","required":true,"description":"The internal id of the tour to be updated. This parameter is required.","schema":{"type":"integer"}},{"name":"beforeStopId","in":"query","required":false,"description":"The id of the stop before which to insert the new order.","schema":{"type":"integer"}},{"name":"afterStopId","in":"query","required":false,"description":"The id of the stop after which to insert the new order.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourAssignOrderResponse"}]}}}}}}},"\/tour\/upsert_stop":{"post":{"tags":["Disposition|Tour"],"summary":"Create\/Update stops for a tour.","description":"This method can be used to create and update tour stops. An attempt is made to find an existing stop based on\nthe\ngiven id. If one is found, it will be adjusted. Otherwise, a new stop is created.\n\nTo share the tour with the driver after a new stop has been added, it must first be calculated. This is made\npossible at the `\/tour\/calculate` endpoint. To insert the stop at a certain point in the tour, the\n`beforeStopId`\nor `afterStopId` must be set. To share the tour with the driver, calculate the tour and set the status to\n`READY`. The drivers can access the tour details via the orders menu in the geoCapture mobile app.","operationId":"Disposition|Tour_upsertStopAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourUpsertStopResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourUpsertStopRequest"}]}}}}}},"\/tour\/upsert":{"post":{"tags":["Disposition|Tour"],"summary":"Create\/Update tours.","description":"This method can be used to create and update tours. To modify or add stops within tours use the\n`\/tour\/upsert_stop` endpoint.\n\nAn attempt is made to find an existing tour based on the selected primary key.\nIf one is found, it will be adjusted. Otherwise, a new tour is created.","operationId":"Disposition|Tour_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDispoTourUpsertRequest"}]}}}}}},"\/file\/fetch":{"get":{"tags":["Documents|File"],"summary":"Fetch file list.","description":"Files in geoCapture are used in different areas of the application. They can be added to employees, vehicles,\nprojects, orders and tools. This endpoint allows you to list uploaded and added files in geoCapture. Not included\nin this endpoint are custom forms. Please use the Custom Form endpoints for interacting with them. Also,\nmiamapo maps are not included. mimapo is a tool for creating sketches on maps. For more information,\nplease click on this link: \u003Ca href=\u0022https:\/\/miamapo.de\/\u0022 target=\u0022_blank\u0022\u003Emiamapo\u003C\/a\u003E\n\nIf you want to download a file, you must use the `fetch_file` endpoint.","operationId":"Documents|File_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the file based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters the file based on the external IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byTypeId][]","in":"query","required":false,"description":"Filters the file based on the file type id.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTypeReferences][]","in":"query","required":false,"description":"Filters the file based on the file type reference.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[ownerType]","in":"query","required":false,"description":"Filters the file based on the object type it is attached to. (required if ownerId is provided)\n\nVEHICLE, ORDER, PROJECT, TOOL or EMPLOYEE","schema":{"type":"string"}},{"name":"filter[ownerId]","in":"query","required":false,"description":"Filters the file based on the object id it is attached to. (required if ownerType is provided)","schema":{"type":"integer"}},{"name":"filter[from]","in":"query","required":false,"description":"Filters the file based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[to]","in":"query","required":false,"description":"Filters the file based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single API request, with a\nlimit and default value set at 500 records. This Parameter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardFileFetchResponse"}]}}}}}}},"\/file\/fetch_file":{"get":{"tags":["Documents|File"],"summary":"Fetch a file.","description":"This method can be used to download a specific file with the specified `id` parameter. If you want a list of\navailable files to download, use the `\/file\/fetch` endpoint. The `access_log` flag allows you to specify whether\naccess should be logged in the document access log.","operationId":"Documents|File_fetchFileAction","parameters":[{"name":"id","in":"query","required":false,"description":"The internal ID of the file. This Parameter or the external ID is required.","schema":{"type":"integer"}},{"name":"externalId","in":"query","required":false,"description":"The external ID of the file. This Parameter or the id is required.","schema":{"type":"string"}},{"name":"log_access","in":"query","required":false,"description":"Log the access in the access log. This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentHttpFoundationResponse"}]}}}}}}},"\/file\/upsert":{"post":{"tags":["Documents|File"],"summary":"Create\/Update a file.","description":"This endpoint can be used to create\/update files and assign them to an employee, vehicle, project, order or tool. The\nfile must be base64 encoded and provided in the data field. The base64 encoded file can only be up to 256 MB in size.\nThe object type allows you to choose whether to\nassociate the file with an employee or one of the other options provided. You must also provide a `tagId` or\n`targetReference` to associate the document with a target. The filename must be the full filename including the\nextension, for example: document.pdf. You risk corrupting the file if you do not specify the extension. You can\nadd a file type by specifying its id. You can see a list of available file types at the `fetch_type` endpoint.\nIf none is specified, the default file type is used.","operationId":"Documents|File_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardFileUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardFileUpsertRequest"}]}}}}}},"\/file\/delete":{"get":{"tags":["Documents|File"],"summary":"Delete files.","description":"This endpoint can be used to delete specific files by providing an array of `id`s. If you want to delete multiple\nfiles at once, it will be beneficial to use an array of ids as this will improve performance and save resources.","operationId":"Documents|File_deleteAction","parameters":[{"name":"ids[]","in":"query","required":true,"description":"The internal ids of the files to be deleted. This paramter is required.","schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardFileDeleteResponse"}]}}}}}}},"\/file\/fetch_type":{"get":{"tags":["Documents|File"],"summary":"Fetch file type list.","description":"This method can be used to get a list of file types. File types in geoCapture specify a group of files. In\naddition, the file type provides permission control by specifying who can read, modify and delete a file.","operationId":"Documents|File_fetchTypeAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This Parameter is optional","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardFileFetchTypeResponse"}]}}}}}}},"\/custom_form_data\/fetch":{"get":{"tags":["Documents|Form data"],"summary":"Fetch form data list.","description":"This endpoint allows you to retrieve a list of custom forms. geoCapture Custom forms can be used to create\nconstruction reports, for instance. geoCapture allows you to create unique form definitions for different use\ncases. In addition, a form can be automatically added to projects, if enabled in the form definition.\nIf employees, tools or vehicles are referenced in the form definition, the completed form can also be added to\nthese targets, if enabled in the form definition.","operationId":"Documents|Form data_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the form data based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the form data based on in internal project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byEmployeeIds][]","in":"query","required":false,"description":"Filters the form data based on the internal employee IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTrackerIds][]","in":"query","required":false,"description":"Filters the form data based on the internal vehicle IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byBeaconIds][]","in":"query","required":false,"description":"Filters the form data based on the internal beacon IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byText]","in":"query","required":false,"description":"Filters the form data based on the text passed.","schema":{"type":"string"}},{"name":"filter[byFormDefinitionIds][]","in":"query","required":false,"description":"Filters the form data based on the form definition IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byExternalReference]","in":"query","required":false,"description":"Filters the form data based on the external reference.","schema":{"type":"string"}},{"name":"filter[byStatus]","in":"query","required":false,"description":"Filters the form data based on the status.\n\n| Value     | Description                  |\n| --------- | ---------------------------- |\n| NEW       | New form data                |\n| FILLED    | Already filled form data     |\n| REVIEW    | Check form data              |\n| APPROVED  | Approved by test distributor |\n| COMPLETED | Completed form data          |\n| RESET     | Resetted form data           |\n| BOOKED    | Booked form data             |","schema":{"type":"string"}},{"name":"filter[byOrderIds][]","in":"query","required":false,"description":"Filters the form data based on the order IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byBounds]","in":"query","required":false,"description":"Filters the form data based on the given rectangle","schema":{"type":"string","example":"52.37652038909364 7.605081948346127, 52.375099096475545 7.6082684126850175"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataFetchResponse"}]}}}}}}},"\/custom_form_data\/fetch_data":{"get":{"tags":["Documents|Form data"],"summary":"Request detailed form data.","description":"This endpoint enables you to procure detailed information about a custom form by providing the ID.  At the data\nkey, you will receive the values of the various fields from the form. The data will be available in the\ndesignated section of the custom form. Please note that any redundant data will be removed in accordance with\nestablished retention policies. The field name shall serve as the key in the JSON Object, receiving the\ncorresponding data. The form definition can only be altered in geoCapture, not via API.","operationId":"Documents|Form data_fetchDataAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the form data. This Parameter is required.","schema":{"type":"integer"}},{"name":"log_access","in":"query","required":false,"description":"Log the access in the changelog.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataFetchDataResponse"}]}}}}}}},"\/custom_form_data\/pdf":{"get":{"tags":["Documents|Form data"],"summary":"Request a custom form PDF.","description":"This endpoint enables you to obtain a PDF created by providing the `id` of the custom form. You can\ndecide whether this access should be recorded in the log of the form. When making a request to the\nendpoint, you will receive the custom form as a rendered PDF document in response.","operationId":"Documents|Form data_pdfAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal ID of the form data. This Parameter is required.","schema":{"type":"integer"}},{"name":"log_access","in":"query","required":false,"description":"Log the access in the changelog.","schema":{"type":"boolean"}},{"name":"export_base64","in":"query","required":false,"description":"Export the file as a base64 encoded string.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentHttpFoundationResponse"}]}}}}}}},"\/custom_form_data\/log":{"get":{"tags":["Documents|Form data"],"summary":"Request the log for the form data.","description":"This endpoint enables you to retrieve a log of a custom form by specifying its ID. Additionally, you can\nfilter by the date of creation using the payload parameter for additional information. For instance, an entry\nmarked as `SEND` will display the recipient as a property. The payload will include the custom form data upon\ncreation or update.","operationId":"Documents|Form data_fetchLog","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the form data. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataLogResponse"}]}}}}}}},"\/custom_form_data\/media":{"get":{"tags":["Documents|Form data"],"summary":"Fetch a list of media for the form data.","description":"This endpoint allows you to fetch a list of media used in custom forms. You can filter the list of media e.g.\nto recieve a list of media from only a specific form definition. When no filter is specified, the response will\ncontain all media from all custom forms up to a limit of 100 records. You are able to download the media with the\n`mediaData` endpoint.","operationId":"Documents|Form data_fetchMedia","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the form data based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the form data based on in internal project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byEmployeeIds][]","in":"query","required":false,"description":"Filters the form data based on the internal employee IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTrackerIds][]","in":"query","required":false,"description":"Filters the form data based on the internal vehicle IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byBeaconIds][]","in":"query","required":false,"description":"Filters the form data based on the internal beacon IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byText]","in":"query","required":false,"description":"Filters the form data based on the text passed.","schema":{"type":"string"}},{"name":"filter[byFormDefinitionIds][]","in":"query","required":false,"description":"Filters the form data based on the form definition IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byExternalReference]","in":"query","required":false,"description":"Filters the form data based on the external reference.","schema":{"type":"string"}},{"name":"filter[byStatus]","in":"query","required":false,"description":"Filters the form data based on the status.\n\n| Value     | Description                  |\n| --------- | ---------------------------- |\n| NEW       | New form data                |\n| FILLED    | Already filled form data     |\n| REVIEW    | Check form data              |\n| APPROVED  | Approved by test distributor |\n| COMPLETED | Completed form data          |\n| RESET     | Resetted form data           |\n| BOOKED    | Booked form data             |","schema":{"type":"string"}},{"name":"filter[byOrderIds][]","in":"query","required":false,"description":"Filters the form data based on the order IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byBounds]","in":"query","required":false,"description":"Filters the form data based on the given rectangle","schema":{"type":"string","example":"52.37652038909364 7.605081948346127, 52.375099096475545 7.6082684126850175"}},{"name":"fieldName","in":"query","required":false,"description":"Fieldname of the form.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with default value set at 50 records.","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"Number of media data to be skipped.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataMediaResponse"}]}}}}}}},"\/custom_form_data\/mediaData":{"get":{"tags":["Documents|Form data"],"summary":"Request the media file.","description":"This interface enables you to retrieve a file by submitting the formDataId and the desired filename. When\nrequesting the file, it will be provided in response. This function allows users to retrieve files, such as the\nattached images, from a construction report through download.","operationId":"Documents|Form data_fetchMediaData","parameters":[{"name":"formDataId","in":"query","required":true,"description":"The internal id of the form data. This Parameter is required.","schema":{"type":"integer"}},{"name":"filename","in":"query","required":true,"description":"The filename. This Parameter is required.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentHttpFoundationResponse"}]}}}}}}},"\/custom_form_data\/status":{"get":{"tags":["Documents|Form data"],"summary":"Set the status of the form data.","description":"This form provides an interface to set the status. The `COMPLETED` status will lock the form for further changes\nand is equivalent to completing the form in geoCapture. `BOOKED` is a status that is exclusively accessible\nthrough the API. When the status is set, an entry will be created in the custom form log with the content:\n\u0022form booked\u0022. This can help distinguish between custom forms that have been exported and those that have not.","operationId":"Documents|Form data_setStatus","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the form data. This Parameter is required.","schema":{"type":"integer"}},{"name":"status_text","in":"query","required":true,"description":"Status of the form. This Parameter is required.\n\n| Value     |\n| --------- |\n| COMPLETED |\n| BOOKED    |","schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDataStatusResponse"}]}}}}}}},"\/custom_form_definition\/fetch":{"get":{"tags":["Documents|Form definition"],"summary":"Fetch form definition list.","description":"This endpoint enables you to retrieve form definitions. This includes the document name, version, creation date,\nand last update date. Additionally, you can set an offset and a limit. The default limit and maximum limit are\nboth set at 100.","operationId":"Documents|Form definition_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the form definition based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byText]","in":"query","required":false,"description":"Filters the form definition based on the text passed.","schema":{"type":"string"}},{"name":"filter[byExternalReference]","in":"query","required":false,"description":"Filters the form definition based on the external reference.","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardCustomFormDefinitionFetchResponse"}]}}}}}}},"\/department\/fetch":{"get":{"tags":["Employees|Department"],"summary":"Fetch department list.","description":"This endpoint enables you to retrieve a list of departments. Departments in geoCapture are utilized to assign an\nemployee to their respective department for efficient management. An example of this could be allocating a\nstandardized time model for all employees within a specific department. Additionally, departments are utilized in\nthe approval center. In a department, you can set up inspectors for different types of approval requests,\nincluding absences, sickness, allowances, and stamp requests. This endpoint displays only the department\u0027s `id`,\n`name`, and its parent department\u0027s name. If you wish to modify any other settings, you must do so within\ngeoCapture.","operationId":"Employees|Department_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDepartmentFetchResponse"}]}}}}}}},"\/department\/upsert":{"post":{"tags":["Employees|Department"],"summary":"Create\/Update departments.","description":"This endpoint enables you to create departments or update the ones you created.","operationId":"Employees|Department_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDepartmentUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardDepartmentUpsertRequest"}]}}}}}},"\/employee\/fetch":{"get":{"tags":["Employees|Employee"],"summary":"Fetch employee list.","description":"This endpoint enables you to retrieve a list of employees. Employees may be issued with an RFID or iButton key.\nThe key value is provided in the `iButton` and `iButtonNumber` fields. Additionally, employees may belong to a\ndepartment that determines their time model. Furthermore, essential information such as their name and entry and\nexit date is included in the base data.","operationId":"Employees|Employee_fetchAction","parameters":[{"name":"employees[byIds][]","in":"query","required":false,"description":"Filters the employee based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byReferences][]","in":"query","required":false,"description":"Filters the employees based on the personal numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byCardNumbers][]","in":"query","required":false,"description":"Filters the employees based on the driver card numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byIbuttonNumbers][]","in":"query","required":false,"description":"Filters the employees based on the iButton numbers.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byImportKeys][]","in":"query","required":false,"description":"Filters the employees based on the employee import IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered.","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeFetchResponse"}]}}}}}}},"\/employee\/fetch_image":{"get":{"tags":["Employees|Employee"],"summary":"Fetch a employee image.","description":"This method can be used to download a specific employee image with the specified `id` parameter.","operationId":"Employees|Employee_fetchFileAction","parameters":[{"name":"id","in":"query","required":false,"description":"The internal ID of the employee. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentHttpFoundationResponse"}]}}}}}}},"\/employee\/upsert":{"post":{"tags":["Employees|Employee"],"summary":"Create\/Update employees.","description":"This method can be used to create and update employees.\n\nAn attempt will be made to find an existing employee based on the selected primary key. If found, adjustments are\nmade accordingly; otherwise, a new employee is created.You have the option to remove any absent employees from\nyour request. Also, you can specify the import source from which the missing employees should be removed. For\nexample, if the import source is tagged with *API, only the entries marked with this flag will be removed.\nEnabling the dry run feature will not make any modifications to the actual system, but you will receive a\nsuccessful response.","operationId":"Employees|Employee_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeUpsertRequest"}]}}}}}},"\/employee\/delete":{"get":{"tags":["Employees|Employee"],"summary":"Delete employees.","description":"This functionality permits the deletion of multiple employees concurrently by setting various filters. If the\n`dryRun` flag is enabled, no modifications will be made to the live system, and you will receive a simulated\nsuccess response. If the operation is successful, the list of employees who have been deleted will be provided\nas a response.","operationId":"Employees|Employee_deleteAction","parameters":[{"name":"employees[byIds][]","in":"query","required":false,"description":"Filters the employee based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byReferences][]","in":"query","required":false,"description":"Filters the employees based on the personal numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byCardNumbers][]","in":"query","required":false,"description":"Filters the employees based on the driver card numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byIbuttonNumbers][]","in":"query","required":false,"description":"Filters the employees based on the iButton numbers.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byImportKeys][]","in":"query","required":false,"description":"Filters the employees based on the employee import IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered.","schema":{"type":"string"}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeDeleteResponse"}]}}}}}}},"\/location\/fetch":{"get":{"tags":["Employees|Location"],"summary":"Fetch location list.","description":"This endpoint enables you to retrieve a list of locations, including the name and description of the\nretrieved locations. To modify or add a new location, configuration must be performed in geoCapture.","operationId":"Employees|Location_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardLocationFetchResponse"}]}}}}}}},"\/location\/upsert":{"post":{"tags":["Employees|Location"],"summary":"Create\/Update locations.","description":"This endpoint enables you to create locations or update the ones you created.","operationId":"Employees|Location_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardLocationUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardLocationUpsertRequest"}]}}}}}},"\/maintenance\/fetch":{"get":{"tags":["Maintenance|Maintenance"],"summary":"Fetch maintenance list.","description":"This endpoint enables you to retrieve a list of maintenances.","operationId":"Maintenance|Maintenance_fetchAction","parameters":[{"name":"filter[byTrackerIds][]","in":"query","required":false,"description":"Filters the maintenances based on the tracker ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byToolIds][]","in":"query","required":false,"description":"Filters the maintenances based on the tool ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byMaintenanceTypeIds][]","in":"query","required":false,"description":"Filters the maintenances based on the maintenance type ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceFetchResponse"}]}}}}}}},"\/maintenance\/upsert":{"post":{"tags":["Maintenance|Maintenance"],"summary":"Create\/Update maintenances.","description":"This method can be used to create and update maintenances.\n\nAn effort is made to locate an existing maintenance using the selected primary key. If found, it will be modified,\nwhereas if no maintenance is found, a new one is created. If the `deleteMissing` flag is set to true, all maintenances\nabsent from the request will be deleted. Please note that removed maintenances may not be reinstated. You can enable\nthe `dryRun` setting to simulate the action without altering any live data.","operationId":"Maintenance|Maintenance_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceUpsertRequest"}]}}}}}},"\/maintenance_log\/fetch":{"get":{"tags":["Maintenance|Maintenance Log"],"summary":"Fetch maintenance log list.","description":"This endpoint enables you to retrieve a list of maintenance logs.","operationId":"Maintenance|Maintenance Log_fetchAction","parameters":[{"name":"filter[byTrackerIds][]","in":"query","required":false,"description":"Filters the maintenance logs based on the tracker ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byToolIds][]","in":"query","required":false,"description":"Filters the maintenance logs based on the tool ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byMaintenanceTypeIds][]","in":"query","required":false,"description":"Filters the maintenance logs based on the maintenance type ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceLogFetchResponse"}]}}}}}}},"\/maintenance_log\/upsert":{"post":{"tags":["Maintenance|Maintenance Log"],"summary":"Create\/Update maintenance logs.","description":"This method can be used to create and update maintenance logs.\n\nAn effort is made to locate an existing maintenance log using the selected primary key. If found, it will be modified,\nwhereas if no maintenance log is found, a new one is created. You can enable the `dryRun` setting to simulate the action without altering any live data.","operationId":"Maintenance|Maintenance Log_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceLogUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceLogUpsertRequest"}]}}}}}},"\/maintenance_type\/fetch":{"get":{"tags":["Maintenance|Maintenance Type"],"summary":"Fetch maintenance list.","description":"This endpoint enables you to retriebe a list of maintenance types.","operationId":"Maintenance|Maintenance Type_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMaintenanceTypeFetchResponse"}]}}}}}}},"\/approval_center\/fetch":{"get":{"tags":["Miscellaneous|Approval"],"summary":"Fetch approval list.","description":"This endpoint provides you  a list of requests for various purposes, including vacation, missing time\nstamps, or bookings.  Approvals in geoCapture, for example, are utilized to apply for leave. The individual\noverseeing approvals (either set at the department level or delegated to the employee) may either accept, reject,\nrequest consultation, or provisionally accept the approval. The statuses of `CONSULTATION_REQUIRED` and\n`PROVISIONALLY_ACCEPTED` may be modified to `ACCEPT` or `REJECTED` at a later stage.\n\nIf the holiday request is approved, the absence will be displayed on the staff calendar as a filled color.\nIf the application is not yet approved, it will display in a dashed pattern on the Employee Calendar, which\noffers an overview of absences. If the approval is rejected, it will not be displayed on the calendar. The\nabsence calendar offers an outline of absences and is also employed in other parts of geoCapture, including\nresource planning.\n\nWhen a stamp is approved, the new stamp will be added to the employee at the requested time. A new booking will\nbe created in geoCapture as soon as a booking has been approved.","operationId":"Miscellaneous|Approval_fetchAction","parameters":[{"name":"logs[byAssignee]","in":"query","required":false,"description":"Filters the approvals by the assignee.","schema":{"type":"integer"}},{"name":"logs[byEmployee]","in":"query","required":false,"description":"Filters the approvals by the employee.","schema":{"type":"integer"}},{"name":"logs[byStatuses][]","in":"query","required":false,"description":"Filters the approvals by the status.\n\n| Value                  | Description                     |\n| ---------------------- | ------------------------------- |\n| OPEN                   | Approval open                   |\n| DONE                   | Approval done                   |\n| REJECTED               | Approval rejected               |\n| CONSULTATION_REQUIRED  | Approval requires consultation  |\n| PROVISIONALLY_ACCEPTED | Approval provisionally accepted |","schema":{"type":"array","items":{"type":"string"}}},{"name":"logs[byObjectType]","in":"query","required":false,"description":"Filters the approvals by the type.\n\n| Value                      | Description                                                             |\n| -------------------------- | ----------------------------------------------------------------------- |\n| APPROVAL_EMPLOYEE_WORKTIME | If working times from stamps must be approved. Configured in Department |\n| EMPLOYEE_APPLICATION       | If the employee submits an application: e.g. absence                    |\n| CUSTOM_FORM_DATA           | If custom forms must be approved: Configured in form definition         |","schema":{"type":"string"}},{"name":"logs[byObjectId]","in":"query","required":false,"description":"Filters the approvals by the object. Can be used only in conjunction with the filter \u0022byObjectType\u0022.","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"Number of records to skip.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardApprovalCenterFetchResponse"}]}}}}}}},"\/approval_center\/update_status":{"post":{"tags":["Miscellaneous|Approval"],"summary":"Update an approval\u0027s status.","description":"This endpoint enables you to update the status of approval requests. By making requests to this endpoint,\nyou can modify the status of specific approval entries, such as approving or rejecting an approval. In addition,\nyou can set the status to consultation required and provisionally accepted.","operationId":"Miscellaneous|Approval_updateStatusAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardApprovalCenterUpdateStatusResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardApprovalCenterUpdateStatusRequest"}]}}}}}},"\/approval_center\/create":{"post":{"tags":["Miscellaneous|Approval"],"summary":"Create a new approval.","description":"This endpoint allows you to create a new approval. You can create a new approval for an employee with\n`absenceData`, `stampData` or `accountingData`. If you provide stampData, an application for a new stamp will be\ncreated. If you provide `absenceData`, an approval for an absence will be created. This can be used to create a\nvacation application for an employee. If you provide accountingData, an application for bookings will be created.\nFor example, \u0027accountingData\u0027 could be an allowance with a corresponding wage type, such as set-up time.","operationId":"Miscellaneous|Approval_createAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardApprovalCenterCreateResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardApprovalCenterCreateRequest"}]}}}}}},"\/approval_rule\/fetch":{"get":{"tags":["Miscellaneous|Approval Rule"],"summary":"Fetch approval rule list.","description":"This endpoint enables you to retrieve a list of approval rules, including the name and description of the\nretrieved approval rules. To modify or add a new approval rule, configuration must be performed in geoCapture.","operationId":"Miscellaneous|Approval Rule_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardApprovalRuleFetchResponse"}]}}}}}}},"\/geocoder\/geocode":{"get":{"tags":["Miscellaneous|Geocoding"],"summary":"Geocode address.","description":"Geocode an address to obtain its geographic coordinates, including the latitude and longitude. Additionally, a\nformatted address will be provided alongside the latitude and longitude. You may input an unformatted address in\nthe `address` parameter, for instance, \u0022Rheiner Str. 3, 48496 Hopsten\u0022.","operationId":"Miscellaneous|Geocoding_geocodeAction","parameters":[{"name":"query","in":"query","required":true,"description":"The address. This Parameter is required.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentGeocodingAddressInterface"}]}}}}}}},"\/geocoder\/reverse_geocode":{"get":{"tags":["Miscellaneous|Geocoding"],"summary":"Search an address.","description":"Reverse geocoding converts geographic coordinates, such as latitude and longitude, into an address format.\nLatitude and longitude coordinates can be inputted into the corresponding parameters, for instance,\n\u002252.37652038909364 7.605081948346127\u0022.","operationId":"Miscellaneous|Geocoding_reverseGeocodeAction","parameters":[{"name":"latLng","in":"query","required":true,"description":"The geo coordinate. This Parameter is required.","schema":{"type":"string","example":"52.37652038909364 7.605081948346127"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentGeocodingAddressInterface"}]}}}}}}},"\/job\/fetch_status":{"get":{"tags":["Miscellaneous|Job"],"summary":"Request the status of a job.","description":"This endpoint allows you to retrieve the status of a background job within geoCapture. Jobs are used for\ncalculations or tasks that may last several minutes. When the job status is set to `WAITING`, it will be placed\ninto the queue for execution. When the status is set to `RUNNING` the job is currently being executed. After\nexecution, the status will be set to `SUCCESS` if no errors occurred.\n\nAn example of an endpoint that returns a job id is the import bill of quantities endpoint or the calculate\ntour endpoint. In the `returnValue` field, the job\u0027s individual return value is provided.","operationId":"Miscellaneous|Job_fetchStatusAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the job. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardJobFetchStatusResponse"}]}}}}}}},"\/order\/fetch":{"get":{"tags":["Orders|Order"],"summary":"Fetch order list","description":"geoCapture orders are detailed assignments created within the geoCapture system to manage and coordinate field\noperations such as service visits, maintenance tasks, or deliveries. Each order is a plan that includes important\ndetails like task descriptions, site locations, assigned staff, timelines, and specific activities, which\nensure the accurate execution of field services.\n\nThese orders are crucial in geoCapture\u0027s tour planning. Efficient routes are created that optimize the itinerary\nof each field team for travel time, service duration, and client priorities. For instance, a geoCapture order\nmight instruct a team to fit hardware at a new client\u0027s office. The order is then used to plot a route for the\nday, integrating other service calls along the way to reduce downtime and travel distance and, therefore, boost\nproductivity whilst decreasing operational expenses. The order ensures that the team brings appropriate equipment\nand knowledge, resulting in a prosperous installation within the allotted timeframe.","operationId":"Orders|Order_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the order based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byExternalReferences][]","in":"query","required":false,"description":"Filters the order based on the customer order numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byTourIds][]","in":"query","required":false,"description":"Filters the order based on the tour IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byStatusText]","in":"query","required":false,"description":"Filters the order based on the status text.\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |","schema":{"type":"string"}},{"name":"filter[byOrderType]","in":"query","required":false,"description":"Filters the order based on the order type.\n\n| Value                         |\n| ------------------------      |\n| REPEAT                        |\n| ORDER                         |\n| SAVED                         |\n| MACHINE_TRANSPORT             |","schema":{"type":"string"}},{"name":"filter[byBounds]","in":"query","required":false,"description":"Filters the order based on the given rectangle.","schema":{"type":"string","example":"52.37652038909364 7.605081948346127, 52.375099096475545 7.6082684126850175"}},{"name":"filter[byUnassigned]","in":"query","required":false,"description":"Filters the order based on whether it\u0027s assigned to a tour.","schema":{"type":"boolean"}},{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the order based on the project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTeamIds][]","in":"query","required":false,"description":"Filters the order based on the team IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This Parameter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderFetchResponse"}]}}}}}}},"\/order\/fetch_data":{"get":{"tags":["Orders|Order"],"summary":"Request order details.","description":"This endpoint enables the retrieval of comprehensive order information by supplying the internal `id`. This\ninformation includes `performanceFields`, `orderLog`, `tourInfo` and `orderQualification`. Within geoCapture,\nperformance fields denote particular metrics or parameters used for defining and quantifying the output or\nefficiency of tasks and services within the platform. The order log provides details of status changes within the\norder. The `tourInfo` references the tour in which the order is scheduled. The `orderQualification` refers to the\nspecific skills and abilities required for employees or teams to effectively complete assigned tasks or projects,\nensuring that the right expertise is matched to each job requirement. The opening hours in the `orderDetails`\nfield consist of the day of the week as the key and the corresponding start and end times expressed as a string.","operationId":"Orders|Order_fetchDataAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the order. This Parameter is required.","schema":{"type":"integer"}},{"name":"order_log","in":"query","required":false,"description":"Show the order log. This Parameter is optional.","schema":{"type":"boolean"}},{"name":"order_qualification","in":"query","required":false,"description":"Show the order qualification. This Parameter is optional.","schema":{"type":"boolean"}},{"name":"tour_info","in":"query","required":false,"description":"Show the tour info. This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderFetchDataResponse"}]}}}}}}},"\/order\/fetch_delivery_status":{"get":{"tags":["Orders|Order"],"summary":"Request order delivery status.","description":"Retrieves detailed delivery status information for an orders.\nThe request can be filtered by internal order ID, external reference, or delivery address (optionally within a specified radius).\nThe response includes the order ID, the current delivery status text, and the estimated delivery time window.","operationId":"Orders|Order_fetchDeliveryStatus","parameters":[{"name":"id","in":"query","required":false,"description":"Internal unique ID of the order.","schema":{"type":"integer"}},{"name":"reference","in":"query","required":false,"description":"The order reference.","schema":{"type":"string"}},{"name":"address","in":"query","required":false,"description":"Address associated with the order. Can be combined with radius to search nearby orders.","schema":{"type":"string"}},{"name":"radius","in":"query","required":false,"description":"Search radius (in meters) around the specified address. Used only when address is provided. Default: 50.","schema":{"type":"integer"}},{"name":"dispoTypeId","in":"query","required":false,"description":"Internal id of the dispo type used to further narrow down orders when searching by address. Only applies if address is specified.","schema":{"type":"integer"}},{"name":"dispoTypeName","in":"query","required":false,"description":"Name of the dispo type used to further narrow down orders when searching by address. Only applies if address is specified.","schema":{"type":"string"}},{"name":"daysBefore","in":"query","required":false,"description":"Include orders created or scheduled up to this number of days before today. Default: 0.","schema":{"type":"integer"}},{"name":"daysAfter","in":"query","required":false,"description":"Include orders created or scheduled up to this number of days after today. Default: 0.","schema":{"type":"integer"}},{"name":"locale","in":"query","required":false,"description":"Language code for the response text. Default: de.\n\n| Value | Language |\n| ----- | -------- |\n| de    | German   |\n| en    | English  |\n| es    | Spanish  |\n| fr    | French   |\n| it    | Italian  |\n| nl    | Dutch    |\n| pl    | Polish   |\n| ro    | Romanian |\n| ru    | Russian  |","schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderFetchDeliveryStatusResponse"}]}}}}}}},"\/order\/delete":{"get":{"tags":["Orders|Order"],"summary":"Delete order.","description":"This endpoint can be used to delete specific orders by providing an array of `id`s. If `dryRun` is enabled, the\nlive system will not undergo any changes, as the request will only be simulated. Note that once an order has been\ndeleted it cannot be restored. If you want to delete multiple orders at once, it will be beneficial to use an\narray of ids as this will improve performance and save resources.","operationId":"Orders|Order_deleteAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the order based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byExternalReferences][]","in":"query","required":false,"description":"Filters the order based on the customer order numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byTourIds][]","in":"query","required":false,"description":"Filters the order based on the tour IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byStatusText]","in":"query","required":false,"description":"Filters the order based on the status text.\n\n| Value                        |\n| ------------------------     |\n| ARRIVAL                      |\n| ASSIGNED                     |\n| CREATED                      |\n| DEPARTURE                    |\n| FINISHED                     |\n| NEAREST_POSITION             |\n| OPENED_BY_USER               |\n| READ                         |\n| REJECTED                     |\n| SIGNED                       |\n| STARTED                      |","schema":{"type":"string"}},{"name":"filter[byOrderType]","in":"query","required":false,"description":"Filters the order based on the order type.\n\n| Value                         |\n| ------------------------      |\n| REPEAT                        |\n| ORDER                         |\n| SAVED                         |\n| MACHINE_TRANSPORT             |","schema":{"type":"string"}},{"name":"filter[byBounds]","in":"query","required":false,"description":"Filters the order based on the given rectangle.","schema":{"type":"string","example":"52.37652038909364 7.605081948346127, 52.375099096475545 7.6082684126850175"}},{"name":"filter[byUnassigned]","in":"query","required":false,"description":"Filters the order based on whether it\u0027s assigned to a tour.","schema":{"type":"boolean"}},{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the order based on the project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTeamIds][]","in":"query","required":false,"description":"Filters the order based on the team IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderDeleteResponse"}]}}}}}}},"\/order\/upsert":{"post":{"tags":["Orders|Order"],"summary":"Create\/Update orders.","description":"This method can be used to create and update orders.\n\nAn attempt is made to find an existing order based on the selected primary key and value of the key provided.\nIf one is found, it will be adjusted. Otherwise, a new order is created. If you want, you can remove missing\nentries from the upsert request by setting the \u0027deleteMissing\u0027 flag to true.","operationId":"Orders|Order_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderUpsertRequest"}]}}}}}},"\/order\/create_transport":{"post":{"tags":["Orders|Order"],"summary":"Create transport order.","description":"This endpoint allows you to create a transport order. In addition to an order object you need to provide a\n`pickupLocation` and a `deliveryLocation`. The locations can be an existing project, referred by an id, or a\n`customProject` provided in this request.\n\nIn the geoCapture system, transport orders are specific types of orders focused on the movement of maschines from\none location to another. Unlike regular orders which might encompass a wide range of tasks like installations,\nmaintenance, or inspections, transport orders are specifically tailored for logistics services.\n\nFor example, a transport order in geoCapture could involve delivering an excavator from the depot to the\nconstruction site.","operationId":"Orders|Order_createTransportAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderCreateTransportResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderCreateTransportRequest"}]}}}}}},"\/order\/create_repeat":{"post":{"tags":["Orders|Order"],"summary":"Create repeat order.","description":"This endpoint allows you to create a repeating order. To create a repeating order you need to provide an order\nobject and scheduling information. The created order will be repeated according to the scheduling configuration\nprovided.\n\nRecurring orders in geoCapture are tasks scheduled to happen at regular intervals, like weekly, monthly, or\nannually. They are designed for repetitive tasks that need to be done routinely, such as regular maintenance\nchecks or recurring deliveries. To illustrate, a recurring order could be set up for weekly landscape maintenance\nat a specific location, meaning that the task is automatically scheduled at the designated frequency without\nneeding to create a new order every time. This function streamlines ongoing task management, boosting efficiency\nand maintaining consistency in operations.","operationId":"Orders|Order_createRepeatAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderCreateRepeatResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderCreateRepeatRequest"}]}}}}}},"\/order_category\/fetch":{"get":{"tags":["Orders|Order category"],"summary":"Fetch order category list","description":"In geoCapture, order categories classify various types of orders into separate groups according to their nature\nor purpose. This helps to efficiently manage various tasks, including deliveries, maintenance, installations,\nand inspections. By grouping all maintenance-related tasks together under one category, resources can be\nallocated more easily, and work can be scheduled more efficiently. This functionality optimizes the workflow by\nenabling users to swiftly discern and handle orders based on their corresponding categories. Additionally, orders\nbelonging to a specific category may inherit certain aspects, including desired or undesired qualifications.","operationId":"Orders|Order category_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the order category based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byName]","in":"query","required":false,"description":"Filters the order category based on the name.","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderCategoryFetchResponse"}]}}}}}}},"\/order_importer\/import_file":{"post":{"tags":["Orders|Order importer"],"summary":"Import a file with the order importer.","description":"This method allows you to upload a base64 encoded file. You need to provide the `filename` including the filetype\nand the file as base64 encoded string as `data`.\n\nThe order importer in geoCapture is a feature that facilitates the efficient import of orders into the system.\nThis tool has been optimized to facilitate the addition of multiple orders, including service requests and\ndelivery tasks. This is achieved by its capability to import from a range of file formats such as PDFs, CSVs,\nExcel and .eml, thus reducing administrative tasks and promoting efficiency. This eliminates the need for manual\nentry, resulting in significant time and effort savings and improved data accuracy. For instance, a business can\nutilize the order importer to rapidly upload a week\u0027s worth of delivery orders, seamlessly integrating them into\nthe geoCapture system for instant processing and scheduling. The orders will be imported using the regulations\nspecified in an order importer definition that These rules can be adjusted within the geoCapture application. As\na response, you will receive a `jobId`. The job status can be requested at the Miscellaneous|Job endpoint.","operationId":"Orders|Order importer_importFileAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderImporterImportFileResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardOrderImporterImportFileRequest"}]}}}}}},"\/bill_of_quantities\/fetch":{"get":{"tags":["Projects|Bill of quantities"],"summary":"Fetch bill of quantities list.","description":"This endpoint enables you to retrieve a list of bills of quantities, with optional filters available, as well as\nan offset and limit parameter.\nIn the context of geoCapture, a bill of quantities is a document commonly utilized in the construction industry\nand service sectors to provide a comprehensive description of all the work needed for a specific project. The\ndocument specifies each task and material, with their respective specifications and quantities. When coordinating\na project, it is essential to provide a clear and detailed overview of all tasks, materials and quantities\nrequired. A bill of quantities acts as a comprehensive outline, similar to a shopping list that specifies the\nexact amount of each item needed. All measurements are in metric units such as metres, square metres, cubic\nmetres, kilograms or litres. In geoCapture, one can customize units to fit specific needs.\n\nFor example, if you are managing the development of a garden area around a corporate building, your bill of\nquantities might include:\u003Cbr\u003E\nTopsoil (45 cubic meters)\u003Cbr\u003E\nGrass sod (186 square meters)\u003Cbr\u003E\nMaple trees (10 trees, approximately 4.5 meters tall)\u003Cbr\u003E\nLabor for installation (40 man-hours)\u003Cbr\u003E\nWatering and maintenance services for the initial 30 days","operationId":"Projects|Bill of quantities_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the bills of quantities based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byImportKeys][]","in":"query","required":false,"description":"Filters the bills of quantities based on the import keys.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters the bills of quantities based on the externalIds.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[from]","in":"query","required":false,"description":"Filters the bill of quantities based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[to]","in":"query","required":false,"description":"Filters the bill of quantities based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBillOfQuantitiesFetchResponse"}]}}}}}}},"\/bill_of_quantities\/fetchData":{"get":{"tags":["Projects|Bill of quantities"],"summary":"Request bill of quantities details.","description":"This endpoint enables users to retrieve additional information for a particular bill of quantity by entering an\nid. This information could include the project name, sections and locations of the bill of quantity.","operationId":"Projects|Bill of quantities_fetchData","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the bill of quantities. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBillOfQuantitiesFetchDataResponse"}]}}}}}}},"\/bill_of_quantities\/import":{"post":{"tags":["Projects|Bill of quantities"],"summary":"Import a bill of quantities file.","description":"This endpoint facilitates the upload of files encoded in base64 format. It supports various file formats\nincluding XML, GAEB2000, and GAEB90, enabling their import into the system. Upon successful upload, a `jobId` is\nprovided in the response, which can be used to inquire about the status of the import job through the\nMiscellaneous|Job endpoint.","operationId":"Projects|Bill of quantities_importAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBillOfQuantitiesImportResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBillOfQuantitiesImportRequest"}]}}}}}},"\/bill_of_quantities\/update":{"post":{"tags":["Projects|Bill of quantities"],"summary":"Update bill of quantities.","description":"An attempt is made to find an existing bill of quantities based on the given id on the given keyfield.\nIf one is found it will be adjusted with the data provided in the request, otherwise the dataset will be ignored.","operationId":"Projects|Bill of quantities_updateAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBillOfQuantitiesUpdateResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBillOfQuantitiesUpdateRequest"}]}}}}}},"\/bill_of_quantities\/delete":{"get":{"tags":["Projects|Bill of quantities"],"summary":"Delete bill of quantities.","description":"This endpoint enables the deletion of multiple bills of quantities at once by providing an array of ids. If the\noperation is successful, you will receive a response containing the deleted items list. Keep the API\u0027s rate limit\nin mind when making requests. If possible, use the option to delete multiple records at once to save resources\nand time.","operationId":"Projects|Bill of quantities_deleteAction","parameters":[{"name":"ids[]","in":"query","required":true,"description":"The ids of the bill of quantities to be deleted. This Parameter is required.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBillOfQuantitiesDeleteResponse"}]}}}}}}},"\/project\/fetch":{"get":{"tags":["Projects|Project"],"summary":"Fetch project list.","description":"This endpoint enables you to obtain a project list, including details such as project address and geo-coordinates.\n\nIn geoCapture, projects are defined as designated sites or locations, including construction sites, company\nbranches, or service areas. These areas are used to complete a variety of tasks and activities. Each project is\ndefined by a unique location, on a map with an address or What3Words address, and has boundaries (either circular\nor polygonal) for accurate GPS tracking. All information captured within these limits, including time worked,\nassigned duties, or machinery operation, is automatically linked to the relevant project, enabling accurate\nsupervision and record-keeping of on-site activities.\n\nA maximum of 500 projects can be fetched at the same time.","operationId":"Projects|Project_fetchAction","parameters":[{"name":"projects[byIds][]","in":"query","required":false,"description":"Filters based on the internal project IDs","schema":{"type":"array","items":{"type":"integer"}}},{"name":"projects[byReferences][]","in":"query","required":false,"description":"Filters based on the project numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"projects[byImportKeys][]","in":"query","required":false,"description":"Filters based on the external project IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"projects[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external project ID is filtered.","schema":{"type":"string"}},{"name":"projects[byProjectCategoryIds][]","in":"query","required":false,"description":"Filters projects based on the category ids.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records. This Parameter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectFetchResponse"}]}}}}}}},"\/project\/upsert":{"post":{"tags":["Projects|Project"],"summary":"Create\/Update projects.","description":"This method can be used to create and update projects.\n\nAn attempt is made to find an existing project based on the selected primary key.\nIf one is found, it will be updated with the data provided in the request. Otherwise, a new project is created.","operationId":"Projects|Project_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectUpsertRequest"}]}}}}}},"\/project\/delete":{"get":{"tags":["Projects|Project"],"summary":"Delete projects.","description":"This endpoint permits the deletion of multiple projects simultaneously through the use of various filters. Keep\nin mind to perform as many actions as possible with a single API request to avoid exceeding the rate limit.\nAdditionally, please note that once deleted, projects cannot be restored. The `dryRun` option, if enabled,\nproduces a simulated successful response without executing the action on the live system","operationId":"Projects|Project_deleteAction","parameters":[{"name":"projects[byIds][]","in":"query","required":false,"description":"Filters based on the internal project IDs","schema":{"type":"array","items":{"type":"integer"}}},{"name":"projects[byReferences][]","in":"query","required":false,"description":"Filters based on the project numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"projects[byImportKeys][]","in":"query","required":false,"description":"Filters based on the external project IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"projects[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external project ID is filtered.","schema":{"type":"string"}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectDeleteResponse"}]}}}}}}},"\/project\/apply_geofence":{"get":{"tags":["Projects|Project"],"summary":"Apply geofences.","description":"This feature allows you to retroactively assign events such as trips, stops, operating hours, check-ins, etc., to a new or modified project based on GPS location.\nYou should use this feature if a new project was created late or if a project\u2019s geofence has changed.","operationId":"Projects|Project_applyGeofenceAction","parameters":[{"name":"projectFilter[byIds][]","in":"query","required":false,"description":"Filters based on the internal project IDs","schema":{"type":"array","items":{"type":"integer"}}},{"name":"projectFilter[byReferences][]","in":"query","required":false,"description":"Filters based on the project numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"projectFilter[byImportKeys][]","in":"query","required":false,"description":"Filters based on the external project IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"projectFilter[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external project ID is filtered.","schema":{"type":"string"}},{"name":"projectFilter[from]","in":"query","required":false,"description":"The date from which the geofences should be applied","schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectApplyGeofenceResponse"}]}}}}}}},"\/project_assignment\/fetch":{"get":{"tags":["Projects|Project assignment"],"summary":"Fetch project assignment list.","description":"","operationId":"Projects|Project assignment_fetchAction","parameters":[{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTrackerIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given vehicle IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byToolIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given tool IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byToolExternalIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given tool external IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[fromDate]","in":"query","required":false,"description":"Filters the project assignments based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[toDate]","in":"query","required":false,"description":"Filters the project assignments based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This paramter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This paramter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentFetchResponse"}]}}}}}}},"\/project_assignment\/upsert":{"post":{"tags":["Projects|Project assignment"],"summary":"Create\/Update project assignments","description":"This method can be used to create and update project assignments.","operationId":"Projects|Project assignment_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentUpsertRequest"}]}}}}}},"\/project_assignment\/delete":{"get":{"tags":["Projects|Project assignment"],"summary":"Delete project assignments.","description":"","operationId":"Projects|Project assignment_deleteAction","parameters":[{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTrackerIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given vehicle IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byToolIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given tool IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byToolExternalIds][]","in":"query","required":false,"description":"Filters the project assignments based on the given tool external IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[fromDate]","in":"query","required":false,"description":"Filters the project assignments based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[toDate]","in":"query","required":false,"description":"Filters the project assignments based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectAssignmentDeleteResponse"}]}}}}}}},"\/project_category\/fetch":{"get":{"tags":["Projects|Project category"],"summary":"Fetch tool category list.","description":"This endpoint enables you to retrieve a list of tool categories, including the name and description of the\nretrieved categories. To modify or add a new tool category, configuration must be performed in geoCapture.","operationId":"Projects|Project category_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectCategoryFetchResponse"}]}}}}}}},"\/project_category\/upsert":{"post":{"tags":["Projects|Project category"],"summary":"Create\/Update project categories.","description":"This method can be used to create and update project categories.\n\n An effort is made to locate an existing project category using the selected primary key. If found, it will be modified,\n whereas if no project category is found, a new one is created. If the `deleteMissing` flag is set to true, all project categories absent\n from the request shall be purged. Please note that removed project categories may not be reinstated. You can enable the\n `dryRun` setting to simulate the action without altering any live data.","operationId":"Projects|Project category_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectCategoryUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectCategoryUpsertRequest"}]}}}}}},"\/project_times\/fetch":{"get":{"tags":["Projects|Project time"],"summary":"Fetch project time list.","description":"This method can be used to request the operating hours and working hours for a project.\n\nIn geoCapture, project times record the working hours and activities linked with specific projects. The records\ncontain information such as the start and end times of activities, their duration, and the employees or equipment\n(trackers) that were utilized. This functionality assures precise tracking of labour and resource utilization on\nprojects, facilitating efficient management and billing. All times are in seconds.","operationId":"Projects|Project time_fetchAction","parameters":[{"name":"projectReference","in":"query","required":false,"description":"The project number. Either this parameter or projectImportKey is required.","schema":{"type":"string"}},{"name":"projectImportKey","in":"query","required":false,"description":"The project import key. Either this parameter or projectReference is required.","schema":{"type":"string"}},{"name":"from","in":"query","required":true,"description":"Start date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"to","in":"query","required":true,"description":"End date.","schema":{"type":"string","example":"2022-12-22"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardProjectTimesFetchResponse"}]}}}}}}},"\/resource_planning\/fetch":{"get":{"tags":["Resources|Resource Planning"],"summary":"Fetch resource assignment list.","description":"This endpoint enables you to retrieve a list of resource assignments.\n\nThis endpoint enables you to retrieve a list of resource assignments for the given filter. The response will\nprovide you with the basic information about the resource assignments, including the resource, the assigned\nresource and the duration of the assignment.","operationId":"Resources|Resource Planning_fetchAction","parameters":[{"name":"filter[byResourceIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the resource IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byEmployeeIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the employee IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byToolIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the tool IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byTrackerIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the tracker IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byOrderIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the order IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byAbsenceTypeIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the resource absence type IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byCustomProjectIds][]","in":"query","required":false,"description":"Filters the resource assignments based on the custom project IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardResourceAssignmentFetchResponse"}]}}}}}}},"\/route\/calculate":{"get":{"tags":["Routing | Route"],"summary":"Calculate route between two points.","description":"Calculates the optimal route distance in meters and driving time in seconds between a start and end coordinate.","operationId":"Routing | Route_calculateAction","parameters":[{"name":"startLatLng","in":"query","required":true,"description":"The geo-coordinates of the starting point of the route.","schema":{"type":"string","example":"52.37652038909364 7.605081948346127"}},{"name":"endLatLng","in":"query","required":true,"description":"The geo-coordinates of the end point of the route.","schema":{"type":"string","example":"52.37652038909364 7.605081948346127"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardRoutingRouteResponse"}]}}}}}}},"\/employee_absence\/fetch":{"get":{"tags":["Time Tracking|Absence"],"summary":"Request absences.","description":"This method allows you to fetch a structured list of data that includes various\nabsence records, such as absence dates, types, employee details, and other identifiers.\n\nAbsences within geoCapture are utilized across several aspects of the application, such as resource management.\nAn absence may be for a full day, half day or a specific duration. An absence always has a specific reason, such\nas vacation, illness, or school. Absence categories can be added or modified in geoCapture. Please be aware that\nabsences have the potential to impact the time account of employees.","operationId":"Time Tracking|Absence_fetchAction","parameters":[{"name":"filter[byEmployeeReference][]","in":"query","required":false,"description":"Filters the absences based on the employee personal number.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[from]","in":"query","required":false,"description":"Filters the absences based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[to]","in":"query","required":false,"description":"Filters the absences based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[byAbsenceTypeId][]","in":"query","required":false,"description":"Filters the absences based in the absence types","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byDepartmentIds][]","in":"query","required":false,"description":"Filters the absences based on the given departments","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[updatedFrom]","in":"query","required":false,"description":"Filters the absences based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[updatedTo]","in":"query","required":false,"description":"Filters the absences based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAbsenceFetchResponse"}]}}}}}}},"\/employee_absence\/delete":{"get":{"tags":["Time Tracking|Absence"],"summary":"Delete absences.","description":"This endpoint enables the deletion of absences based on various filters. Please note that each absence day is a\nunique instance with a distinct ID. In case the `dryRun` flag is enabled, the response will be simulated, and no\nlive data will be altered. Please be aware that absences have the potential to impact the time account of\nemployees.","operationId":"Time Tracking|Absence_deleteAction","parameters":[{"name":"filter[byEmployeeReference][]","in":"query","required":false,"description":"Filters the absences based on the employee personal number.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[from]","in":"query","required":false,"description":"Filters the absences based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[to]","in":"query","required":false,"description":"Filters the absences based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[byAbsenceTypeId][]","in":"query","required":false,"description":"Filters the absences based in the absence types","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byId][]","in":"query","required":false,"description":"Filters the absences based on the internal id.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAbsenceDeleteResponse"}]}}}}}}},"\/employee_absence\/upsert":{"post":{"tags":["Time Tracking|Absence"],"summary":"Create\/Update absences.","description":"This method can be used to create and update absences.\n\nAn attempt is made to locate an existing absence based on the selected primary key. If one is found, it will be\nadjusted. Otherwise, a new absence will be created. If the `deleteMissing` flag is activated, all records not\nincluded in the request will be deleted. If the `dryRun` option is enabled, no actual changes will occur. It is\nimportant to note that absences could affect the employees\u0027 time account.","operationId":"Time Tracking|Absence_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAbsenceUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAbsenceUpsertRequest"}]}}}}}},"\/employee_absence_type\/fetch":{"get":{"tags":["Time Tracking|Absence type"],"summary":"Fetch absence type list.","description":"This endpoint enables you to access a comprehensive list of all available types of absences. To access\ninformation on specific absence types, filter them by their unique ids. To create or modify absence types, you\nneed to do so within geoCapture.","operationId":"Time Tracking|Absence type_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the absence types based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters the absence types based on the external id.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAbsenceTypeFetchResponse"}]}}}}}}},"\/employee_accounting_entry\/fetch":{"get":{"tags":["Time Tracking|Employee Accounting Entry"],"summary":"Request employee accounting entries.","description":"This method allows you to fetch a structured list of data that includes various\nemployee accounting entry records, such as dates, values, value units, salary types, employee details, and other identifiers.\n\nAn employee accounting entry consists of a date, a salary type, a value with unit, and an assigned employee.\n\nPlease be aware that employee accounting entries have the potential to impact the time account of employees.","operationId":"Time Tracking|Employee Accounting Entry_fetchAction","parameters":[{"name":"filter[from]","in":"query","required":false,"description":"Filters the accounting entries based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[to]","in":"query","required":false,"description":"Filters the accounting entries based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byProjectIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given projects.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[bySalaryTypeIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given salary types.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[byEmployeeIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given employees.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAccountingEntryFetchResponse"}]}}}}}}},"\/employee_accounting_entry\/delete":{"get":{"tags":["Time Tracking|Employee Accounting Entry"],"summary":"Delete employee accounting entries.","description":"This endpoint enables the deletion of employee accounting entries based on various filters. In case the `dryRun` flag is enabled, the response will be simulated,\nand no live data will be altered. Please be aware that employee accounting entries have the potential to impact the time account of employees.","operationId":"Time Tracking|Employee Accounting Entry_deleteAction","parameters":[{"name":"employee_accounting_entries[from]","in":"query","required":false,"description":"Filters the accounting entries based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"employee_accounting_entries[to]","in":"query","required":false,"description":"Filters the accounting entries based on the given date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"employee_accounting_entries[byIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employee_accounting_entries[byEmployeeIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given employees.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employee_accounting_entries[bySalaryTypeIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given salary types.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employee_accounting_entries[byProjectIds][]","in":"query","required":false,"description":"Filters the accounting entries based on the given projects.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAccountingEntryDeleteResponse"}]}}}}}}},"\/employee_accounting_entry\/upsert":{"post":{"tags":["Time Tracking|Employee Accounting Entry"],"summary":"Create\/Update employee accounting entries.","description":"This method can be used to create and update employee accounting entries.\n\nAn attempt is made to locate an existing employee accounting entry based on the selected primary key. If one is found, it will be\nadjusted. Otherwise, a new employee accounting entry will be created. If the `dryRun` option is enabled, no actual changes will occur. It is\nimportant to note that employee accounting entries could affect the employees\u0027 time account.","operationId":"Time Tracking|Employee Accounting Entry_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAccountingEntryUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeAccountingEntryUpsertRequest"}]}}}}}},"\/employee_stamp\/fetch":{"get":{"tags":["Time Tracking|Employee Stamp"],"summary":"Fetch employee stamp list.","description":"This function retrieves employee stamps, including the `projectId`, the `salaryType` and the position of the\nstamp. Stamps in geoCapture are utilized for time tracking. The stamp can be set to either `S` for stay or `E`\nfor end. Stay stamps can be created at the start of a shift, after a break, if automatic breaks are not enabled\nin geoCapture, or when beginning work on a new project for project-related time tracking. Leave stamps can be\ngenerated at the beginning of a pause or at the conclusion of a shift. For employee work time requests, it is\nrecommended to utilize the `employee_time_tracking\/fetch` endpoint.","operationId":"Time Tracking|Employee Stamp_fetchAction","parameters":[{"name":"employees[byIds][]","in":"query","required":false,"description":"Filters the employee based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byReferences][]","in":"query","required":false,"description":"Filters the employees based on the personal numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byCardNumbers][]","in":"query","required":false,"description":"Filters the employees based on the driver card numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byIbuttonNumbers][]","in":"query","required":false,"description":"Filters the employees based on the iButton numbers.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byImportKeys][]","in":"query","required":false,"description":"Filters the employees based on the employee import IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered.","schema":{"type":"string"}},{"name":"stampId","in":"query","required":false,"description":"Internal Id of the stamp. (Ignores other Filters and returns the specific Stamp)","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Start date","schema":{"type":"string","example":"2022-12-22"}},{"name":"to","in":"query","required":false,"description":"End date","schema":{"type":"string","example":"2022-12-22"}},{"name":"offset","in":"query","required":false,"description":"Number of records to skip.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeStampFetchResponse"}]}}}}}}},"\/employee_stamp\/create":{"post":{"tags":["Time Tracking|Employee Stamp"],"summary":"Create employee stamps.","description":"This endpoint enables the creation of employee stamps. You must carry out this procedure to record an employee\u0027s\nworking time. When creating a stamp, you may include a reference to a project to log project-related work time\nand a specified salary type to use a custom salary type for this stamp. The stamp can be set to either \u0027STAY\u0027\nor \u0027END\u0027. Stay stamps can be created at the start of a shift, after a break, if automatic breaks are\nnot enabled in geoCapture, or when beginning work on a new project for project-related time tracking. Leave\nstamps can be generated at the beginning of a pause or at the conclusion of a shift.","operationId":"Time Tracking|Employee Stamp_createAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeStampCreateResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeStampCreateRequest"}]}}}}}},"\/employee_time_tracking\/fetch":{"get":{"tags":["Time Tracking|Employee time tracking"],"summary":"Fetch employee time tracking.","description":"This endpoint allows you to retrieve an employee\u0027s timesheet using the `employeeReference` and a timeframe from\nwhich to retrieve the timesheet. The time sheet will provide an overview of the `worktime` within the timeframe\nor detailed information on the `worktime` for each day within the specified timeframe. Additionally, the employee\ntimesheet provides comprehensive details, including \u0027overtime\u0027, \u0027drive duration\u0027 or \u0027drive distance\u0027, if\napplicable. Drive data on the timesheet is accessible if the employee is registered as a driver for a vehicle.\nVehicles may have fixed or variable drivers, depending on the stamps created in the vehicle. In addition, you\nwill receive information regarding the balance of the employee\u0027s time account. All time durations are provided in\nseconds.","operationId":"Time Tracking|Employee time tracking_fetchAction","parameters":[{"name":"employeeReference","in":"query","required":false,"description":"The personnel number of the employee. The employeeReference or importKey is required.","schema":{"type":"string"}},{"name":"importKey","in":"query","required":false,"description":"The external id of the employee. The employeeReference or importKey is required.","schema":{"type":"string"}},{"name":"from","in":"query","required":true,"description":"Start date.","schema":{"type":"string","example":"2022-12-22"}},{"name":"to","in":"query","required":true,"description":"End date","schema":{"type":"string","example":"2022-12-22"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEmployeeTimeTrackingFetchResponse"}]}}}}}}},"\/salary_type\/fetch":{"get":{"tags":["Time Tracking|Salary type"],"summary":"Fetch salary type list.","description":"This endpoint enables you to retrieve a roster of salary classifications within geoCapture. To modify the\ncharacteristics of the salary type, adjustments must be made in geoCapture. You will receive fundamental details\nabout the salary type, including its `name`, `id`, a holiday flag, and its `type`. The salary type serves as the\nidentifier for wage exports and within this API, and the `name` is used in geoCapture to refer to this\ndesignation.","operationId":"Time Tracking|Salary type_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the salary types based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardSalaryTypeFetchResponse"}]}}}}}}},"\/tool\/fetch":{"get":{"tags":["Tools|Tool"],"summary":"Fetch tool list.","description":"This endpoint enables you to retrieve a list of tools that are under geoCapture\u0027s management. You will receive\nfundamental details such as the tool\u0027s `serialNumber`, `toolCategory` name, and `toolManufacturer` name. You can\nestablish maintenance schedules within a tool to coordinate tool inspections, for instance. The status aims to\nenhance tool management efficiency within the company.","operationId":"Tools|Tool_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters the tools based on the internal IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"filter[bySerialNumbers][]","in":"query","required":false,"description":"Filters the tools based on the serial numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters the tools based on the external IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byBeaconIds][]","in":"query","required":false,"description":"Filters the tools based on beacon IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byLicenseNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the license plates.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolFetchResponse"}]}}}}}}},"\/tool\/fetchData":{"get":{"tags":["Tools|Tool"],"summary":"Request tool details.","description":"This endpoint allows you to gather detailed information about a tool with a specific `id`. This endpoint returns\na tool object and, if available, the linked beacon or tracker and the current known position of the tool.","operationId":"Tools|Tool_fetchDataAction","parameters":[{"name":"id","in":"query","required":true,"description":"The internal id of the tool. This Parameter is required.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolFetchDataResponse"}]}}}}}}},"\/tool\/delete":{"get":{"tags":["Tools|Tool"],"summary":"Delete tools.","description":"This endpoint permits the deletion of many tools simultaneously with the provision of an array of IDs. You can\nenable the `dryRun` parameter to simulate the execution, without modifying actual data. Note that deleted tools\ncannot be restored.","operationId":"Tools|Tool_deleteAction","parameters":[{"name":"ids[]","in":"query","required":false,"description":"The internal ids of the tool to be deleted. This Parameter is optional.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolDeleteResponse"}]}}}}}}},"\/tool\/upsert":{"post":{"tags":["Tools|Tool"],"summary":"Create\/Update tools.","description":"This method can be used to create and update tools.\n\nAn effort is made to locate an existing tool using the selected primary key. If found, it will be modified,\nwhereas if no tool is found, a new one is created. If the `deleteMissing` flag is set to true, all tools absent\nfrom the request shall be purged. Please note that removed tools may not be reinstated. You can enable the\n`dryRun` setting to simulate the action without altering any live data.\n\nThe designated employee assigned in the tool will be accountable for the precise upkeep of the equipment.\nYou may also configure `purchaseCost`, `purchaseDate`, `warranty`, and `yearOfManufacture` to facilitate your\ntool management. This data will be shown in geoCapture as tool details.","operationId":"Tools|Tool_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolUpsertRequest"}]}}}}}},"\/tool_category\/fetch":{"get":{"tags":["Tools|Tool category"],"summary":"Fetch tool category list.","description":"This endpoint enables you to retrieve a list of tool categories, including the name and description of the\nretrieved categories. To modify or add a new tool category, configuration must be performed in geoCapture.","operationId":"Tools|Tool category_fetchAction","parameters":[{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters the tool categories based on the externalIds.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolCategoryFetchResponse"}]}}}}}}},"\/tool_manufacturer\/fetch":{"get":{"tags":["Tools|Tool manufacturer"],"summary":"Fetch tool manufacturer list.","description":"This feature enables you to acquire a list of tool manufacturers. You will receive the standard manufacturers\nprovided by geoCapture and any additional ones you have added to your geoCapture account. To add or modify a tool\nmanufacturer, you must do so within geoCapture.","operationId":"Tools|Tool manufacturer_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardToolManufacturerFetchResponse"}]}}}}}}},"\/beacon\/fetch":{"get":{"tags":["Tracking|Beacon"],"summary":"Fetch beacon list","description":"This endpoint retrieves a list of beacons with detailed information, including the current latitude and\nlongitude. Beacons are little devices that send a bluetooth signal. This bluetooth signal can be received by GPS\ntrackers or the geoCapture mobile application. If this occurs, the beacon\u0027s position will be updated to the\nposition of the tracker. Usually, beacons in geoCapture are affixed to tools or small machines.","operationId":"Tracking|Beacon_fetchAction","parameters":[{"name":"beacons[byIds][]","in":"query","required":false,"description":"Filters the beacons based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"beacons[byUuids][]","in":"query","required":false,"description":"Filters the beacons based on the UUIDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"beacons[byToolIds][]","in":"query","required":false,"description":"Filters the beacons based on the tool IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Number of records to skip. This Parameter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records. This Parameter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBeaconFetchResponse"}]}}}}}}},"\/beacon\/update":{"post":{"tags":["Tracking|Beacon"],"summary":"Update beacon.","description":"This function can be utilized to modify beacons. It is not possible to update the position of beacons through the\nAPI to ensure precise data within geoCapture. In addition, the creation or deletion of beacons is not possible.\n\nAn identified beacon is updated according to the chosen primary key type and the supplied primary key. It is\nimportant to note that creating a new beacon is not possible through this action. You can update the serial\nnumber of the item to which the beacon is attached, along with the `objectIdentifier`.","operationId":"Tracking|Beacon_updateAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBeaconUpdateResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBeaconUpdateRequest"}]}}}}}},"\/beacon_map\/view":{"get":{"tags":["Tracking|Beacon Map Embedding"],"summary":"Display Beacon map.","description":"Returns an HTML page with an interactive map. It is possible to embed this map in your application using an\niFrame. You need to specify the beacons you wish to view on the map by using either the `beacons[byIds][]` or\n`beacons[byUuids][]` filters.","operationId":"Tracking|Beacon Map Embedding_viewAction","parameters":[{"name":"controls","in":"query","required":false,"description":"Select whether the controls are displayed. This Parameter is optional.","schema":{"type":"boolean"}},{"name":"zoom","in":"query","required":false,"description":"Set zoom level. This Parameter is optional. This Parameter is optional.","schema":{"type":"integer"}},{"name":"logo","in":"query","required":false,"description":"Display the logo.\n\n| Value            | Description         |\n|-----------------|---------------------|\n| GEOCAPTURE      | geoCapture-Logo     |\n| CUSTOMER        | Customer-Logo       |","schema":{"type":"string"}},{"name":"beacons[byIds][]","in":"query","required":false,"description":"Filters the beacons based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"beacons[byUuids][]","in":"query","required":false,"description":"Filters the beacons based on the UUIDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"beacons[byToolIds][]","in":"query","required":false,"description":"Filters the beacons based on the tool IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"estimated_position","in":"query","required":false,"description":"Show estimated position of the beacon.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentHttpFoundationResponse"}]}}}}}}},"\/beacon_map\/fetch":{"get":{"tags":["Tracking|Beacon Map Embedding"],"summary":"Fetch map information list.","description":"This endpoint enables you to retrieve the present and previous locations of beacons. It will provide the data\nutilized by the embedded map. The autoRefresh duration is a parameter utilized for the map view. It is not\nsignificant for your application. It\u0027s not recommended to regularly fetch the current position, both to safe\nresources and avoid hitting API rate limits.","operationId":"Tracking|Beacon Map Embedding_fetchAction","parameters":[{"name":"beacons[byIds][]","in":"query","required":false,"description":"Filters the beacons based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"beacons[byUuids][]","in":"query","required":false,"description":"Filters the beacons based on the UUIDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"beacons[byToolIds][]","in":"query","required":false,"description":"Filters the beacons based on the tool IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"estimated_position","in":"query","required":false,"description":"Show estimated position of the beacon.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardBeaconMapFetchResponse"}]}}}}}}},"\/tracker_counter\/fetch":{"get":{"tags":["Tracking|Counter"],"summary":"Fetch counter list.","description":"This method allows you to get counter information from the trackers, such as distance driven or operating hours.\nPlease be aware that the distance travelled as calculated by the GPS signal may differ from the actual mileage\ndisplayed in the vehicle. Be aware that the counter type is not equal to the unit of the `counterValue`. The\ncounter value\u0027s unit is provided in the `unitType`. Tracker counters can function as both sensors within the GPS\ntracker and as calculated values from geoCapture for a specific counter.","operationId":"Tracking|Counter_fetchAction","parameters":[{"name":"trackers[byIds][]","in":"query","required":false,"description":"Filters the vehicles based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"trackers[byLicenseNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the license plates.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentifiers][]","in":"query","required":false,"description":"Filters the vehicles based on the customer-specific IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentificationNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the VINs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byImportKeys][]","in":"query","required":false,"description":"Filters the vehicles based on the external vehicle IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered.","schema":{"type":"string"}},{"name":"trackers[byName]","in":"query","required":false,"description":"Filter the vehicles on their name.","schema":{"type":"string"}},{"name":"trackers[byDriver]","in":"query","required":false,"description":"Filter the vehicles on their driver.","schema":{"type":"string"}},{"name":"date","in":"query","required":false,"description":"Request the counter reading of the respective date.\n\nIf no date is given, the current reading will be requested.","schema":{"type":"string","example":"2022-12-22"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerCounterFetchResponse"}]}}}}}}},"\/event\/fetch":{"get":{"tags":["Tracking|Event"],"summary":"Fetch event list.","description":"This method allows the events to be requested with additional filters. It is important to know that Stamp Events\ndo not contain a time stamp object used for time tracking. It is only the event of a triggered time recording\nmodule on a vehicle or a triggered time recording terminal. If you want to use time stamp data, consider using\nthe Employee Stamp endpoint. For timestamp data, it is advised to use the Time Tracking|Employee Stamp endpoint.\nIf you need to request an employee\u0027s work time, it is recommended to use the Time Tracking|Employee time tracking\nendpoint. Other events include the ignition, device movement, or stopping tracker.","operationId":"Tracking|Event_fetchAction","parameters":[{"name":"eventTypes[]","in":"query","required":false,"description":"Filter for event type. This paramter is optional.\n\n\n| Value                     | Description                         |\n|--------------------------|--------------------------------------|\n| MOVE                     | Move                                |\n| STOP                     | Stop                                 |\n| STAMP                    | Stamp                           |\n| IGNITION                 | Ignition                              |\n| SENSOR                   | Sensor                              |","schema":{"type":"array","items":{"type":"string"}}},{"name":"sensorValueTypeName","in":"query","required":false,"description":"Filter for sensor value type name. This paramter is optional.","schema":{"type":"string"}},{"name":"trackers[byIds][]","in":"query","required":false,"description":"Filters the vehicles based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"trackers[byLicenseNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the license plates.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentifiers][]","in":"query","required":false,"description":"Filters the vehicles based on the customer-specific IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentificationNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the VINs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byImportKeys][]","in":"query","required":false,"description":"Filters the vehicles based on the external vehicle IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered.","schema":{"type":"string"}},{"name":"trackers[byName]","in":"query","required":false,"description":"Filter the vehicles on their name.","schema":{"type":"string"}},{"name":"trackers[byDriver]","in":"query","required":false,"description":"Filter the vehicles on their driver.","schema":{"type":"string"}},{"name":"trackers[byEmployees][byIds][]","in":"query","required":false,"description":"Filters the employee based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"trackers[byEmployees][byReferences][]","in":"query","required":false,"description":"Filters the employees based on the personal numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byEmployees][byCardNumbers][]","in":"query","required":false,"description":"Filters the employees based on the driver card numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byEmployees][byIbuttonNumbers][]","in":"query","required":false,"description":"Filters the employees based on the iButton numbers.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"trackers[byEmployees][byImportKeys][]","in":"query","required":false,"description":"Filters the employees based on the employee import IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byEmployees][importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered.","schema":{"type":"string"}},{"name":"employees[byIds][]","in":"query","required":false,"description":"Filters the employee based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byReferences][]","in":"query","required":false,"description":"Filters the employees based on the personal numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byCardNumbers][]","in":"query","required":false,"description":"Filters the employees based on the driver card numbers.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[byIbuttonNumbers][]","in":"query","required":false,"description":"Filters the employees based on the iButton numbers.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"employees[byImportKeys][]","in":"query","required":false,"description":"Filters the employees based on the employee import IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"employees[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external employee ID is filtered.","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"Number of events to be skipped. This paramter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}},{"name":"date","in":"query","required":false,"description":"Filter for events on this day.","schema":{"type":"string","example":"2022-12-22"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardEventFetchResponse"}]}}}}}}},"\/track_point\/fetch":{"get":{"tags":["Tracking|GPS record"],"summary":"Fetch GPS record list.","description":"This method can be used to request the GPS records of a single tracker. You need to specify the tracker using the\nfilter options provided. Returned records are unsorted.\n\nThe maximum number of records returned is limited to 100,000 entries.\nIf there are more entries, the field **`complete`** is set to **`false`** in the response.\nYou can then use the **`lastTrackPointId`** field in the response to create a new query with the\n`afterTrackPointId` parameter to return the subsequent entries.\n\nWith the **`afterTrackPointId`** parameter, it is also possible to create new records and requests.\nAll you need to do is pass the **`lastTrackPointId`** from the older request.","operationId":"Tracking|GPS record_fetchAction","parameters":[{"name":"tracker[byId]","in":"query","required":false,"description":"Filter the vehicle by the ID.","schema":{"type":"integer"}},{"name":"tracker[byLicenseNumber]","in":"query","required":false,"description":"Filter the vehicle by the license plate.","schema":{"type":"string"}},{"name":"tracker[byIdentifier]","in":"query","required":false,"description":"Filter the vehicle by the customer specific ID.","schema":{"type":"string"}},{"name":"tracker[byIdentificationNumber]","in":"query","required":false,"description":"Filter the vehicle by the vehicle identification number.","schema":{"type":"string"}},{"name":"tracker[byImportKey]","in":"query","required":false,"description":"Filter the vehicle by the external vehicle ID.","schema":{"type":"string"}},{"name":"tracker[importSource]","in":"query","required":false,"description":"Name of the external data source (Standard is \u0022*API\u0022)\n\nThis parameter is only required for filtering by the external vehicle ID.","schema":{"type":"string"}},{"name":"afterTrackPointId","in":"query","required":false,"description":"Get the records by the specified record ID.\nUse the \u0022lastTrackPointId\u0022 value from the previous request here.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackPointFetchResponse"}]}}}}}}},"\/tracker_health\/check":{"get":{"tags":["Tracking|Tracker health"],"summary":"Perform detailed tracker health check","description":"Retrieves comprehensive diagnostic information for a vehicle\u0027s tracker, including its current status and any detected issues.\nUseful for automated monitoring, maintenance scheduling, and installation validation.\n\nPerforms an anomaly check on tracker data to identify irregular or inconsistent tracking behavior.\nThis endpoint analyzes recent tracker records to detect the following anomaly types:\n\n\nJumping Trackpoints \u2013 Indicates sudden, unrealistic jumps in location.\n\nHigh Voltage Without Ignition \u2013 Detects elevated voltage levels when the ignition signal is off.\n\nVoltage Drop \/ Possible Tampering \u2013 Detects sudden drops or interruptions in voltage that may indicate manipulation or wiring issues.\n\nTracker Not Sending Data \u2013 Missing or delayed transmissions for an extended period.\n\nNo Beacon Reception \u2013 The tracker is active but does not receive any beacons for an extended time.\n\nPoor GPS Reception \u2013 Tracker shows consistently weak or unreliable GPS signal quality.\n\nPoor GSM Reception \u2013 Weak or unstable mobile network signal strength.\n\nIncorrect Permanent Power Wiring \u2013 No voltage is detected when the ignition is off, indicating the permanent power source may be incorrectly connected.\n\nTime-Tracking Sensor Check \u2013 Verifies that all time-tracking sensors transmit data.\n\nHidden on Map View \u2013 The tracker is not visible on the map because the \u201cshow on map\u201d option is disabled.\n\nExcessive Data Transmission \u2013 The vehicle sends unusually high amounts of tracking data within a day.\n\nFlickering Ignition Signal \u2013 Rapid, inconsistent changes in the ignition state indicating unstable or faulty wiring.\n\nMissing Tachograph Data \u2013 Tachograph data is not being transmitted.\n\nMissing Live \/ FMS Data \u2013 FMS data is not being transmitted.","operationId":"Tracking|Tracker health_checkAction","parameters":[{"name":"vehicleId","in":"query","required":false,"description":"The unique identifier of the vehicle whose tracker health should be checked.","schema":{"type":"integer"}},{"name":"days","in":"query","required":false,"description":"The number of days to include in the health check analysis, counted backwards from the current date.\nFor example, `7` means the tracker data from the last seven days (including today) will be evaluated.\nUse this parameter to control how far back the system should look for anomalies or communication issues.\nDefault value (if omitted): `30` (data from the last 30 days).","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerHealthCheckResponse"}]}}}}}}},"\/tracker\/fetch":{"get":{"tags":["Tracking|Vehicle"],"summary":"Fetch vehicle list.","description":"This endpoint enables you to retrieve a directory of vehicles within geoCapture, each of which is fitted with a\nGPS tracker. The `driverName` in the vehicle is only configured if a driver is specified in the vehicle settings.\nIt will not provide you with the current driver from stamps.","operationId":"Tracking|Vehicle_fetchAction","parameters":[{"name":"trackers[byIds][]","in":"query","required":false,"description":"Filters the vehicles based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"trackers[byLicenseNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the license plates.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentifiers][]","in":"query","required":false,"description":"Filters the vehicles based on the customer-specific IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentificationNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the VINs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byImportKeys][]","in":"query","required":false,"description":"Filters the vehicles based on the external vehicle IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered.","schema":{"type":"string"}},{"name":"trackers[byName]","in":"query","required":false,"description":"Filter the vehicles on their name.","schema":{"type":"string"}},{"name":"trackers[byDriver]","in":"query","required":false,"description":"Filter the vehicles on their driver.","schema":{"type":"string"}},{"name":"normalizedSearch","in":"query","required":false,"description":"Set this parameter to enable advanced filter methods (normalized license number, phonetic search for names)","schema":{"type":"boolean"}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Max. number of requested records. This Parameter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerFetchResponse"}]}}}}}}},"\/tracker\/upsert":{"post":{"tags":["Tracking|Vehicle"],"summary":"Create\/Update vehicles.","description":"This method can be used to create or update vehicles.\n\nAn attempt is undertaken to locate an existing vehicle utilizing the selected identifier. If one is found, it\nwill be adjusted. Otherwise a new vehicle will be created.\nFor example, this endpoint allows you to change the name of the vehicle or the name of the driver.","operationId":"Tracking|Vehicle_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerUpsertRequest"}]}}}}}},"\/map\/view":{"get":{"tags":["Tracking|Vehicle Map Embedding"],"summary":"Display map.","description":"Returns an HTML page with an interactive map. It is possible to embed this map in your application using an\niFrame.","operationId":"Tracking|Vehicle Map Embedding_viewAction","parameters":[{"name":"controls","in":"query","required":false,"description":"Select whether the controls are displayed. This Parameter is optional.","schema":{"type":"boolean"}},{"name":"zoom","in":"query","required":false,"description":"Set zoom level. This Parameter is optional.","schema":{"type":"integer"}},{"name":"logo","in":"query","required":false,"description":"Which logo should be dis\n\n| Value           | Description         |\n|-----------------|---------------------|\n| GEOCAPTURE      | geoCapture logo     |\n| CUSTOMER        | Customer logo       |","schema":{"type":"string"}},{"name":"date","in":"query","required":false,"description":"Show the trackpoints from this date. This Parameter is optional.","schema":{"type":"string","example":"2022-12-22"}},{"name":"trackers[byIds][]","in":"query","required":false,"description":"Filters the vehicles based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"trackers[byLicenseNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the license plates.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentifiers][]","in":"query","required":false,"description":"Filters the vehicles based on the customer-specific IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentificationNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the VINs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byImportKeys][]","in":"query","required":false,"description":"Filters the vehicles based on the external vehicle IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered.","schema":{"type":"string"}},{"name":"trackers[byName]","in":"query","required":false,"description":"Filter the vehicles on their name.","schema":{"type":"string"}},{"name":"trackers[byDriver]","in":"query","required":false,"description":"Filter the vehicles on their driver.","schema":{"type":"string"}},{"name":"eventTypes[]","in":"query","required":false,"description":"Show events. This Parameter is optional.\n\n| Value            | Description         |\n|-----------------|---------------------|\n| STOP            | Stop                |","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ComponentHttpFoundationResponse"}]}}}}}}},"\/map\/fetch":{"get":{"tags":["Tracking|Vehicle Map Embedding"],"summary":"Request map information.","description":"This endpoint enables you to retrieve the present and previous locations of trackers. It will provide the data\nutilized by the embedded map. The autoRefresh duration is a parameter utilized for the map view. It is\nnot significant for your application. It\u0027s not recommended to regularly fetch the current position, both\nto save resources and avoid hitting API rate limits.","operationId":"Tracking|Vehicle Map Embedding_fetchAction","parameters":[{"name":"date","in":"query","required":false,"description":"Show the trackpoints from this date. This Parameter is optional.","schema":{"type":"string","example":"2022-12-22"}},{"name":"trackers[byIds][]","in":"query","required":false,"description":"Filters the vehicles based on the IDs.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"trackers[byLicenseNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the license plates.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentifiers][]","in":"query","required":false,"description":"Filters the vehicles based on the customer-specific IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byIdentificationNumbers][]","in":"query","required":false,"description":"Filters the vehicles based on the VINs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[byImportKeys][]","in":"query","required":false,"description":"Filters the vehicles based on the external vehicle IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"trackers[importSource]","in":"query","required":false,"description":"Name of the external data source. (Default is \u0022*API\u0022)\n\nThis parameter is only required if the external vehicle ID is filtered.","schema":{"type":"string"}},{"name":"trackers[byName]","in":"query","required":false,"description":"Filter the vehicles on their name.","schema":{"type":"string"}},{"name":"trackers[byDriver]","in":"query","required":false,"description":"Filter the vehicles on their driver.","schema":{"type":"string"}},{"name":"eventTypes[]","in":"query","required":false,"description":"Show events. This Parameter is optional.\n\n| Value            | Description         |\n|-----------------|---------------------|\n| STOP            | Stop                |","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardMapFetchResponse"}]}}}}}}},"\/tracker_category\/fetch":{"get":{"tags":["Tracking|Vehicle category"],"summary":"Fetch vehicle category list.","description":"This endpoint enables you to retrieve a list of vehicle categories, including the name and description of the\nretrieved categories. To modify or add a new vehicle category, configuration must be performed in geoCapture.","operationId":"Tracking|Vehicle category_fetchAction","parameters":[{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters the tracker categories based on the externalIds.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a max and default value set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerCategoryFetchResponse"}]}}}}}}},"\/tracker_manufacturer\/fetch":{"get":{"tags":["Tracking|Vehicle manufacturer"],"summary":"Fetch tracker manufacturer list.","description":"This endpoint enables you to retrieve a list of tracker manufacturers.","operationId":"Tracking|Vehicle manufacturer_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerManufacturerFetchResponse"}]}}}}}}},"\/tracker_manufacturer\/upsert":{"post":{"tags":["Tracking|Vehicle manufacturer"],"summary":"Create\/Update tracker manufacturers.","description":"This endpoint enables you to create tracker manufacturers or update the ones you created.","operationId":"Tracking|Vehicle manufacturer_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerManufacturerUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerManufacturerUpsertRequest"}]}}}}}},"\/tracker_profile\/fetch":{"get":{"tags":["Tracking|Vehicle profile"],"summary":"Fetch tracker profile list.","description":"","operationId":"Tracking|Vehicle profile_fetchAction","parameters":[{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardTrackerProfileFetchResponse"}]}}}}}}},"\/webhook_application\/fetch":{"get":{"tags":["Webhook|Application"],"summary":"Fetch webhook applications.","description":"This endpoint enables you to retrieve a list of webhook applications.","operationId":"Webhook|Application_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters based on the internal IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters based on the external IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records. This Parameter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookApplicationFetchResponse"}]}}}}}}},"\/webhook_application\/upsert":{"post":{"tags":["Webhook|Application"],"summary":"Create or update webhook applications.","description":"This endpoint enables you to create or update webhook applications.","operationId":"Webhook|Application_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookApplicationUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookApplicationUpsertRequest"}]}}}}}},"\/webhook\/fetch":{"get":{"tags":["Webhook|Webhook"],"summary":"Fetch webhooks.","description":"This endpoint enables you to retrieve a list of webhooks.","operationId":"Webhook|Webhook_fetchAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters based on the internal IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters based on the external IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byApplicationIds][]","in":"query","required":false,"description":"Filters based on the internal application IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byApplicationExternalIds][]","in":"query","required":false,"description":"Filters based on the external application IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","required":false,"description":"Use this parameter to specify the number of records you want to skip before starting to collect the data from\nthe result set. This Parameter is optional.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"The limit parameter defines the maximum number of records that can be retrieved in a single\nAPI request, with a default value and max set at 500 records. This Parameter is optional.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookFetchResponse"}]}}}}}}},"\/webhook\/upsert":{"post":{"tags":["Webhook|Webhook"],"summary":"Create or update webhooks.","description":"This endpoint enables you to create or update webhooks.","operationId":"Webhook|Webhook_upsertAction","parameters":[],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookUpsertResponse"}]}}}}},"requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookUpsertRequest"}]}}}}}},"\/webhook\/delete":{"get":{"tags":["Webhook|Webhook"],"summary":"Delete webhooks.","description":"This endpoint permits the deletion of many webhooks simultaneously with the provision of an array of IDs. You can\nenable the `dryRun` parameter to simulate the execution, without modifying actual data. Note that deleted webhooks\ncannot be restored.","operationId":"Webhook|Webhook_deleteAction","parameters":[{"name":"filter[byIds][]","in":"query","required":false,"description":"Filters based on the internal IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[byExternalIds][]","in":"query","required":false,"description":"Filters based on the external IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"dryRun","in":"query","required":false,"description":"Simulate the operation (default: false).\n(No data will be removed) This Parameter is optional.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success Response:","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/StandardWebhookDeleteResponse"}]}}}}}}}},"security":[{"ApiKeyAuth":[]}]}