# Create and assign chauffeur to user Creates a new Chauffeur from payload and links it to the specified User; User must not already have a chauffeur. Endpoint: POST /user/{id}/create-chauffeur Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Header parameters: - `Authorization` (string, required) ## Path parameters: - `id` (string, required) The ID of the user ## Request fields (application/json): - `nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `uuid` (string, required) - `primaryPlatformId` (string, required) - `language` (object) circular reference - `type` (string) Enum: "driver", "conductor", "captain", "pilot" - `picture` (object) - `picture.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `picture.uuid` (string, required) - `picture.primaryPlatformId` (string, required) - `picture.language` (object) circular reference - `picture.url` (string) - `picture.path` (string) - `picture.name` (string) - `picture.originalName` (string) - `picture.size` (integer) - `picture.purpose` (string) - `picture.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `picture.mimeType` (string) - `picture.extension` (string) - `picture.identifiers` (array) - `picture.identifiers.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `picture.identifiers.uuid` (string, required) - `picture.identifiers.primaryPlatformId` (string, required) - `picture.identifiers.language` (object) circular reference - `picture.identifiers.name` (string) - `picture.identifiers.system` (string) - `picture.identifiers.value` (string) - `picture.identifiers.expiredAt` (string) - `picture.bucket` (object) - `picture.bucket.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `picture.bucket.uuid` (string, required) - `picture.bucket.primaryPlatformId` (string, required) - `picture.bucket.language` (object) circular reference - `picture.bucket.name` (string) - `picture.uploadedAt` (string) - `picture.tempFile` (string) - `picture.contentMatrix` (array) - `user` (object) circular reference - `firstName` (string) - `lastName` (string) - `dateOfBirth` (string) - `birthPlace` (string) - `nationality` (string) - `hoursPerMonth` (number) - `preferredVehicle` (object) circular reference - `capacityContract` (object) - `capacityContract.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.uuid` (string, required) - `capacityContract.primaryPlatformId` (string, required) - `capacityContract.language` (object) circular reference - `capacityContract.name` (string) - `capacityContract.type` (string) Enum: "permanentContract", "oneTimeContract", "transportOrderContract" - `capacityContract.communicationMethod` (string) Enum: "messageAutomation", "integration", "pdf" - `capacityContract.contract` (object) - `capacityContract.contract.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.contract.uuid` (string, required) - `capacityContract.contract.primaryPlatformId` (string, required) - `capacityContract.contract.language` (object) circular reference - `capacityContract.contract.title` (string) - `capacityContract.contract.description` (string) - `capacityContract.contract.deliveryTerms` (string) Enum: "EXW", "FCA", "FAS", "FOB", "CPT", "CIP", "CFR", "CIF", "DAP", "DPU", "DDP" - `capacityContract.contract.contractor` (object) circular reference - `capacityContract.contract.contractorSignee` (object) - `capacityContract.contract.contractorSignee.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.contract.contractorSignee.uuid` (string, required) - `capacityContract.contract.contractorSignee.primaryPlatformId` (string, required) - `capacityContract.contract.contractorSignee.language` (object) circular reference - `capacityContract.contract.contractorSignee.firstName` (string) - `capacityContract.contract.contractorSignee.lastName` (string) - `capacityContract.contract.contractorSignee.position` (string) - `capacityContract.contract.contractorSignee.email` (string) - `capacityContract.contract.contractorSignee.phone` (string) - `capacityContract.contract.contractorSignee.mobilePhone` (string) - `capacityContract.contract.client` (object) circular reference - `capacityContract.contract.clientSignee` (object) - `capacityContract.business` (object) circular reference - `capacityContract.administration` (object) - `capacityContract.administration.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.uuid` (string, required) - `capacityContract.administration.primaryPlatformId` (string, required) - `capacityContract.administration.language` (object) circular reference - `capacityContract.administration.platforms` (array) - `capacityContract.administration.name` (string) - `capacityContract.administration.primary` (boolean) - `capacityContract.administration.transportOrderPrefix` (string) - `capacityContract.administration.consignmentPrefix` (string) - `capacityContract.administration.business` (object) circular reference - `capacityContract.administration.currency` (object) - `capacityContract.administration.currency.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.currency.uuid` (string, required) - `capacityContract.administration.currency.primaryPlatformId` (string, required) - `capacityContract.administration.currency.language` (object) circular reference - `capacityContract.administration.currency.name` (string) - `capacityContract.administration.currency.short` (string) - `capacityContract.administration.currency.sign` (string) - `capacityContract.administration.currency.decimalDelimiter` (string) - `capacityContract.administration.currency.thousandDelimiter` (string) - `capacityContract.administration.currency.enabled` (boolean) - `capacityContract.administration.bankAccounts` (array) - `capacityContract.administration.bankAccounts.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.bankAccounts.uuid` (string, required) - `capacityContract.administration.bankAccounts.primaryPlatformId` (string, required) - `capacityContract.administration.bankAccounts.language` (object) circular reference - `capacityContract.administration.bankAccounts.accountHolderName` (string) - `capacityContract.administration.bankAccounts.accountHolderType` (string) - `capacityContract.administration.bankAccounts.bankName` (string) - `capacityContract.administration.bankAccounts.routingNumber` (string) - `capacityContract.administration.bankAccounts.accountNumber` (string) - `capacityContract.administration.bankAccounts.last4` (string) - `capacityContract.administration.bankAccounts.currency` (object) - `capacityContract.administration.bankAccounts.currency.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.bankAccounts.currency.name` (string) - `capacityContract.administration.bankAccounts.currency.short` (string) - `capacityContract.administration.bankAccounts.currency.sign` (string) - `capacityContract.administration.bankAccounts.currency.decimalDelimiter` (string) - `capacityContract.administration.bankAccounts.currency.thousandDelimiter` (string) - `capacityContract.administration.bankAccounts.currency.enabled` (boolean) - `capacityContract.administration.bankAccounts.country` (string) - `capacityContract.administration.bankAccounts.validation` (object) circular reference - `capacityContract.administration.bankAccounts.validated` (boolean) - `capacityContract.administration.bankAccounts.identifiers` (array) - `capacityContract.administration.numberFormat` (string) - `capacityContract.administration.numberLength` (integer) - `capacityContract.administration.dueDays` (integer) - `capacityContract.administration.invoiceNumberIndex` (object) - `capacityContract.administration.quoteNumberIndex` (object) - `capacityContract.administration.invoiceSendMessageAutomation` (object) - `capacityContract.administration.invoiceSendMessageAutomation.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.invoiceSendMessageAutomation.uuid` (string, required) - `capacityContract.administration.invoiceSendMessageAutomation.primaryPlatformId` (string, required) - `capacityContract.administration.invoiceSendMessageAutomation.language` (object) circular reference - `capacityContract.administration.invoiceSendMessageAutomation.type` (string) Enum: "messageAutomation", "questionAnswerAutomation", "fileRequestAutomation" - `capacityContract.administration.invoiceSendMessageAutomation.name` (string, required) The name of a messageAutomation - `capacityContract.administration.invoiceSendMessageAutomation.description` (string, required) The description of a messageAutomation - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.triggerType` (string) Enum: "trigger", "scheduler", "listener" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.triggerEvent` (string) Enum: "afterCreatingTrip", "afterUpdatingTrip", "afterConfirmingTrip", "afterStartingTrip", "afterFinishingTrip", "afterCancelingTrip", "afterLocationUpdateEvent", "afterCreatingMessage", "afterUpdatingMessage", "afterCreatingEvent", "afterStartEngineEvent", "afterStartMovingEvent", "afterStopMovingEvent", "afterStopEngineEvent", "afterCreatingWaitAction", "afterUpdatingWaitAction", "afterCreatingWeighingAction", "afterUpdatingWeighingAction", "afterCreatingUnloadAction", "afterUpdatingUnloadAction", "afterCreatingStopAction", "afterUpdatingStopAction", "afterCreatingMoveAction", "afterUpdatingMoveAction", "afterCreatingLoadAction", "afterUpdatingLoadAction", "afterCreatingDetachTransportEquipmentAction", "afterUpdatingDetachTransportEquipmentAction", "afterCreatingDetachChauffeurAction", "afterUpdatingDetachChauffeurAction", "afterCreatingBreakAction", "afterUpdatingBreakAction", "afterCreatingAttachTransportEquipmentAction", "afterUpdatingAttachTransportEquipmentAction", "afterCreatingAttachChauffeurAction", "afterUpdatingAttachChauffeurAction", "afterActionLifeCycleUpdate", "afterCreatingCapacityContract", "afterUpdatingCapacityContract", "afterCreatingMessageAutomation", "AfterUpdatingMessageAutomation", "afterCreatingTransportOrder", "afterUpdatingTransportOrder", "afterCreatingConsignment", "afterUpdatingConsignment", "afterCreatingBusiness", "afterUpdatingBusiness", "afterCreatingInvoice", "afterSendingInvoice", "afterUpdatingInvoice", "afterCreatingQuote", "afterUpdatingQuote", "afterSendingQuote", "afterCreatingUser", "afterUpdatingUser", "afterCreatingLocation", "afterUpdatingLocation", "afterExceedingStopAverageDuration", "afterHomeBaseReturnOverdue", "afterCreatingBooking", "afterUpdatingBooking", "afterCancellingBooking", "afterConfirmingBooking", "afterCreatingIntegration", "afterUpdatingIntegration", "afterUpdatingCalendarEvent", "afterDeletingCalendarEvent", "afterCreatingTodo", "afterUpdatingTodo", "afterDeletingTodo", "afterAssigningTodo", "afterCalendarSyncRequested", "afterCalendarAuthorizationGranted" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleValue` (integer) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleType` (string) Enum: "seconds", "minutes", "hours", "days", "months" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule.milliseconds` (integer) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSelector` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSchedule` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.selector` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.comparisonType` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.value` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.linkType` (string) Enum: "and", "or" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.filters` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.sequenceNr` (integer) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.valueSelector` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.fields` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.fields.name` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.fields.groupByAggregate` (string) Enum: "count", "max", "min", "sum", "avg" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.entityType` (string) Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins.type` (string) Enum: "inner_join" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins.entityType` (string) Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onLeft` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onRight` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.sequenceNr` (integer) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.field` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.comparisonOperations` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.value` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.valueType` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.linkType` (string) Enum: "and", "or" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.groupBy` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.having` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.sortFields` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.sortDirection` (string) Enum: "asc", "desc" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.limit` (integer) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.offset` (integer) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.recipients` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.recipientSelector` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.toggleForAll` (boolean) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.channel` (string) Enum: "email", "chat", "notification", "whatsapp", "telegram" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.manualIntegration` (object) circular reference - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.includeAttachments` (boolean) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentSourceType` (string) Enum: "ENTITY_PDF", "CUSTOM_TEMPLATE", "INSIGHT_REPORT", "STATIC_FILE" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentType` (string) Enum: "cmr", "waybill", "invoice", "quote", "transportOrder", "trip", "custom" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentTemplateId` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileUrl` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.insightType` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.reportParameters` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.entityIdSelector` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileNameTemplate` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.subject` (string) The subject of a message for a particular messageAutomation - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.currentTriggerPosition` (integer) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts` (array) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language` (object) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.name` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.localName` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.code` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.iso3166` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.decimalDelimiter` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.thousandDelimiter` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.dateFormat` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.measurementUnit` (string) Enum: "metric", "imperial" - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.content` (string, required) The template of a message for a particular messageAutomation - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.messageTemplate` (string, required) The template of a message for a particular messageAutomation - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.subject` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.defaultLanguageId` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.languageSelector` (string) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.userEnableable` (boolean) - `capacityContract.administration.invoiceSendMessageAutomation.automationConfig.userPermissionFilters` (array) - `capacityContract.administration.invoiceSendMessageAutomation.messageAutomationIntegration` (object) circular reference - `capacityContract.administration.invoiceSendMessageAutomation.enabled` (boolean) - `capacityContract.administration.invoiceSendMessageAutomation.lastHandled` (string) - `capacityContract.administration.invoiceSendMessageAutomation.template` (boolean) - `capacityContract.administration.invoiceSendMessageAutomation.templateCategory` (string) - `capacityContract.administration.automaticallySendReminders` (boolean) - `capacityContract.administration.invoiceFirstReminderMessageAutomation` (object) - `capacityContract.administration.invoiceSecondReminderMessageAutomation` (object) - `capacityContract.administration.invoiceThirdReminderMessageAutomation` (object) - `capacityContract.administration.invoicePaidMessageAutomation` (object) - `capacityContract.administration.quoteSendMessageAutomation` (object) - `capacityContract.administration.invoiceTermsAndConditions` (array) - `capacityContract.administration.invoiceTermsAndConditions.language` (object) - `capacityContract.administration.invoiceTermsAndConditions.text` (string) - `capacityContract.administration.quoteTermsAndConditions` (array) - `capacityContract.administration.transportOrderTermsAndConditions` (array) - `capacityContract.administration.identifiers` (array) - `capacityContract.startTime` (string) - `capacityContract.endTime` (string) - `capacityContract.selfBilling` (boolean) - `capacityContract.currency` (object) - `capacityContract.triggerType` (string) Enum: "endOfWeek", "endOfWeekOrMonth", "endOfMonth", "endOfQuarter", "endOfTrip", "endOfTransportOrder" - `capacityContract.pricingModules` (array) - `capacityContract.pricingModules.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.pricingModules.type` (string) Enum: "fixed", "percentage", "time", "table", "zone", "ab", "unit", "element", "variable_adjustment", "formula", "tql_formula", "excel", "field", "modules", "highest_module_value", "lowest_module_value", "subscription" - `capacityContract.pricingModules.name` (string) - `capacityContract.pricingModules.sequenceNr` (integer) - `capacityContract.pricingModules.description` (string) - `capacityContract.pricingModules.category` (object) - `capacityContract.pricingModules.category.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.pricingModules.category.name` (string) - `capacityContract.pricingModules.category.creditCode` (string) - `capacityContract.pricingModules.category.debitCode` (string) - `capacityContract.pricingModules.category.defaultValue` (number) - `capacityContract.pricingModules.category.enabled` (boolean) - `capacityContract.pricingModules.category.tripRevenue` (boolean) - `capacityContract.pricingModules.category.identifiers` (array) - `capacityContract.pricingModules.category.identifiers.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.pricingModules.category.identifiers.name` (string) - `capacityContract.pricingModules.category.identifiers.system` (string) - `capacityContract.pricingModules.category.identifiers.value` (string) - `capacityContract.pricingModules.category.identifiers.expiredAt` (string) - `capacityContract.pricingModules.taxRates` (array) - `capacityContract.pricingModules.taxRates.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.pricingModules.taxRates.sequenceNr` (integer) - `capacityContract.pricingModules.taxRates.name` (string) - `capacityContract.pricingModules.taxRates.description` (string) - `capacityContract.pricingModules.taxRates.taxRate` (object) - `capacityContract.pricingModules.taxRates.taxRate.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.pricingModules.taxRates.taxRate.creditCode` (string) - `capacityContract.pricingModules.taxRates.taxRate.debitCode` (string) - `capacityContract.pricingModules.taxRates.taxRate.identifiers` (array) - `capacityContract.pricingModules.taxRates.taxRate.name` (string) - `capacityContract.pricingModules.taxRates.taxRate.description` (string) - `capacityContract.pricingModules.taxRates.taxRate.jurisdiction` (string) - `capacityContract.pricingModules.taxRates.taxRate.percentage` (number) - `capacityContract.pricingModules.taxRates.taxRate.inclusive` (boolean) - `capacityContract.pricingModules.taxRates.taxRate.active` (boolean) - `capacityContract.pricingModules.taxRates.filters` (array) - `capacityContract.pricingModules.taxRates.filters.selector` (string) - `capacityContract.pricingModules.taxRates.filters.comparisonType` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `capacityContract.pricingModules.taxRates.filters.value` (string) - `capacityContract.pricingModules.taxRates.filters.linkType` (string) Enum: "and", "or" - `capacityContract.pricingModules.taxRates.filters.filters` (array) - `capacityContract.pricingModules.taxRates.filters.sequenceNr` (integer) - `capacityContract.pricingModules.taxRates.filters.valueSelector` (string) - `capacityContract.pricingModules.filters` (array) - `capacityContract.pricingModules.oncePerInvoice` (boolean) - `capacityContract.lastHandledSelfBilling` (string) - `capacityContract.signature` (object) - `capacityContract.signature.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.signature.uuid` (string, required) - `capacityContract.signature.primaryPlatformId` (string, required) - `capacityContract.signature.language` (object) circular reference - `capacityContract.signature.ip` (string) - `capacityContract.signature.userAgent` (string) - `capacityContract.signature.date` (string) - `capacityContract.signature.file` (object) - `capacityContract.integration` (object) - `capacityContract.integration.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.integration.uuid` (string, required) - `capacityContract.integration.primaryPlatformId` (string, required) - `capacityContract.integration.language` (object) circular reference - `capacityContract.integration.type` (string) Enum: "manual", "configured", "messageAutomation", "fileTemplate", "apiAccess" - `capacityContract.integration.name` (string) - `capacityContract.integration.description` (string) - `capacityContract.integration.schedule` (object) - `capacityContract.integration.dataSources` (array) - `capacityContract.integration.dataSources.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.integration.dataSources.uuid` (string, required) - `capacityContract.integration.dataSources.primaryPlatformId` (string, required) - `capacityContract.integration.dataSources.language` (object) circular reference - `capacityContract.integration.dataSources.directionType` (string) Enum: "in", "out" - `capacityContract.integration.dataSources.connectionType` (string) Enum: "api", "ftp", "sftp", "sql", "web_hook", "email", "virtual_ftp" - `capacityContract.integration.dataSources.requestMethod` (string) Enum: "get", "post", "put", "patch", "delete" - `capacityContract.integration.dataSources.dataType` (string) Enum: "xml", "json", "csv", "empty" - `capacityContract.integration.dataSources.entityType` (string) Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do" - `capacityContract.integration.dataSources.url` (string) - `capacityContract.integration.dataSources.port` (integer) - `capacityContract.integration.dataSources.path` (string) - `capacityContract.integration.dataSources.token` (string) - `capacityContract.integration.dataSources.query` (string) - `capacityContract.integration.dataSources.parameters` (array) - `capacityContract.integration.dataSources.parameters.sequenceNr` (integer) - `capacityContract.integration.dataSources.parameters.type` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `capacityContract.integration.dataSources.parameters.regex` (string) - `capacityContract.integration.dataSources.parameters.format` (string) - `capacityContract.integration.dataSources.parameters.locale` (string) - `capacityContract.integration.dataSources.parameters.zoneId` (string) - `capacityContract.integration.dataSources.parameters.incomingPath` (string) - `capacityContract.integration.dataSources.parameters.outgoingPath` (string) - `capacityContract.integration.dataSources.parameters.insertRegexSelector` (string) - `capacityContract.integration.dataSources.parameters.insertType` (string) Enum: "before", "replace", "after" - `capacityContract.integration.dataSources.parameters.insertValue` (string) - `capacityContract.integration.dataSources.parameters.defaultValue` (string) - `capacityContract.integration.dataSources.parameters.fields` (array) - `capacityContract.integration.dataSources.parameters.filters` (array) - `capacityContract.integration.dataSources.parameters.options` (array) Enum: "identifier", "to_lower_case", "to_upper_case", "capitalize", "trim", "remove_all_whitespace", "filters" - `capacityContract.integration.dataSources.allowedIps` (array) - `capacityContract.integration.dataSources.hasAuthentication` (boolean) - `capacityContract.integration.dataSources.credentials` (object) - `capacityContract.integration.dataSources.credentials.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `capacityContract.integration.dataSources.credentials.uuid` (string, required) - `capacityContract.integration.dataSources.credentials.primaryPlatformId` (string, required) - `capacityContract.integration.dataSources.credentials.language` (object) circular reference - `capacityContract.integration.dataSources.credentials.authenticationMethod` (string) Enum: "apiKey", "accessKeys", "basic", "OAuth", "bearer", "openId", "clientKeysOpenId", "clientKeys", "headers" - `capacityContract.integration.dataSources.credentials.username` (string) - `capacityContract.integration.dataSources.credentials.password` (string) - `capacityContract.integration.dataSources.credentials.accessKey` (string) - `capacityContract.integration.dataSources.credentials.secretKey` (string) - `capacityContract.integration.dataSources.credentials.clientId` (string) - `capacityContract.integration.dataSources.credentials.clientSecret` (string) - `capacityContract.integration.dataSources.credentials.grantType` (string) - `capacityContract.integration.dataSources.credentials.scope` (string) - `capacityContract.integration.dataSources.credentials.apiKey` (string) - `capacityContract.integration.dataSources.credentials.bearer` (string) - `capacityContract.integration.dataSources.credentials.sshKey` (object) - `capacityContract.integration.dataSources.credentials.sshTunnel` (boolean) - `capacityContract.integration.dataSources.credentials.sshHost` (string) - `capacityContract.integration.dataSources.credentials.sshUsername` (string) - `capacityContract.integration.dataSources.credentials.sshPassword` (string) - `capacityContract.integration.dataSources.credentials.externalAttributes` (object) - `capacityContract.integration.dataSources.credentials.headers` (object) - `capacityContract.integration.dataSources.credentials.oauthUrl` (string) - `capacityContract.integration.dataSources.credentials.oAuthCache` (string) - `capacityContract.integration.dataSources.credentials.oAuthCacheCreationDate` (string) - `capacityContract.integration.dataSources.credentials.openIdToken` (string) - `capacityContract.integration.dataSources.credentials.openIdRefreshToken` (string) - `capacityContract.integration.dataSources.credentials.openIdAccessToken` (string) - `capacityContract.integration.dataSources.credentials.openIdExpiration` (string) - `capacityContract.integration.dataSources.otm` (boolean) - `capacityContract.integration.dataSources.fields` (array) - `capacityContract.integration.dataSources.filters` (array) - `capacityContract.integration.dataSources.template` (boolean) - `capacityContract.integration.enabled` (boolean) - `capacityContract.integration.lastHandled` (string) - `capacityContract.messageAutomation` (object) - `adr` (object) - `adr.hasADR` (boolean) - `adr.ADRNumber` (string) - `adr.ADRValidFromDate` (string) - `adr.ADRExpirationDate` (string) - `adr.ADRFiles` (array) - `adr.ADRFiles.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `adr.ADRFiles.url` (string) - `adr.ADRFiles.path` (string) - `adr.ADRFiles.name` (string) - `adr.ADRFiles.originalName` (string) - `adr.ADRFiles.size` (integer) - `adr.ADRFiles.purpose` (string) - `adr.ADRFiles.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `adr.ADRFiles.mimeType` (string) - `adr.ADRFiles.extension` (string) - `adr.ADRFiles.identifiers` (array) - `adr.ADRFiles.bucket` (object) - `adr.ADRFiles.bucket.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `adr.ADRFiles.bucket.name` (string) - `adr.ADRFiles.uploadedAt` (string) - `adr.ADRFiles.tempFile` (string) - `driverLicense` (object) - `driverLicense.hasDriverLicense` (boolean) - `driverLicense.driverLicenseNumber` (string) - `driverLicense.driverLicenseValidFromDate` (string) - `driverLicense.driverLicenseExpirationDate` (string) - `driverLicense.driverLicenseObtainedOn` (string) - `driverLicense.driverLicenseCountryOfIssue` (string) - `driverLicense.driverLicenseIssuingAuthority` (string) - `driverLicense.driverLicenseFiles` (array) - `tachoCard` (object) - `tachoCard.cardId` (string) - `tachoCard.countryOfIssue` (string) - `tachoCard.renewalIndex` (string) - `tachoCard.replacementIndex` (string) - `tachoCard.startOfValidity` (string) - `tachoCard.endOfValidity` (string) - `operational` (boolean) - `remainingRestingTimes` (object) - `remainingRestingTimes.workWeek` (object) - `remainingRestingTimes.workWeek.total` (integer) - `remainingRestingTimes.workWeek.maximum` (integer) - `remainingRestingTimes.workWeek.minimum` (integer) - `remainingRestingTimes.workWeek.remaining` (integer) - `remainingRestingTimes.workWeekEndWithoutCompensation` (string) - `remainingRestingTimes.nextMinimumWeeklyRestWithoutCompensation` (integer) - `remainingRestingTimes.breakBelowMinimum` (object) - `remainingRestingTimes.dailyRest` (object) - `remainingRestingTimes.previousDailyRest` (object) - `remainingDrivingTimes` (object) - `remainingDrivingTimes.daysOfReducedRest` (object) - `remainingDrivingTimes.dailyAmplitude` (object) - `remainingDrivingTimes.drivingTimeBelowMaximum` (object) - `remainingDrivingTimes.dailyDrivingTime` (object) - `remainingDrivingTimes.daysOfDrivingLongerThan9h` (object) - `remainingDrivingTimes.weeklyDrivingTime` (object) - `remainingDrivingTimes.BIWeeklyDrivingTime` (object) - `remainingDrivingTimes.daysOfConsecutiveDriving` (object) - `upcomingRestingTimes` (object) - `upcomingRestingTimes.week` (integer) - `upcomingRestingTimes.year` (integer) - `upcomingRestingTimes.upcomingRestingTime` (integer) The upcoming resting times in seconds - `languages` (array) - `notes` (array) - `notes.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `notes.uuid` (string, required) - `notes.primaryPlatformId` (string, required) - `notes.language` (object) circular reference - `notes.author` (object) circular reference - `notes.name` (string) - `notes.text` (string) - `boardComputers` (array) - `lastActivity` (object) - `lastActivity.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `lastActivity.uuid` (string, required) - `lastActivity.primaryPlatformId` (string, required) - `lastActivity.language` (object) circular reference - `lastActivity.type` (string) Enum: "work", "driving", "available", "rest", "vacation" - `lastActivity.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `lastActivity.chauffeur` (object) circular reference - `lastActivity.vehicle` (object) circular reference - `lastActivity.transportEquipments` (array) - `lastActivity.trip` (object) circular reference - `lastActivity.name` (string) - `lastActivity.description` (string) - `lastActivity.remarks` (string) - `lastActivity.kmsStart` (integer) - `lastActivity.kmsEnd` (integer) - `lastActivity.start` (string) - `lastActivity.end` (string) - `lastActivity.isFromTacho` (boolean) - `contactDetails` (array) - `contactDetails.associationType` (string) Enum: "inline", "reference" - `pricingModules` (array) - `pricingModules.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `pricingModules.uuid` (string, required) - `pricingModules.primaryPlatformId` (string, required) - `pricingModules.language` (object) circular reference - `pricingModules.type` (string) Enum: "fixed", "percentage", "time", "table", "zone", "ab", "unit", "element", "variable_adjustment", "formula", "tql_formula", "excel", "field", "modules", "highest_module_value", "lowest_module_value", "subscription" - `pricingModules.name` (string) - `pricingModules.sequenceNr` (integer) - `pricingModules.description` (string) - `pricingModules.category` (object) - `pricingModules.category.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `pricingModules.category.uuid` (string, required) - `pricingModules.category.primaryPlatformId` (string, required) - `pricingModules.category.language` (object) circular reference - `pricingModules.category.name` (string) - `pricingModules.category.creditCode` (string) - `pricingModules.category.debitCode` (string) - `pricingModules.category.defaultValue` (number) - `pricingModules.category.enabled` (boolean) - `pricingModules.category.tripRevenue` (boolean) - `pricingModules.taxRates` (array) - `pricingModules.taxRates.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `pricingModules.taxRates.uuid` (string, required) - `pricingModules.taxRates.primaryPlatformId` (string, required) - `pricingModules.taxRates.language` (object) circular reference - `pricingModules.taxRates.sequenceNr` (integer) - `pricingModules.taxRates.name` (string) - `pricingModules.taxRates.description` (string) - `pricingModules.taxRates.taxRate` (object) - `pricingModules.taxRates.taxRate.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `pricingModules.taxRates.taxRate.uuid` (string, required) - `pricingModules.taxRates.taxRate.primaryPlatformId` (string, required) - `pricingModules.taxRates.taxRate.language` (object) circular reference - `pricingModules.taxRates.taxRate.name` (string) - `pricingModules.taxRates.taxRate.creditCode` (string) - `pricingModules.taxRates.taxRate.debitCode` (string) - `pricingModules.taxRates.taxRate.description` (string) - `pricingModules.taxRates.taxRate.jurisdiction` (string) - `pricingModules.taxRates.taxRate.percentage` (number) - `pricingModules.taxRates.taxRate.inclusive` (boolean) - `pricingModules.taxRates.taxRate.active` (boolean) - `pricingModules.taxRates.taxRate.identifiers` (array) - `pricingModules.taxRates.filters` (array) - `pricingModules.filters` (array) - `pricingModules.oncePerInvoice` (boolean) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `chauffeur` (object) ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)