# Create consignment Create a new consignment Endpoint: POST /consignment Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Header parameters: - `Authorization` (string, required) ## Request fields (application/json): - `nonce` (string) - `name` (string, required) Name of the Consignment. For display purposes and search only. - `consignmentNr` (string) - `description` (string) - `status` (string) Enum: "draft", "requested", "confirmed", "in_transit", "completed", "cancelled", "partially_planned", "planned", "partially_completed", "partially_in_transit", "concept" - `goods` (array) - `goods.associationType` (string) Enum: "inline", "reference" - `combined` (boolean) - `consignment` (object) - `consignment.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. - `consignment.uuid` (string, required) - `consignment.primaryPlatformId` (string, required) - `consignment.language` (object) circular reference - `consignment.name` (string, required) Name of the Consignment. For display purposes and search only. - `consignment.consignmentNr` (string) - `consignment.description` (string) General description of consignment in Free text. e.g 20 europallets fruit. Meant for human inspection, not for automating processes. - `consignment.status` (string) Enum: "draft", "requested", "confirmed", "in_transit", "completed", "cancelled", "partially_planned", "planned", "partially_completed", "partially_in_transit", "concept" - `consignment.highValueGoods` (boolean) - `consignment.goods` (array) - `consignment.team` (object) circular reference - `consignment.combined` (boolean) - `consignment.consignment` (object) circular reference - `consignment.originalPhysicalSender` (object) circular reference - `consignment.originalLegalSender` (object) circular reference - `consignment.originalPhysicalAddressee` (object) circular reference - `consignment.originalLegalAddressee` (object) circular reference - `consignment.currentLocation` (object) circular reference - `consignment.currentLocation.administrativeReference` (object) - `consignment.currentLocation.administrativeReference.name` (string) - `consignment.currentLocation.administrativeReference.street` (string) - `consignment.currentLocation.administrativeReference.houseNumber` (string) - `consignment.currentLocation.administrativeReference.houseNumberAddition` (string) - `consignment.currentLocation.administrativeReference.postalCode` (string) - `consignment.currentLocation.administrativeReference.city` (string) - `consignment.currentLocation.administrativeReference.country` (string) - `consignment.currentLocation.lat` (number) - `consignment.currentLocation.lon` (number) - `consignment.currentLocation.speed` (object) - `consignment.currentLocation.speed.value` (string) - `consignment.currentLocation.speed.unit` (string) - `consignment.currentLocation.heading` (object) - `consignment.currentLocation.bearing` (object) - `consignment.currentLocation.bearingType` (string) Enum: "absolute", "relative" - `consignment.nextAction` (object) circular reference - `consignment.lastAction` (object) circular reference - `consignment.lastPlannedAction` (object) circular reference - `consignment.isPlannedToLastLocation` (boolean) - `consignment.type` (string) This field can be used to categorize and/or group shipments by type, depending on the needs of a specific logistic process. - `consignment.remark` (string) Remark concerning the complete consignment, to be printed on the transport document. - `consignment.documents` (array) - `consignment.actors` (array) - `consignment.actions` (array) - `consignment.constraints` (array) In the context of a Consignment, constraints can be used to e.g. define minimum or maximum temperatures for consignments, or date time constraints for delivery. - `consignment.identifiers` (array) - `consignment.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. - `consignment.identifiers.uuid` (string, required) - `consignment.identifiers.primaryPlatformId` (string, required) - `consignment.identifiers.language` (object) circular reference - `consignment.identifiers.name` (string) - `consignment.identifiers.system` (string) - `consignment.identifiers.value` (string) - `consignment.identifiers.expiredAt` (string) - `consignment.attributes` (array) - `consignment.attributes.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. - `consignment.attributes.uuid` (string, required) - `consignment.attributes.primaryPlatformId` (string, required) - `consignment.attributes.language` (object) circular reference - `consignment.attributes.name` (string) - `consignment.attributes.color` (string) - `consignment.externalAttributes` (object) - `consignment.expectedRevenue` (object) - `consignment.expectedRevenue.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. - `consignment.expectedRevenue.uuid` (string, required) - `consignment.expectedRevenue.primaryPlatformId` (string, required) - `consignment.expectedRevenue.language` (object) circular reference - `consignment.expectedRevenue.amount` (number) - `consignment.expectedRevenue.currency` (object) - `consignment.expectedRevenue.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. - `consignment.expectedRevenue.currency.uuid` (string, required) - `consignment.expectedRevenue.currency.primaryPlatformId` (string, required) - `consignment.expectedRevenue.currency.language` (object) circular reference - `consignment.expectedRevenue.currency.name` (string) - `consignment.expectedRevenue.currency.short` (string) - `consignment.expectedRevenue.currency.sign` (string) - `consignment.expectedRevenue.currency.decimalDelimiter` (string) - `consignment.expectedRevenue.currency.thousandDelimiter` (string) - `consignment.expectedRevenue.currency.enabled` (boolean) - `consignment.expectedRevenue.taxRate` (object) - `consignment.expectedRevenue.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. - `consignment.expectedRevenue.taxRate.creditCode` (string) - `consignment.expectedRevenue.taxRate.debitCode` (string) - `consignment.expectedRevenue.taxRate.identifiers` (array) - `consignment.expectedRevenue.taxRate.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. - `consignment.expectedRevenue.taxRate.identifiers.name` (string) - `consignment.expectedRevenue.taxRate.identifiers.system` (string) - `consignment.expectedRevenue.taxRate.identifiers.value` (string) - `consignment.expectedRevenue.taxRate.identifiers.expiredAt` (string) - `consignment.expectedRevenue.taxRate.name` (string) - `consignment.expectedRevenue.taxRate.description` (string) - `consignment.expectedRevenue.taxRate.jurisdiction` (string) - `consignment.expectedRevenue.taxRate.percentage` (number) - `consignment.expectedRevenue.taxRate.inclusive` (boolean) - `consignment.expectedRevenue.taxRate.active` (boolean) - `consignment.expectedRevenue.inclusiveOfTax` (boolean) - `consignment.expectedRevenue.moneyBuildBlocks` (array) - `consignment.expectedRevenue.moneyBuildBlocks.amount` (number) - `consignment.expectedRevenue.moneyBuildBlocks.relationship` (object) - `consignment.expectedRevenue.moneyBuildBlocks.relationship.entityId` (string) - `consignment.expectedRevenue.moneyBuildBlocks.relationship.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" - `consignment.hasAgreedToPrice` (boolean) Set this value to 'true' if the user has agreed to the pricing of this element. Only needed once the NeedsBillingApproval Exception is thrown - `consignment.versionNumber` (integer) - `consignment.nextPlanFromAction` (object) circular reference - `originalPhysicalSender` (object) - `originalPhysicalSender.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. - `originalPhysicalSender.uuid` (string, required) - `originalPhysicalSender.primaryPlatformId` (string, required) - `originalPhysicalSender.language` (object) circular reference - `originalPhysicalSender.type` (string) Enum: "warehouse", "store", "environmentalZone", "restrictedArea", "customer", "parkingSpot", "loadingUnloadingArea", "operationalBase", "fuelStation" - `originalPhysicalSender.name` (string) - `originalPhysicalSender.unCode` (string) - `originalPhysicalSender.geoReference` (object) - `originalPhysicalSender.geoReference.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. - `originalPhysicalSender.geoReference.uuid` (string, required) - `originalPhysicalSender.geoReference.primaryPlatformId` (string, required) - `originalPhysicalSender.geoReference.language` (object) circular reference - `originalPhysicalSender.geoReference.type` (string) Enum: "addressGeoReference", "zoneGeoReference", "tmcArrayGeoReference", "tmcLocationGeoReference", "openLRGeoReference", "GeoReference", "Feature", "latLonArrayGeoReference", "latLonPointGeoReference" - `originalPhysicalSender.administrativeReference` (object) - `originalPhysicalSender.contactDetails` (array) - `originalPhysicalSender.contactDetails.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. - `originalPhysicalSender.contactDetails.uuid` (string, required) - `originalPhysicalSender.contactDetails.primaryPlatformId` (string, required) - `originalPhysicalSender.contactDetails.language` (object) circular reference - `originalPhysicalSender.contactDetails.type` (string) Enum: "iban", "gln", "vatCode", "name", "lastName", "middleName", "firstName", "phone", "mobilePhone", "email", "language", "other" - `originalPhysicalSender.contactDetails.value` (string) - `originalPhysicalSender.contactDetails.remarks` (string) - `originalPhysicalSender.openingTimes` (object) - `originalPhysicalSender.openingTimes.monday` (object) - `originalPhysicalSender.openingTimes.monday.start` (string) - `originalPhysicalSender.openingTimes.monday.end` (string) - `originalPhysicalSender.openingTimes.monday.open` (boolean) - `originalPhysicalSender.openingTimes.monday.day` (string) - `originalPhysicalSender.openingTimes.monday.name` (string) - `originalPhysicalSender.openingTimes.monday.description` (string) - `originalPhysicalSender.openingTimes.tuesday` (object) - `originalPhysicalSender.openingTimes.wednesday` (object) - `originalPhysicalSender.openingTimes.thursday` (object) - `originalPhysicalSender.openingTimes.friday` (object) - `originalPhysicalSender.openingTimes.saturday` (object) - `originalPhysicalSender.openingTimes.sunday` (object) - `originalPhysicalSender.terminal` (object) - `originalPhysicalSender.terminal.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. - `originalPhysicalSender.terminal.uuid` (string, required) - `originalPhysicalSender.terminal.primaryPlatformId` (string, required) - `originalPhysicalSender.terminal.language` (object) circular reference - `originalPhysicalSender.terminal.name` (string, required) - `originalPhysicalSender.terminal.integrationType` (string) Enum: "portbase", "psa", "dpworld" - `originalPhysicalSender.terminal.ean` (string) - `originalPhysicalSender.terminal.bicsCode` (string) - `originalPhysicalSender.terminal.quayName` (string) - `originalPhysicalSender.terminal.smdgCode` (string) - `originalPhysicalSender.terminal.locations` (array) - `originalPhysicalSender.terminal.allowedModalities` (array) - `originalPhysicalSender.terminal.terminalSettings` (array) - `originalPhysicalSender.terminal.terminalSettings.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. - `originalPhysicalSender.terminal.terminalSettings.uuid` (string, required) - `originalPhysicalSender.terminal.terminalSettings.primaryPlatformId` (string, required) - `originalPhysicalSender.terminal.terminalSettings.language` (object) circular reference - `originalPhysicalSender.terminal.terminalSettings.loading` (boolean) - `originalPhysicalSender.terminal.terminalSettings.full` (boolean) - `originalPhysicalSender.terminal.terminalSettings.modality` (string) - `originalPhysicalSender.terminal.terminalSettings.sealNumberAllowed` (boolean) - `originalPhysicalSender.terminal.terminalSettings.reeferAllowed` (boolean) - `originalPhysicalSender.terminal.terminalSettings.grossWeightAllowed` (boolean) - `originalPhysicalSender.terminal.terminalSettings.outOfGaugeAllowed` (boolean) - `originalPhysicalSender.terminal.terminalSettings.dangerousGoodsAllowed` (boolean) - `originalPhysicalSender.terminal.terminalSettings.cargoCutOffInMinutes` (integer) - `originalPhysicalSender.terminal.tarRequired` (boolean) - `originalPhysicalSender.terminal.roadLicenseIdRequired` (boolean) - `originalPhysicalSender.actions` (array) - `originalPhysicalSender.actions.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. - `originalPhysicalSender.actions.uuid` (string, required) - `originalPhysicalSender.actions.primaryPlatformId` (string, required) - `originalPhysicalSender.actions.language` (object) circular reference - `originalPhysicalSender.actions.type` (string) Enum: "load", "unload", "handOver", "stop", "move", "attachTransportEquipment", "detachTransportEquipment", "attachChauffeur", "detachChauffeur", "genericAction", "wait", "break", "refuel", "customs", "weighing", "typeTakeAndReturn", "booking" - `originalPhysicalSender.actions.groupId` (string) - `originalPhysicalSender.actions.name` (string, required) The name of the action - `originalPhysicalSender.actions.externalAttributes` (object) - `originalPhysicalSender.actions.identifiers` (array) - `originalPhysicalSender.actions.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `originalPhysicalSender.actions.result` (object) - `originalPhysicalSender.actions.result.status` (string) Enum: "succeeded", "failed", "partiallySucceeded", "cancelled" - `originalPhysicalSender.actions.result.remark` (string) - `originalPhysicalSender.actions.result.reason` (string) - `originalPhysicalSender.actions.result.results` (array) - `originalPhysicalSender.actions.result.answers` (object) - `originalPhysicalSender.actions.result.attachments` (array) - `originalPhysicalSender.actions.result.attachments.questionId` (string) - `originalPhysicalSender.actions.result.attachments.type` (string) Enum: "photo", "signature", "document" - `originalPhysicalSender.actions.result.attachments.documentId` (string) - `originalPhysicalSender.actions.result.attachments.dataUrl` (string) - `originalPhysicalSender.actions.remark` (string) - `originalPhysicalSender.actions.sequenceNr` (integer) The number in which order the Action occurs - `originalPhysicalSender.actions.tripSequenceNr` (integer) The number in which order the Action occurs within the trip - `originalPhysicalSender.actions.location` (object) - `originalPhysicalSender.actions.location.associationType` (string) Enum: "inline", "reference" - `originalPhysicalSender.actions.startTime` (string) - `originalPhysicalSender.actions.endTime` (string) - `originalPhysicalSender.actions.eta` (string) - `originalPhysicalSender.actions.etd` (string) - `originalPhysicalSender.actions.timeFormat` (string) - `originalPhysicalSender.actions.recurrence` (string) - `originalPhysicalSender.actions.duration` (integer) The actual duration of the action in minutes - `originalPhysicalSender.actions.estimatedDuration` (integer) The estimated duration of the action in minutes - `originalPhysicalSender.actions.inTripOnly` (boolean) - `originalPhysicalSender.actions.actions` (array) - `originalPhysicalSender.actions.actions.associationType` (string) Enum: "inline", "reference" - `originalPhysicalSender.actions.communicationRequests` (array) - `originalPhysicalSender.actions.communicationRequests.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. - `originalPhysicalSender.actions.communicationRequests.uuid` (string, required) - `originalPhysicalSender.actions.communicationRequests.primaryPlatformId` (string, required) - `originalPhysicalSender.actions.communicationRequests.language` (object) circular reference - `originalPhysicalSender.actions.communicationRequests.name` (string) - `originalPhysicalSender.actions.communicationRequests.description` (string) - `originalPhysicalSender.actions.communicationRequests.status` (string) Enum: "pending", "processing", "success", "failure" - `originalPhysicalSender.actions.communicationRequests.responseMessage` (string) - `originalPhysicalSender.actions.communicationRequests.responseValue` (string) - `originalPhysicalSender.actions.documents` (array) - `originalPhysicalSender.actions.contextEvents` (array) - `originalPhysicalSender.actions.contextEvents.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. - `originalPhysicalSender.actions.contextEvents.uuid` (string, required) - `originalPhysicalSender.actions.contextEvents.primaryPlatformId` (string, required) - `originalPhysicalSender.actions.contextEvents.language` (object) circular reference - `originalPhysicalSender.actions.contextEvents.type` (string) Enum: "generalEvent", "sensorUpdateEvent", "gateInEvent", "gateOutEvent", "arrivalEvent", "departureEvent", "stopEngineEvent", "startEngineEvent", "startWaitingEvent", "stopWaitingEvent", "stopMovingEvent", "startMovingEvent", "locationUpdateEvent", "updateEvent", "associationRemovedEvent", "associationCreatedEvent", "capacityChangeEvent" - `originalPhysicalSender.actions.contextEvents.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `originalPhysicalSender.actions.contextEvents.externalAttributes` (object) - `originalPhysicalSender.actions.contextEvents.identifiers` (array) - `originalPhysicalSender.actions.contextEvents.dateTime` (string) - `originalPhysicalSender.actions.attributes` (array) - `originalPhysicalSender.actions.versionNumber` (integer) - `originalPhysicalSender.actions.constraints` (array) - `originalPhysicalSender.actions.constraints.associationType` (string, required) - `originalPhysicalSender.constraints` (array) - `originalPhysicalSender.constraints.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. - `originalPhysicalSender.constraints.uuid` (string, required) - `originalPhysicalSender.constraints.primaryPlatformId` (string, required) - `originalPhysicalSender.constraints.language` (object) circular reference - `originalPhysicalSender.constraints.type` (string) Enum: "accessConstraint", "timeConstraint", "timeWindowsConstraint", "startDateTimeConstraint", "endDateTimeConstraint", "sizeConstraint", "weightConstraint", "speedConstraint", "sensorValueConstraint", "fuelTypeConstraint", "vehicleTypeConstraint", "emissionStandardConstraint", "attributeConstraint", "transportEquipmentTypeConstraint", "routeConstraint", "andConstraint", "orConstraint", "notConstraint", "genericConstraint" - `originalPhysicalSender.constraints.name` (string) - `originalPhysicalSender.constraints.enforceability` (string) Enum: "enforced", "preference" - `originalPhysicalSender.pricingElements` (array) - `originalPhysicalSender.pricingElements.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. - `originalPhysicalSender.pricingElements.uuid` (string, required) - `originalPhysicalSender.pricingElements.primaryPlatformId` (string, required) - `originalPhysicalSender.pricingElements.language` (object) circular reference - `originalPhysicalSender.pricingElements.sequenceNr` (integer) - `originalPhysicalSender.pricingElements.quantity` (integer) - `originalPhysicalSender.pricingElements.name` (string) - `originalPhysicalSender.pricingElements.description` (string) - `originalPhysicalSender.pricingElements.category` (object) - `originalPhysicalSender.pricingElements.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. - `originalPhysicalSender.pricingElements.category.uuid` (string, required) - `originalPhysicalSender.pricingElements.category.primaryPlatformId` (string, required) - `originalPhysicalSender.pricingElements.category.language` (object) circular reference - `originalPhysicalSender.pricingElements.category.name` (string) - `originalPhysicalSender.pricingElements.category.creditCode` (string) - `originalPhysicalSender.pricingElements.category.debitCode` (string) - `originalPhysicalSender.pricingElements.category.defaultValue` (number) - `originalPhysicalSender.pricingElements.category.enabled` (boolean) - `originalPhysicalSender.pricingElements.category.tripRevenue` (boolean) - `originalPhysicalSender.pricingElements.business` (object) circular reference - `originalPhysicalSender.remark` (string) - `originalPhysicalSender.hash` (string) - `originalPhysicalSender.identifiers` (array) - `originalPhysicalSender.externalAttributes` (object) - `originalPhysicalSender.dataIsComplete` (boolean) - `originalLegalSender` (object) - `originalPhysicalAddressee` (object) - `originalLegalAddressee` (object) - `currentLocation` (object) circular reference - `nextAction` (object) - `lastAction` (object) - `lastPlannedAction` (object) - `isPlannedToLastLocation` (boolean) - `type` (string) This field can be used to categorize and/or group shipments by type, depending on the needs of a specific logistic process. - `remark` (string) - `documents` (array) - `actors` (array) - `actions` (array) - `constraints` (array) In the context of a Consignment, constraints can be used to e.g. define minimum or maximum temperatures for consignments, or date time constraints for delivery. - `chat` (object) - `chat.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. - `chat.uuid` (string, required) - `chat.primaryPlatformId` (string, required) - `chat.language` (object) circular reference - `chat.title` (string) - `chat.type` (string) Enum: "private", "public" - `chat.image` (object) - `chat.image.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. - `chat.image.uuid` (string, required) - `chat.image.primaryPlatformId` (string, required) - `chat.image.language` (object) circular reference - `chat.image.url` (string) - `chat.image.path` (string) - `chat.image.name` (string) - `chat.image.originalName` (string) - `chat.image.size` (integer) - `chat.image.purpose` (string) - `chat.image.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `chat.image.mimeType` (string) - `chat.image.extension` (string) - `chat.image.identifiers` (array) - `chat.image.bucket` (object) - `chat.image.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. - `chat.image.bucket.uuid` (string, required) - `chat.image.bucket.primaryPlatformId` (string, required) - `chat.image.bucket.language` (object) circular reference - `chat.image.bucket.name` (string) - `chat.image.uploadedAt` (string) - `chat.image.tempFile` (string) - `chat.image.contentMatrix` (array) - `chat.active` (boolean) - `chat.starter` (object) circular reference - `chat.users` (array) - `chat.users.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. - `chat.users.uuid` (string, required) - `chat.users.primaryPlatformId` (string, required) - `chat.users.language` (object) circular reference - `chat.users.chat` (object) circular reference - `chat.users.user` (object) circular reference - `chat.users.business` (object) circular reference - `chat.users.chauffeur` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.uuid` (string, required) - `chat.users.chauffeur.primaryPlatformId` (string, required) - `chat.users.chauffeur.language` (object) circular reference - `chat.users.chauffeur.type` (string) Enum: "driver", "conductor", "captain", "pilot" - `chat.users.chauffeur.picture` (object) - `chat.users.chauffeur.user` (object) circular reference - `chat.users.chauffeur.firstName` (string) - `chat.users.chauffeur.lastName` (string) - `chat.users.chauffeur.dateOfBirth` (string) - `chat.users.chauffeur.birthPlace` (string) - `chat.users.chauffeur.nationality` (string) - `chat.users.chauffeur.hoursPerMonth` (number) - `chat.users.chauffeur.preferredVehicle` (object) circular reference - `chat.users.chauffeur.capacityContract` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.uuid` (string, required) - `chat.users.chauffeur.capacityContract.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.language` (object) circular reference - `chat.users.chauffeur.capacityContract.name` (string) - `chat.users.chauffeur.capacityContract.type` (string) Enum: "permanentContract", "oneTimeContract", "transportOrderContract" - `chat.users.chauffeur.capacityContract.communicationMethod` (string) Enum: "messageAutomation", "integration", "pdf" - `chat.users.chauffeur.capacityContract.contract` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.contract.uuid` (string, required) - `chat.users.chauffeur.capacityContract.contract.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.contract.language` (object) circular reference - `chat.users.chauffeur.capacityContract.contract.title` (string) - `chat.users.chauffeur.capacityContract.contract.description` (string) - `chat.users.chauffeur.capacityContract.contract.deliveryTerms` (string) Enum: "EXW", "FCA", "FAS", "FOB", "CPT", "CIP", "CFR", "CIF", "DAP", "DPU", "DDP" - `chat.users.chauffeur.capacityContract.contract.contractor` (object) circular reference - `chat.users.chauffeur.capacityContract.contract.contractorSignee` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.contract.contractorSignee.uuid` (string, required) - `chat.users.chauffeur.capacityContract.contract.contractorSignee.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.contract.contractorSignee.language` (object) circular reference - `chat.users.chauffeur.capacityContract.contract.contractorSignee.firstName` (string) - `chat.users.chauffeur.capacityContract.contract.contractorSignee.lastName` (string) - `chat.users.chauffeur.capacityContract.contract.contractorSignee.position` (string) - `chat.users.chauffeur.capacityContract.contract.contractorSignee.email` (string) - `chat.users.chauffeur.capacityContract.contract.contractorSignee.phone` (string) - `chat.users.chauffeur.capacityContract.contract.contractorSignee.mobilePhone` (string) - `chat.users.chauffeur.capacityContract.contract.client` (object) circular reference - `chat.users.chauffeur.capacityContract.contract.clientSignee` (object) - `chat.users.chauffeur.capacityContract.business` (object) circular reference - `chat.users.chauffeur.capacityContract.administration` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.administration.uuid` (string, required) - `chat.users.chauffeur.capacityContract.administration.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.administration.language` (object) circular reference - `chat.users.chauffeur.capacityContract.administration.platforms` (array) - `chat.users.chauffeur.capacityContract.administration.name` (string) - `chat.users.chauffeur.capacityContract.administration.primary` (boolean) - `chat.users.chauffeur.capacityContract.administration.transportOrderPrefix` (string) - `chat.users.chauffeur.capacityContract.administration.consignmentPrefix` (string) - `chat.users.chauffeur.capacityContract.administration.business` (object) circular reference - `chat.users.chauffeur.capacityContract.administration.currency` (object) - `chat.users.chauffeur.capacityContract.administration.bankAccounts` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.administration.bankAccounts.uuid` (string, required) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.language` (object) circular reference - `chat.users.chauffeur.capacityContract.administration.bankAccounts.accountHolderName` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.accountHolderType` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.bankName` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.routingNumber` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.accountNumber` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.last4` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.currency` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.administration.bankAccounts.currency.name` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.currency.short` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.currency.sign` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.currency.decimalDelimiter` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.currency.thousandDelimiter` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.currency.enabled` (boolean) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.country` (string) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.validation` (object) circular reference - `chat.users.chauffeur.capacityContract.administration.bankAccounts.validated` (boolean) - `chat.users.chauffeur.capacityContract.administration.bankAccounts.identifiers` (array) - `chat.users.chauffeur.capacityContract.administration.numberFormat` (string) - `chat.users.chauffeur.capacityContract.administration.numberLength` (integer) - `chat.users.chauffeur.capacityContract.administration.dueDays` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceNumberIndex` (object) - `chat.users.chauffeur.capacityContract.administration.quoteNumberIndex` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.uuid` (string, required) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.language` (object) circular reference - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.type` (string) Enum: "messageAutomation", "questionAnswerAutomation", "fileRequestAutomation" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.name` (string, required) The name of a messageAutomation - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.description` (string, required) The description of a messageAutomation - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.triggerType` (string) Enum: "trigger", "scheduler", "listener" - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleValue` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleType` (string) Enum: "seconds", "minutes", "hours", "days", "months" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.schedule.milliseconds` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSelector` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSchedule` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.selector` (string) - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.value` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.linkType` (string) Enum: "and", "or" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.filters` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.sequenceNr` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.filters.valueSelector` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.fields` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.fields.name` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.fields.groupByAggregate` (string) Enum: "count", "max", "min", "sum", "avg" - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins.type` (string) Enum: "inner_join" - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onLeft` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onRight` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.sequenceNr` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.field` (string) - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.value` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.valueType` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.filters.linkType` (string) Enum: "and", "or" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.groupBy` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.having` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.sortFields` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.sortDirection` (string) Enum: "asc", "desc" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.limit` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.query.offset` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.recipients` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.recipientSelector` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.toggleForAll` (boolean) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.channel` (string) Enum: "email", "chat", "notification", "whatsapp", "telegram" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.manualIntegration` (object) circular reference - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.includeAttachments` (boolean) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentSourceType` (string) Enum: "ENTITY_PDF", "CUSTOM_TEMPLATE", "INSIGHT_REPORT", "STATIC_FILE" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentType` (string) Enum: "cmr", "waybill", "invoice", "quote", "transportOrder", "trip", "custom" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentTemplateId` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileUrl` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.insightType` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.reportParameters` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.entityIdSelector` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileNameTemplate` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.subject` (string) The subject of a message for a particular messageAutomation - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.currentTriggerPosition` (integer) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.name` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.localName` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.code` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.iso3166` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.decimalDelimiter` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.thousandDelimiter` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.dateFormat` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.measurementUnit` (string) Enum: "metric", "imperial" - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.content` (string, required) The template of a message for a particular messageAutomation - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.messageTemplate` (string, required) The template of a message for a particular messageAutomation - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.subject` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.defaultLanguageId` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.languageSelector` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.userEnableable` (boolean) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.automationConfig.userPermissionFilters` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.messageAutomationIntegration` (object) circular reference - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.enabled` (boolean) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.lastHandled` (string) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.template` (boolean) - `chat.users.chauffeur.capacityContract.administration.invoiceSendMessageAutomation.templateCategory` (string) - `chat.users.chauffeur.capacityContract.administration.automaticallySendReminders` (boolean) - `chat.users.chauffeur.capacityContract.administration.invoiceFirstReminderMessageAutomation` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceSecondReminderMessageAutomation` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceThirdReminderMessageAutomation` (object) - `chat.users.chauffeur.capacityContract.administration.invoicePaidMessageAutomation` (object) - `chat.users.chauffeur.capacityContract.administration.quoteSendMessageAutomation` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceTermsAndConditions` (array) - `chat.users.chauffeur.capacityContract.administration.invoiceTermsAndConditions.language` (object) - `chat.users.chauffeur.capacityContract.administration.invoiceTermsAndConditions.text` (string) - `chat.users.chauffeur.capacityContract.administration.quoteTermsAndConditions` (array) - `chat.users.chauffeur.capacityContract.administration.transportOrderTermsAndConditions` (array) - `chat.users.chauffeur.capacityContract.administration.identifiers` (array) - `chat.users.chauffeur.capacityContract.startTime` (string) - `chat.users.chauffeur.capacityContract.endTime` (string) - `chat.users.chauffeur.capacityContract.selfBilling` (boolean) - `chat.users.chauffeur.capacityContract.currency` (object) - `chat.users.chauffeur.capacityContract.triggerType` (string) Enum: "endOfWeek", "endOfWeekOrMonth", "endOfMonth", "endOfQuarter", "endOfTrip", "endOfTransportOrder" - `chat.users.chauffeur.capacityContract.pricingModules` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.pricingModules.name` (string) - `chat.users.chauffeur.capacityContract.pricingModules.sequenceNr` (integer) - `chat.users.chauffeur.capacityContract.pricingModules.description` (string) - `chat.users.chauffeur.capacityContract.pricingModules.category` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.pricingModules.category.name` (string) - `chat.users.chauffeur.capacityContract.pricingModules.category.creditCode` (string) - `chat.users.chauffeur.capacityContract.pricingModules.category.debitCode` (string) - `chat.users.chauffeur.capacityContract.pricingModules.category.defaultValue` (number) - `chat.users.chauffeur.capacityContract.pricingModules.category.enabled` (boolean) - `chat.users.chauffeur.capacityContract.pricingModules.category.tripRevenue` (boolean) - `chat.users.chauffeur.capacityContract.pricingModules.category.identifiers` (array) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.sequenceNr` (integer) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.name` (string) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.description` (string) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.taxRate` (object) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.filters` (array) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.filters.selector` (string) - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.filters.value` (string) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.filters.linkType` (string) Enum: "and", "or" - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.filters.filters` (array) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.filters.sequenceNr` (integer) - `chat.users.chauffeur.capacityContract.pricingModules.taxRates.filters.valueSelector` (string) - `chat.users.chauffeur.capacityContract.pricingModules.filters` (array) - `chat.users.chauffeur.capacityContract.pricingModules.oncePerInvoice` (boolean) - `chat.users.chauffeur.capacityContract.lastHandledSelfBilling` (string) - `chat.users.chauffeur.capacityContract.signature` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.signature.uuid` (string, required) - `chat.users.chauffeur.capacityContract.signature.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.signature.language` (object) circular reference - `chat.users.chauffeur.capacityContract.signature.ip` (string) - `chat.users.chauffeur.capacityContract.signature.userAgent` (string) - `chat.users.chauffeur.capacityContract.signature.date` (string) - `chat.users.chauffeur.capacityContract.signature.file` (object) - `chat.users.chauffeur.capacityContract.integration` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.integration.uuid` (string, required) - `chat.users.chauffeur.capacityContract.integration.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.integration.language` (object) circular reference - `chat.users.chauffeur.capacityContract.integration.type` (string) Enum: "manual", "configured", "messageAutomation", "fileTemplate", "apiAccess" - `chat.users.chauffeur.capacityContract.integration.name` (string) - `chat.users.chauffeur.capacityContract.integration.description` (string) - `chat.users.chauffeur.capacityContract.integration.schedule` (object) - `chat.users.chauffeur.capacityContract.integration.dataSources` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.integration.dataSources.uuid` (string, required) - `chat.users.chauffeur.capacityContract.integration.dataSources.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.integration.dataSources.language` (object) circular reference - `chat.users.chauffeur.capacityContract.integration.dataSources.directionType` (string) Enum: "in", "out" - `chat.users.chauffeur.capacityContract.integration.dataSources.connectionType` (string) Enum: "api", "ftp", "sftp", "sql", "web_hook", "email", "virtual_ftp" - `chat.users.chauffeur.capacityContract.integration.dataSources.requestMethod` (string) Enum: "get", "post", "put", "patch", "delete" - `chat.users.chauffeur.capacityContract.integration.dataSources.dataType` (string) Enum: "xml", "json", "csv", "empty" - `chat.users.chauffeur.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" - `chat.users.chauffeur.capacityContract.integration.dataSources.url` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.port` (integer) - `chat.users.chauffeur.capacityContract.integration.dataSources.path` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.token` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.query` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters` (array) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.sequenceNr` (integer) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.type` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.regex` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.format` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.locale` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.zoneId` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.incomingPath` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.outgoingPath` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.insertRegexSelector` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.insertType` (string) Enum: "before", "replace", "after" - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.insertValue` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.defaultValue` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.fields` (array) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.filters` (array) - `chat.users.chauffeur.capacityContract.integration.dataSources.parameters.options` (array) Enum: "identifier", "to_lower_case", "to_upper_case", "capitalize", "trim", "remove_all_whitespace", "filters" - `chat.users.chauffeur.capacityContract.integration.dataSources.allowedIps` (array) - `chat.users.chauffeur.capacityContract.integration.dataSources.hasAuthentication` (boolean) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.uuid` (string, required) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.primaryPlatformId` (string, required) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.language` (object) circular reference - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.authenticationMethod` (string) Enum: "apiKey", "accessKeys", "basic", "OAuth", "bearer", "openId", "clientKeysOpenId", "clientKeys", "headers" - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.username` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.password` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.accessKey` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.secretKey` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.clientId` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.clientSecret` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.grantType` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.scope` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.apiKey` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.bearer` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.sshKey` (object) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.sshTunnel` (boolean) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.sshHost` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.sshUsername` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.sshPassword` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.externalAttributes` (object) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.headers` (object) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.oauthUrl` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.oAuthCache` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.oAuthCacheCreationDate` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.openIdToken` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.openIdRefreshToken` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.openIdAccessToken` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.credentials.openIdExpiration` (string) - `chat.users.chauffeur.capacityContract.integration.dataSources.otm` (boolean) - `chat.users.chauffeur.capacityContract.integration.dataSources.fields` (array) - `chat.users.chauffeur.capacityContract.integration.dataSources.filters` (array) - `chat.users.chauffeur.capacityContract.integration.dataSources.template` (boolean) - `chat.users.chauffeur.capacityContract.integration.enabled` (boolean) - `chat.users.chauffeur.capacityContract.integration.lastHandled` (string) - `chat.users.chauffeur.capacityContract.messageAutomation` (object) - `chat.users.chauffeur.adr` (object) - `chat.users.chauffeur.adr.hasADR` (boolean) - `chat.users.chauffeur.adr.ADRNumber` (string) - `chat.users.chauffeur.adr.ADRValidFromDate` (string) - `chat.users.chauffeur.adr.ADRExpirationDate` (string) - `chat.users.chauffeur.adr.ADRFiles` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.adr.ADRFiles.url` (string) - `chat.users.chauffeur.adr.ADRFiles.path` (string) - `chat.users.chauffeur.adr.ADRFiles.name` (string) - `chat.users.chauffeur.adr.ADRFiles.originalName` (string) - `chat.users.chauffeur.adr.ADRFiles.size` (integer) - `chat.users.chauffeur.adr.ADRFiles.purpose` (string) - `chat.users.chauffeur.adr.ADRFiles.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `chat.users.chauffeur.adr.ADRFiles.mimeType` (string) - `chat.users.chauffeur.adr.ADRFiles.extension` (string) - `chat.users.chauffeur.adr.ADRFiles.identifiers` (array) - `chat.users.chauffeur.adr.ADRFiles.bucket` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.adr.ADRFiles.bucket.name` (string) - `chat.users.chauffeur.adr.ADRFiles.uploadedAt` (string) - `chat.users.chauffeur.adr.ADRFiles.tempFile` (string) - `chat.users.chauffeur.driverLicense` (object) - `chat.users.chauffeur.driverLicense.hasDriverLicense` (boolean) - `chat.users.chauffeur.driverLicense.driverLicenseNumber` (string) - `chat.users.chauffeur.driverLicense.driverLicenseValidFromDate` (string) - `chat.users.chauffeur.driverLicense.driverLicenseExpirationDate` (string) - `chat.users.chauffeur.driverLicense.driverLicenseObtainedOn` (string) - `chat.users.chauffeur.driverLicense.driverLicenseCountryOfIssue` (string) - `chat.users.chauffeur.driverLicense.driverLicenseIssuingAuthority` (string) - `chat.users.chauffeur.driverLicense.driverLicenseFiles` (array) - `chat.users.chauffeur.tachoCard` (object) - `chat.users.chauffeur.tachoCard.cardId` (string) - `chat.users.chauffeur.tachoCard.countryOfIssue` (string) - `chat.users.chauffeur.tachoCard.renewalIndex` (string) - `chat.users.chauffeur.tachoCard.replacementIndex` (string) - `chat.users.chauffeur.tachoCard.startOfValidity` (string) - `chat.users.chauffeur.tachoCard.endOfValidity` (string) - `chat.users.chauffeur.operational` (boolean) - `chat.users.chauffeur.remainingRestingTimes` (object) - `chat.users.chauffeur.remainingRestingTimes.workWeek` (object) - `chat.users.chauffeur.remainingRestingTimes.workWeek.total` (integer) - `chat.users.chauffeur.remainingRestingTimes.workWeek.maximum` (integer) - `chat.users.chauffeur.remainingRestingTimes.workWeek.minimum` (integer) - `chat.users.chauffeur.remainingRestingTimes.workWeek.remaining` (integer) - `chat.users.chauffeur.remainingRestingTimes.workWeekEndWithoutCompensation` (string) - `chat.users.chauffeur.remainingRestingTimes.nextMinimumWeeklyRestWithoutCompensation` (integer) - `chat.users.chauffeur.remainingRestingTimes.breakBelowMinimum` (object) - `chat.users.chauffeur.remainingRestingTimes.dailyRest` (object) - `chat.users.chauffeur.remainingRestingTimes.previousDailyRest` (object) - `chat.users.chauffeur.remainingDrivingTimes` (object) - `chat.users.chauffeur.remainingDrivingTimes.daysOfReducedRest` (object) - `chat.users.chauffeur.remainingDrivingTimes.dailyAmplitude` (object) - `chat.users.chauffeur.remainingDrivingTimes.drivingTimeBelowMaximum` (object) - `chat.users.chauffeur.remainingDrivingTimes.dailyDrivingTime` (object) - `chat.users.chauffeur.remainingDrivingTimes.daysOfDrivingLongerThan9h` (object) - `chat.users.chauffeur.remainingDrivingTimes.weeklyDrivingTime` (object) - `chat.users.chauffeur.remainingDrivingTimes.BIWeeklyDrivingTime` (object) - `chat.users.chauffeur.remainingDrivingTimes.daysOfConsecutiveDriving` (object) - `chat.users.chauffeur.upcomingRestingTimes` (object) - `chat.users.chauffeur.upcomingRestingTimes.week` (integer) - `chat.users.chauffeur.upcomingRestingTimes.year` (integer) - `chat.users.chauffeur.upcomingRestingTimes.upcomingRestingTime` (integer) The upcoming resting times in seconds - `chat.users.chauffeur.languages` (array) - `chat.users.chauffeur.notes` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.notes.uuid` (string, required) - `chat.users.chauffeur.notes.primaryPlatformId` (string, required) - `chat.users.chauffeur.notes.language` (object) circular reference - `chat.users.chauffeur.notes.author` (object) circular reference - `chat.users.chauffeur.notes.name` (string) - `chat.users.chauffeur.notes.text` (string) - `chat.users.chauffeur.boardComputers` (array) - `chat.users.chauffeur.lastActivity` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.lastActivity.uuid` (string, required) - `chat.users.chauffeur.lastActivity.primaryPlatformId` (string, required) - `chat.users.chauffeur.lastActivity.language` (object) circular reference - `chat.users.chauffeur.lastActivity.type` (string) Enum: "work", "driving", "available", "rest", "vacation" - `chat.users.chauffeur.lastActivity.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `chat.users.chauffeur.lastActivity.chauffeur` (object) circular reference - `chat.users.chauffeur.lastActivity.vehicle` (object) circular reference - `chat.users.chauffeur.lastActivity.transportEquipments` (array) - `chat.users.chauffeur.lastActivity.trip` (object) circular reference - `chat.users.chauffeur.lastActivity.name` (string) - `chat.users.chauffeur.lastActivity.description` (string) - `chat.users.chauffeur.lastActivity.remarks` (string) - `chat.users.chauffeur.lastActivity.kmsStart` (integer) - `chat.users.chauffeur.lastActivity.kmsEnd` (integer) - `chat.users.chauffeur.lastActivity.start` (string) - `chat.users.chauffeur.lastActivity.end` (string) - `chat.users.chauffeur.lastActivity.isFromTacho` (boolean) - `chat.users.chauffeur.contactDetails` (array) - `chat.users.chauffeur.pricingModules` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.pricingModules.uuid` (string, required) - `chat.users.chauffeur.pricingModules.primaryPlatformId` (string, required) - `chat.users.chauffeur.pricingModules.language` (object) circular reference - `chat.users.chauffeur.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" - `chat.users.chauffeur.pricingModules.name` (string) - `chat.users.chauffeur.pricingModules.sequenceNr` (integer) - `chat.users.chauffeur.pricingModules.description` (string) - `chat.users.chauffeur.pricingModules.category` (object) - `chat.users.chauffeur.pricingModules.taxRates` (array) - `chat.users.chauffeur.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. - `chat.users.chauffeur.pricingModules.taxRates.uuid` (string, required) - `chat.users.chauffeur.pricingModules.taxRates.primaryPlatformId` (string, required) - `chat.users.chauffeur.pricingModules.taxRates.language` (object) circular reference - `chat.users.chauffeur.pricingModules.taxRates.sequenceNr` (integer) - `chat.users.chauffeur.pricingModules.taxRates.name` (string) - `chat.users.chauffeur.pricingModules.taxRates.description` (string) - `chat.users.chauffeur.pricingModules.taxRates.taxRate` (object) - `chat.users.chauffeur.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. - `chat.users.chauffeur.pricingModules.taxRates.taxRate.uuid` (string, required) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.primaryPlatformId` (string, required) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.language` (object) circular reference - `chat.users.chauffeur.pricingModules.taxRates.taxRate.name` (string) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.creditCode` (string) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.debitCode` (string) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.description` (string) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.jurisdiction` (string) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.percentage` (number) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.inclusive` (boolean) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.active` (boolean) - `chat.users.chauffeur.pricingModules.taxRates.taxRate.identifiers` (array) - `chat.users.chauffeur.pricingModules.taxRates.filters` (array) - `chat.users.chauffeur.pricingModules.filters` (array) - `chat.users.chauffeur.pricingModules.oncePerInvoice` (boolean) - `chat.users.vehicle` (object) circular reference - `chat.users.permission` (string) Enum: "NONE", "READ", "CHAT", "MODERATOR", "ADMIN" - `chat.users.muted` (boolean) - `chat.users.markedAsUnread` (boolean) If this user has the chat on read yes/no - `chat.users.unreadMessages` (integer) - `chat.users.identifiers` (array) - `chat.messages` (array) - `chat.messages.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. - `chat.messages.uuid` (string, required) - `chat.messages.primaryPlatformId` (string, required) - `chat.messages.language` (object) circular reference - `chat.messages.chat` (object) circular reference - `chat.messages.user` (object) - `chat.messages.message` (string) - `chat.messages.state` (string) Enum: "normal", "important", "pinned", "deleted" - `chat.messages.type` (string) Enum: "normal", "mail_message" - `chat.messages.edited` (boolean) - `chat.messages.files` (array) - `chat.messages.replyTo` (object) circular reference - `chat.messages.responses` (array) - `chat.messages.received` (array) - `chat.messages.received.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. - `chat.messages.received.uuid` (string, required) - `chat.messages.received.primaryPlatformId` (string, required) - `chat.messages.received.language` (object) circular reference - `chat.messages.received.user` (object) - `chat.messages.read` (array) - `chat.messages.read.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. - `chat.messages.read.uuid` (string, required) - `chat.messages.read.primaryPlatformId` (string, required) - `chat.messages.read.language` (object) circular reference - `chat.messages.read.user` (object) - `chat.messages.identifiers` (array) - `chat.messages.mailMessage` (object) - `chat.messages.mailMessage.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. - `chat.messages.mailMessage.uuid` (string, required) - `chat.messages.mailMessage.primaryPlatformId` (string, required) - `chat.messages.mailMessage.language` (object) circular reference - `chat.messages.mailMessage.imap` (object) - `chat.messages.mailMessage.imap.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. - `chat.messages.mailMessage.imap.uuid` (string, required) - `chat.messages.mailMessage.imap.primaryPlatformId` (string, required) - `chat.messages.mailMessage.imap.language` (object) circular reference - `chat.messages.mailMessage.imap.name` (string) - `chat.messages.mailMessage.imap.host` (string) - `chat.messages.mailMessage.imap.port` (string) - `chat.messages.mailMessage.imap.username` (string) - `chat.messages.mailMessage.imap.password` (string) - `chat.messages.mailMessage.imap.enabled` (boolean) - `chat.messages.mailMessage.contentId` (string) - `chat.messages.mailMessage.messageNumber` (integer) - `chat.messages.mailMessage.receivedDate` (string) - `chat.messages.mailMessage.sentDate` (string) - `chat.messages.mailMessage.read` (boolean) - `chat.messages.mailMessage.starred` (boolean) - `chat.messages.mailMessage.subject` (string) - `chat.messages.mailMessage.plainText` (string) - `chat.messages.mailMessage.text` (string) - `chat.messages.mailMessage.sender` (object) - `chat.messages.mailMessage.sender.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. - `chat.messages.mailMessage.sender.uuid` (string, required) - `chat.messages.mailMessage.sender.primaryPlatformId` (string, required) - `chat.messages.mailMessage.sender.language` (object) circular reference - `chat.messages.mailMessage.sender.name` (string) - `chat.messages.mailMessage.sender.email` (string) - `chat.messages.mailMessage.sender.smtp` (object) - `chat.messages.mailMessage.sender.smtp.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. - `chat.messages.mailMessage.sender.smtp.uuid` (string, required) - `chat.messages.mailMessage.sender.smtp.primaryPlatformId` (string, required) - `chat.messages.mailMessage.sender.smtp.language` (object) circular reference - `chat.messages.mailMessage.sender.smtp.name` (string) - `chat.messages.mailMessage.sender.smtp.host` (string) - `chat.messages.mailMessage.sender.smtp.port` (string) - `chat.messages.mailMessage.sender.smtp.username` (string) - `chat.messages.mailMessage.sender.smtp.password` (string) - `chat.messages.mailMessage.sender.smtp.useOAuth` (boolean) - `chat.messages.mailMessage.sender.smtp.tenantId` (string) - `chat.messages.mailMessage.sender.smtp.clientId` (string) - `chat.messages.mailMessage.sender.smtp.clientSecret` (string) - `chat.messages.mailMessage.sender.smtp.oauthScopes` (string) - `chat.messages.mailMessage.sender.imap` (object) - `chat.messages.mailMessage.recipients` (array) - `chat.messages.mailMessage.attachments` (array) - `chat.messages.mailMessage.threadId` (string) - `chat.messages.mailMessage.parentMessageId` (string) - `chat.messages.mailMessage.linkedTransportOrderIds` (array) - `chat.messages.mailMessage.linkedConsignmentIds` (array) - `chat.messages.translatedMessage` (string) - `chat.unreadMessages` (integer) - `chat.maxCharacters` (integer) - `chat.latestMessage` (object) - `chat.identifiers` (array) - `pricingElements` (array) - `identifiers` (array) - `attributes` (array) - `externalAttributes` (object) - `expectedRevenue` (object) - `hasAgreedToPrice` (boolean) Set this value to 'true' if the user has agreed to the pricing of this element. Only needed once the NeedsBillingApproval Exception is thrown - `versionNumber` (integer) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `consignment` (object) ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)