# Get the login method Get the login method to be used for this users authentication Endpoint: POST /user/login-method Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Request fields (application/json): - `username` (string) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `loginMethod` (string) Enum: "DEFAULT", "SAML" - `redirectURL` (string) - `platform` (object) - `platform.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.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. - `platform.createdAt` (string) The date and time this Entity has been created - `platform.updatedAt` (string) The date and time this Entity has been updated - `platform.name` (string) - `platform.nameSpace` (string) - `platform.logo` (object) - `platform.logo.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.logo.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. - `platform.logo.createdAt` (string) The date and time this Entity has been created - `platform.logo.updatedAt` (string) The date and time this Entity has been updated - `platform.logo.url` (string) - `platform.logo.path` (string) - `platform.logo.name` (string) - `platform.logo.originalName` (string) - `platform.logo.size` (integer) - `platform.logo.purpose` (string) - `platform.logo.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `platform.logo.mimeType` (string) - `platform.logo.extension` (string) - `platform.logo.identifiers` (array) - `platform.logo.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.logo.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. - `platform.logo.identifiers.createdAt` (string) The date and time this Entity has been created - `platform.logo.identifiers.updatedAt` (string) The date and time this Entity has been updated - `platform.logo.identifiers.name` (string) - `platform.logo.identifiers.system` (string) - `platform.logo.identifiers.value` (string) - `platform.logo.identifiers.expiredAt` (string) - `platform.logo.bucket` (object) - `platform.logo.bucket.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.logo.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. - `platform.logo.bucket.createdAt` (string) The date and time this Entity has been created - `platform.logo.bucket.updatedAt` (string) The date and time this Entity has been updated - `platform.logo.bucket.name` (string) - `platform.logo.uploadedAt` (string) - `platform.logo.tempFile` (string) - `platform.favicon` (object) - `platform.notificationLogo` (object) - `platform.fullLogo` (object) - `platform.backgroundImage` (object) - `platform.darkLogo` (object) - `platform.darkFavicon` (object) - `platform.darkNotificationLogo` (object) - `platform.darkFullLogo` (object) - `platform.darkBackgroundImage` (object) - `platform.primaryColor` (string) - `platform.secondaryColor` (string) - `platform.darkPrimaryColor` (string) - `platform.darkSecondaryColor` (string) - `platform.hostNames` (array) - `platform.hostNames.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.hostNames.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. - `platform.hostNames.createdAt` (string) The date and time this Entity has been created - `platform.hostNames.updatedAt` (string) The date and time this Entity has been updated - `platform.hostNames.hostName` (string) - `platform.features` (array) - `platform.features.name` (string) - `platform.features.accountTypes` (array) Enum: "default", "customer", "supplier", "planning", "financial" - `platform.allowedEmailDomains` (array) - `platform.emailIntegration` (object) - `platform.emailIntegration.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.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. - `platform.emailIntegration.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.type` (string) Enum: "manual", "configured", "messageAutomation", "fileTemplate", "apiAccess" - `platform.emailIntegration.name` (string) - `platform.emailIntegration.description` (string) - `platform.emailIntegration.schedule` (object) - `platform.emailIntegration.schedule.integrationSchedulerScheduleValue` (integer) - `platform.emailIntegration.schedule.integrationSchedulerScheduleType` (string) Enum: "seconds", "minutes", "hours", "days", "months" - `platform.emailIntegration.schedule.milliseconds` (integer) - `platform.emailIntegration.dataSources` (array) - `platform.emailIntegration.dataSources.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.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. - `platform.emailIntegration.dataSources.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.dataSources.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.dataSources.directionType` (string) Enum: "in", "out" - `platform.emailIntegration.dataSources.connectionType` (string) Enum: "api", "ftp", "sftp", "sql", "web_hook", "email", "virtual_ftp" - `platform.emailIntegration.dataSources.requestMethod` (string) Enum: "get", "post", "put", "patch", "delete" - `platform.emailIntegration.dataSources.dataType` (string) Enum: "xml", "json", "csv", "empty" - `platform.emailIntegration.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" - `platform.emailIntegration.dataSources.url` (string) - `platform.emailIntegration.dataSources.port` (integer) - `platform.emailIntegration.dataSources.path` (string) - `platform.emailIntegration.dataSources.token` (string) - `platform.emailIntegration.dataSources.query` (string) - `platform.emailIntegration.dataSources.parameters` (array) - `platform.emailIntegration.dataSources.parameters.sequenceNr` (integer) - `platform.emailIntegration.dataSources.parameters.type` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `platform.emailIntegration.dataSources.parameters.regex` (string) - `platform.emailIntegration.dataSources.parameters.format` (string) - `platform.emailIntegration.dataSources.parameters.locale` (string) - `platform.emailIntegration.dataSources.parameters.zoneId` (string) - `platform.emailIntegration.dataSources.parameters.incomingPath` (string) - `platform.emailIntegration.dataSources.parameters.outgoingPath` (string) - `platform.emailIntegration.dataSources.parameters.insertRegexSelector` (string) - `platform.emailIntegration.dataSources.parameters.insertType` (string) Enum: "before", "replace", "after" - `platform.emailIntegration.dataSources.parameters.insertValue` (string) - `platform.emailIntegration.dataSources.parameters.defaultValue` (string) - `platform.emailIntegration.dataSources.parameters.fields` (array) - `platform.emailIntegration.dataSources.parameters.filters` (array) - `platform.emailIntegration.dataSources.parameters.filters.selector` (string) - `platform.emailIntegration.dataSources.parameters.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" - `platform.emailIntegration.dataSources.parameters.filters.value` (string) - `platform.emailIntegration.dataSources.parameters.filters.linkType` (string) Enum: "and", "or" - `platform.emailIntegration.dataSources.parameters.filters.filters` (array) - `platform.emailIntegration.dataSources.parameters.filters.sequenceNr` (integer) - `platform.emailIntegration.dataSources.parameters.filters.valueSelector` (string) - `platform.emailIntegration.dataSources.parameters.options` (array) Enum: "identifier", "to_lower_case", "to_upper_case", "capitalize", "trim", "remove_all_whitespace", "filters" - `platform.emailIntegration.dataSources.allowedIps` (array) - `platform.emailIntegration.dataSources.hasAuthentication` (boolean) - `platform.emailIntegration.dataSources.credentials` (object) - `platform.emailIntegration.dataSources.credentials.authenticationMethod` (string) Enum: "apiKey", "accessKeys", "basic", "OAuth", "bearer", "openId", "clientKeysOpenId", "clientKeys", "headers" - `platform.emailIntegration.dataSources.credentials.username` (string) - `platform.emailIntegration.dataSources.credentials.password` (string) - `platform.emailIntegration.dataSources.credentials.accessKey` (string) - `platform.emailIntegration.dataSources.credentials.secretKey` (string) - `platform.emailIntegration.dataSources.credentials.clientId` (string) - `platform.emailIntegration.dataSources.credentials.clientSecret` (string) - `platform.emailIntegration.dataSources.credentials.grantType` (string) - `platform.emailIntegration.dataSources.credentials.scope` (string) - `platform.emailIntegration.dataSources.credentials.apiKey` (string) - `platform.emailIntegration.dataSources.credentials.bearer` (string) - `platform.emailIntegration.dataSources.credentials.sshKey` (object) - `platform.emailIntegration.dataSources.credentials.sshTunnel` (boolean) - `platform.emailIntegration.dataSources.credentials.sshHost` (string) - `platform.emailIntegration.dataSources.credentials.sshUsername` (string) - `platform.emailIntegration.dataSources.credentials.sshPassword` (string) - `platform.emailIntegration.dataSources.credentials.externalAttributes` (object) - `platform.emailIntegration.dataSources.credentials.headers` (object) - `platform.emailIntegration.dataSources.credentials.oauthUrl` (string) - `platform.emailIntegration.dataSources.credentials.oAuthCache` (string) - `platform.emailIntegration.dataSources.credentials.oAuthCacheCreationDate` (string) - `platform.emailIntegration.dataSources.credentials.openIdToken` (string) - `platform.emailIntegration.dataSources.credentials.openIdRefreshToken` (string) - `platform.emailIntegration.dataSources.credentials.openIdAccessToken` (string) - `platform.emailIntegration.dataSources.credentials.openIdExpiration` (string) - `platform.emailIntegration.dataSources.otm` (boolean) - `platform.emailIntegration.dataSources.fields` (array) - `platform.emailIntegration.dataSources.filters` (array) - `platform.emailIntegration.dataSources.template` (boolean) - `platform.emailIntegration.enabled` (boolean) - `platform.emailIntegration.lastHandled` (string) - `platform.emailIntegration.sectorType` (string) Enum: "boardComputer", "transportOrder", "terminal", "mail", "camera", "sending_data", "administration", "communication_channel", "CRM", "calendar", "ferry", "freight_exchange" - `platform.emailIntegration.manualType` (string) Enum: "transics", "web_fleet", "squarell", "evogps", "trimble", "portbase", "psa", "dpworld", "uturn", "imap", "smtp", "exchange", "samskip", "containership", "project44", "searates", "telenormic", "cbs", "afas", "twinfield", "exact", "moneybird", "telegram", "whatsapp", "timocom", "trans_eu", "teleroute", "freightos", "dat", "sennder", "hubspot", "bigmile", "iveco", "volvo", "champ", "opensky", "fleets_online", "fleet_access", "stripe", "mollie", "adyen", "dfds", "stena_line", "po_ferries", "cldn", "google_calendar", "microsoft_calendar", "apple_calendar", "avantida" - `platform.emailIntegration.enabledFunctions` (array) - `platform.emailIntegration.url` (string) - `platform.emailIntegration.port` (integer) - `platform.emailIntegration.credentials` (object) - `platform.emailIntegration.filters` (array) - `platform.emailIntegration.integration` (array) - `platform.emailIntegration.integration.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.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. - `platform.emailIntegration.integration.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author` (object) - `platform.emailIntegration.integration.author.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.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. - `platform.emailIntegration.integration.author.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.hasAgreedToPrice` (boolean) - `platform.emailIntegration.integration.author.type` (string) Enum: "user", "developer", "chauffeur" - `platform.emailIntegration.integration.author.username` (string, required) - `platform.emailIntegration.integration.author.avatar` (object) - `platform.emailIntegration.integration.author.firstName` (string) - `platform.emailIntegration.integration.author.lastName` (string) - `platform.emailIntegration.integration.author.email` (string, required) - `platform.emailIntegration.integration.author.phone` (string) - `platform.emailIntegration.integration.author.password` (string) - `platform.emailIntegration.integration.author.passwordModified` (string) - `platform.emailIntegration.integration.author.twoFactorAuthentication` (boolean) - `platform.emailIntegration.integration.author.totdSecret` (string) - `platform.emailIntegration.integration.author.recoveryCodes` (array) - `platform.emailIntegration.integration.author.status` (string) Enum: "DELETED", "DEFAULT", "CONFIRMED", "REGISTERED" - `platform.emailIntegration.integration.author.loginMethod` (string) Enum: "DEFAULT", "SAML" - `platform.emailIntegration.integration.author.role` (object) - `platform.emailIntegration.integration.author.role.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.role.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. - `platform.emailIntegration.integration.author.role.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.role.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.role.name` (string) - `platform.emailIntegration.integration.author.role.level` (integer) - `platform.emailIntegration.integration.author.role.permissions` (array) - `platform.emailIntegration.integration.author.role.permissions.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.role.permissions.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. - `platform.emailIntegration.integration.author.role.permissions.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.role.permissions.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.role.permissions.name` (string) - `platform.emailIntegration.integration.author.role.permissions.read` (boolean) - `platform.emailIntegration.integration.author.role.permissions.write` (boolean) - `platform.emailIntegration.integration.author.role.permissions.delete` (boolean) - `platform.emailIntegration.integration.author.role.permissions.permissionScope` (string) Enum: "PUBLIC", "PRIVATE", "OWNER" - `platform.emailIntegration.integration.author.role.permissions.isObjectPermission` (boolean) - `platform.emailIntegration.integration.author.role.specifiedPlatformId` (string) - `platform.emailIntegration.integration.author.currency` (object) - `platform.emailIntegration.integration.author.currency.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.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. - `platform.emailIntegration.integration.author.currency.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.currency.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.currency.name` (string) - `platform.emailIntegration.integration.author.currency.short` (string) - `platform.emailIntegration.integration.author.currency.sign` (string) - `platform.emailIntegration.integration.author.currency.decimalDelimiter` (string) - `platform.emailIntegration.integration.author.currency.thousandDelimiter` (string) - `platform.emailIntegration.integration.author.currency.enabled` (boolean) - `platform.emailIntegration.integration.author.activeAdministration` (object) - `platform.emailIntegration.integration.author.activeAdministration.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.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. - `platform.emailIntegration.integration.author.activeAdministration.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.primary` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.name` (string) The name of the business - `platform.emailIntegration.integration.author.activeAdministration.business.relationType` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.alias` (string) The alias name of the business - `platform.emailIntegration.integration.author.activeAdministration.business.description` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.transportLicenseNumber` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.eori` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.scacCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.industry` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.industry.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.industry.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. - `platform.emailIntegration.integration.author.activeAdministration.business.industry.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.industry.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.industry.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.industry.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.industry.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.industry.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.industry.abbreviated` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.industry.enabled` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.website` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.coc` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.vat` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.invoiceAttentionTo` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.invoiceEmail` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.quoteAttentionTo` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.quoteEmail` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.verified` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.documents` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.documents.associationType` (string) Enum: "inline", "reference" - `platform.emailIntegration.integration.author.activeAdministration.business.logo` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.banners` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.banners.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. - `platform.emailIntegration.integration.author.activeAdministration.business.banners.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.banners.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.banners.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.banners.url` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.path` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.originalName` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.size` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.purpose` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `platform.emailIntegration.integration.author.activeAdministration.business.banners.mimeType` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.extension` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.banners.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. - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.system` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.value` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.identifiers.expiredAt` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.banners.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. - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.banners.bucket.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.uploadedAt` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.tempFile` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.banners.contentMatrix` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.type` (string) Enum: "warehouse", "store", "environmentalZone", "restrictedArea", "customer", "parkingSpot", "loadingUnloadingArea", "operationalBase", "fuelStation" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.unCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.geoReference.type` (string) Enum: "addressGeoReference", "zoneGeoReference", "tmcArrayGeoReference", "tmcLocationGeoReference", "openLRGeoReference", "GeoReference", "Feature", "latLonArrayGeoReference", "latLonPointGeoReference" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference.street` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference.houseNumber` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference.houseNumberAddition` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference.postalCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference.city` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.administrativeReference.country` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.type` (string) Enum: "iban", "gln", "vatCode", "name", "lastName", "middleName", "firstName", "phone", "mobilePhone", "email", "language", "other" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.value` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.contactDetails.remarks` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.monday` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.monday.start` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.monday.end` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.monday.open` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.monday.day` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.monday.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.monday.description` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.tuesday` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.wednesday` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.thursday` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.friday` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.saturday` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.openingTimes.sunday` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.name` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.integrationType` (string) Enum: "portbase", "psa", "dpworld" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.ean` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.bicsCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.quayName` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.smdgCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.locations` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.allowedModalities` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.loading` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.full` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.modality` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.sealNumberAllowed` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.reeferAllowed` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.grossWeightAllowed` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.outOfGaugeAllowed` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.dangerousGoodsAllowed` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.terminalSettings.cargoCutOffInMinutes` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.tarRequired` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.terminal.roadLicenseIdRequired` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.type` (string) Enum: "load", "unload", "handOver", "stop", "move", "attachTransportEquipment", "detachTransportEquipment", "attachChauffeur", "detachChauffeur", "genericAction", "wait", "break", "refuel", "customs", "weighing", "typeTakeAndReturn", "booking" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.groupId` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.name` (string, required) The name of the action - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.externalAttributes` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.status` (string) Enum: "succeeded", "failed", "partiallySucceeded", "cancelled" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.remark` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.reason` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.results` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.answers` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.attachments` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.attachments.questionId` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.attachments.type` (string) Enum: "photo", "signature", "document" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.attachments.documentId` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.result.attachments.dataUrl` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.remark` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.sequenceNr` (integer) The number in which order the Action occurs - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.tripSequenceNr` (integer) The number in which order the Action occurs within the trip - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.location` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.location.associationType` (string) Enum: "inline", "reference" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.startTime` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.endTime` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.eta` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.etd` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.timeFormat` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.recurrence` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.duration` (integer) The actual duration of the action in minutes - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.estimatedDuration` (integer) The estimated duration of the action in minutes - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.inTripOnly` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.actions` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.actions.associationType` (string) Enum: "inline", "reference" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.description` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.status` (string) Enum: "pending", "processing", "success", "failure" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.responseMessage` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.communicationRequests.responseValue` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.documents` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.documents.associationType` (string) Enum: "inline", "reference" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.type` (string) Enum: "generalEvent", "sensorUpdateEvent", "gateInEvent", "gateOutEvent", "arrivalEvent", "departureEvent", "stopEngineEvent", "startEngineEvent", "startWaitingEvent", "stopWaitingEvent", "stopMovingEvent", "startMovingEvent", "locationUpdateEvent", "updateEvent", "associationRemovedEvent", "associationCreatedEvent", "capacityChangeEvent" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.externalAttributes` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.contextEvents.dateTime` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.attributes.color` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.versionNumber` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.constraints` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.actions.constraints.associationType` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.type` (string) Enum: "accessConstraint", "timeConstraint", "timeWindowsConstraint", "startDateTimeConstraint", "endDateTimeConstraint", "sizeConstraint", "weightConstraint", "speedConstraint", "sensorValueConstraint", "fuelTypeConstraint", "vehicleTypeConstraint", "emissionStandardConstraint", "attributeConstraint", "transportEquipmentTypeConstraint", "routeConstraint", "andConstraint", "orConstraint", "notConstraint", "genericConstraint" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.constraints.enforceability` (string) Enum: "enforced", "preference" - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.sequenceNr` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.quantity` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.description` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.creditCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.debitCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.defaultValue` (number) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.enabled` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.category.tripRevenue` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.business` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.amount` (number) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.short` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.sign` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.decimalDelimiter` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.thousandDelimiter` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.currency.enabled` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.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. - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.creditCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.debitCode` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.description` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.jurisdiction` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.percentage` (number) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.inclusive` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.taxRate.active` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.amount.inclusiveOfTax` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.subTotal` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.tax` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.pricingElements.total` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.remark` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.hash` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.externalAttributes` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.locations.dataIsComplete` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.identification` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.contactDetails` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.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. - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.firstName` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.lastName` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.position` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.email` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.phone` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.contactPersons.mobilePhone` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.notes` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.notes.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.notes.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.notes.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.notes.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.notes.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.notes.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.notes.author` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.notes.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.notes.text` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.partOf` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.administration.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.administration.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.administration.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.administration.platforms` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.primary` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.transportOrderPrefix` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.consignmentPrefix` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.business` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.administration.currency` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.balance` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.accountHolderName` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.accountHolderType` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.bankName` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.routingNumber` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.accountNumber` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.last4` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.currency` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.country` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.validation` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.validated` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.bankAccounts.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.numberFormat` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.numberLength` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.dueDays` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceNumberIndex` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.quoteNumberIndex` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.uuid` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.primaryPlatformId` (string, required) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.language` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.type` (string) Enum: "messageAutomation", "questionAnswerAutomation", "fileRequestAutomation" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.name` (string, required) The name of a messageAutomation - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.description` (string, required) The description of a messageAutomation - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.triggerType` (string) Enum: "trigger", "scheduler", "listener" - `platform.emailIntegration.integration.author.activeAdministration.business.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" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.schedule` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSelector` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSchedule` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.filters` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.fields` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.fields.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.fields.groupByAggregate` (string) Enum: "count", "max", "min", "sum", "avg" - `platform.emailIntegration.integration.author.activeAdministration.business.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" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.joins` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.joins.type` (string) Enum: "inner_join" - `platform.emailIntegration.integration.author.activeAdministration.business.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" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onLeft` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onRight` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.sequenceNr` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.field` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.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" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.value` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.valueType` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.linkType` (string) Enum: "and", "or" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.groupBy` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.having` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.sortFields` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.sortDirection` (string) Enum: "asc", "desc" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.limit` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.query.offset` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.recipients` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.recipientSelector` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.toggleForAll` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.channel` (string) Enum: "email", "chat", "notification", "whatsapp", "telegram" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.manualIntegration` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.includeAttachments` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentSourceType` (string) Enum: "ENTITY_PDF", "CUSTOM_TEMPLATE", "INSIGHT_REPORT", "STATIC_FILE" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentType` (string) Enum: "cmr", "waybill", "invoice", "quote", "transportOrder", "trip", "custom" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentTemplateId` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileUrl` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.insightType` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.reportParameters` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.entityIdSelector` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileNameTemplate` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.subject` (string) The subject of a message for a particular messageAutomation - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.currentTriggerPosition` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.business.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. - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.localName` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.code` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.iso3166` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.decimalDelimiter` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.thousandDelimiter` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.dateFormat` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.measurementUnit` (string) Enum: "metric", "imperial" - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.content` (string, required) The template of a message for a particular messageAutomation - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.messageTemplate` (string, required) The template of a message for a particular messageAutomation - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.subject` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.defaultLanguageId` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.languageSelector` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.userEnableable` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.automationConfig.userPermissionFilters` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.messageAutomationIntegration` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.enabled` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.lastHandled` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.template` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSendMessageAutomation.templateCategory` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.automaticallySendReminders` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceFirstReminderMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceSecondReminderMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceThirdReminderMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoicePaidMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.quoteSendMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceTermsAndConditions` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceTermsAndConditions.language` (object) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.invoiceTermsAndConditions.text` (string) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.quoteTermsAndConditions` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.transportOrderTermsAndConditions` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.administration.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.business.dataIsComplete` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.business.pricingConfigurationCount` (integer) - `platform.emailIntegration.integration.author.activeAdministration.business.hasAgreedToPrice` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.currency` (object) - `platform.emailIntegration.integration.author.activeAdministration.balance` (object) - `platform.emailIntegration.integration.author.activeAdministration.balance.amount` (number) - `platform.emailIntegration.integration.author.activeAdministration.balance.currency` (object) - `platform.emailIntegration.integration.author.activeAdministration.balance.taxRate` (object) - `platform.emailIntegration.integration.author.activeAdministration.balance.inclusiveOfTax` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts` (array) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.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. - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.routingNumber` (string) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.accountNumber` (string) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.last4` (string) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.currency` (object) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.country` (string) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validation` (object) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validation.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validation.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. - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validation.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validation.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validation.firstValue` (number) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validation.secondValue` (number) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.validated` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.accountHolderName` (string) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.accountHolderType` (string) - `platform.emailIntegration.integration.author.activeAdministration.bankAccounts.bankName` (string) - `platform.emailIntegration.integration.author.activeAdministration.numberFormat` (string) - `platform.emailIntegration.integration.author.activeAdministration.numberLength` (integer) - `platform.emailIntegration.integration.author.activeAdministration.dueDays` (integer) - `platform.emailIntegration.integration.author.activeAdministration.invoiceNumberIndex` (object) - `platform.emailIntegration.integration.author.activeAdministration.quoteNumberIndex` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.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. - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.name` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.description` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.automationConfig` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.messageAutomationIntegration` (object) circular reference - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.enabled` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.lastHandled` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.template` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.templateCategory` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.type` (string) Enum: "messageAutomation", "questionAnswerAutomation", "fileRequestAutomation" - `platform.emailIntegration.integration.author.activeAdministration.invoiceSendMessageAutomation.notes` (array) - `platform.emailIntegration.integration.author.activeAdministration.automaticallySendReminders` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.invoiceFirstReminderMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceSecondReminderMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceThirdReminderMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoicePaidMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.quoteSendMessageAutomation` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceTermsAndConditions` (array) - `platform.emailIntegration.integration.author.activeAdministration.quoteTermsAndConditions` (array) - `platform.emailIntegration.integration.author.activeAdministration.transportOrderTermsAndConditions` (array) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments` (array) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.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. - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.description` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.expiresAt` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.fileName` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.mimeType` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.encoding` (string) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.verified` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.isPublic` (boolean) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.owner` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.content` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.content.id` (string) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.content.contentType` (string) Enum: "data", "uri" - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.file` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.externalAttributes` (object) - `platform.emailIntegration.integration.author.activeAdministration.invoiceStandardDocuments.name` (string, required) The name of the document - `platform.emailIntegration.integration.author.activeAdministration.quoteStandardDocuments` (array) - `platform.emailIntegration.integration.author.activeAdministration.identifiers` (array) - `platform.emailIntegration.integration.author.activeAdministration.transportOrderPrefix` (string) - `platform.emailIntegration.integration.author.activeAdministration.consignmentPrefix` (string) - `platform.emailIntegration.integration.author.identifiers` (array) - `platform.emailIntegration.integration.author.accountType` (string) Enum: "default", "customer", "supplier", "planning", "financial" - `platform.emailIntegration.integration.author.standardLoadingSize` (integer) - `platform.emailIntegration.integration.author.notes` (array) - `platform.emailIntegration.integration.author.businesses` (array) - `platform.emailIntegration.integration.author.features` (array) - `platform.emailIntegration.integration.author.timezone` (string) - `platform.emailIntegration.integration.author.vehicleGroups` (array) - `platform.emailIntegration.integration.author.vehicleGroups.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.emailIntegration.integration.author.vehicleGroups.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. - `platform.emailIntegration.integration.author.vehicleGroups.createdAt` (string) The date and time this Entity has been created - `platform.emailIntegration.integration.author.vehicleGroups.updatedAt` (string) The date and time this Entity has been updated - `platform.emailIntegration.integration.author.vehicleGroups.name` (string) - `platform.emailIntegration.integration.author.vehicleGroups.vehicles` (array) - `platform.emailIntegration.integration.name` (string) - `platform.emailIntegration.integration.text` (string) - `platform.planningSettings` (object) - `platform.planningSettings.defaultDeliveryTerms` (string) Enum: "EXW", "FCA", "FAS", "FOB", "CPT", "CIP", "CFR", "CIF", "DAP", "DPU", "DDP" - `platform.planningSettings.optimizerEngine` (string) The optimizer engine to use for trip optimization. Defaults to PTV. Enum: "transportial", "ptv", "osrm", "cloveropt" - `platform.planningSettings.alwaysCombinedTransport` (boolean) - `platform.planningSettings.finishTripOnActionsComplete` (boolean) - `platform.planningSettings.requirePlannerCompletionForTrips` (boolean) When enabled, finishing a trip sets it to PENDING_COMPLETION instead of COMPLETED. Planners must explicitly complete the trip. - `platform.planningSettings.showEventsOnActionCards` (boolean) - `platform.planningSettings.goodsWeightsAndLoadMetersAreTotalFields` (boolean) Flag indicating Non-Dimensional Metrics Fields of Goods like 'Weight', 'LoadMeters', etc. contains Cumulative/Total information of all instances (quantity) or not. - `platform.planningSettings.optimizerAlgorithmConfiguration` (object) - `platform.planningSettings.optimizerAlgorithmConfiguration.defaultVehicleOperatingIntervals` (array) - `platform.planningSettings.optimizerAlgorithmConfiguration.defaultVehicleOperatingIntervals.start` (integer) - `platform.planningSettings.optimizerAlgorithmConfiguration.defaultVehicleOperatingIntervals.end` (integer) - `platform.planningSettings.optimizerAlgorithmConfiguration.maxDrivingPeriod` (integer) - `platform.planningSettings.optimizerAlgorithmConfiguration.maxPeriod` (integer) - `platform.planningSettings.optimizerAlgorithmConfiguration.ignoreLocationConstraints` (boolean) - `platform.planningSettings.optimizerAlgorithmConfiguration.ignoreConsignmentConstraints` (boolean) - `platform.planningSettings.optimizerAlgorithmConfiguration.ignoreActionConstraints` (boolean) - `platform.planningSettings.loadActionDefaultDuration` (integer) Default action duration in seconds if not yet enough data is available - `platform.planningSettings.unloadActionDefaultDuration` (integer) Default action duration in seconds if not yet enough data is available - `platform.planningSettings.stopActionDefaultDuration` (integer) Default action duration in seconds if not yet enough data is available - `platform.planningSettings.attachTransportEquipmentActionDefaultDuration` (integer) Default action duration in seconds if not yet enough data is available - `platform.planningSettings.detachTransportEquipmentActionDefaultDuration` (integer) Default action duration in seconds if not yet enough data is available - `platform.planningSettings.groupedStopActionDurationSeconds` (integer) Duration in seconds for subsequent StopActions within the same group - `platform.planningSettings.defaultTransportOrderTemplate` (string) - `platform.planningSettings.consignmentAttributeCheckmarks` (array) - `platform.planningSettings.consignmentAttributeCheckmarks.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.planningSettings.consignmentAttributeCheckmarks.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. - `platform.planningSettings.consignmentAttributeCheckmarks.createdAt` (string) The date and time this Entity has been created - `platform.planningSettings.consignmentAttributeCheckmarks.updatedAt` (string) The date and time this Entity has been updated - `platform.planningSettings.consignmentAttributeCheckmarks.name` (string) - `platform.planningSettings.consignmentAttributeCheckmarks.color` (string) - `platform.planningSettings.defaultTripStartDuration` (integer) - `platform.planningSettings.defaultTripStartDateFromNextActionTimeWindow` (boolean) - `platform.planningSettings.defaultTollCostPricingCategory` (object) - `platform.planningSettings.defaultTollCostPricingCategory.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.planningSettings.defaultTollCostPricingCategory.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. - `platform.planningSettings.defaultTollCostPricingCategory.createdAt` (string) The date and time this Entity has been created - `platform.planningSettings.defaultTollCostPricingCategory.updatedAt` (string) The date and time this Entity has been updated - `platform.planningSettings.defaultTollCostPricingCategory.name` (string) - `platform.planningSettings.defaultTollCostPricingCategory.creditCode` (string) - `platform.planningSettings.defaultTollCostPricingCategory.debitCode` (string) - `platform.planningSettings.defaultTollCostPricingCategory.defaultValue` (number) - `platform.planningSettings.defaultTollCostPricingCategory.enabled` (boolean) - `platform.planningSettings.defaultTollCostPricingCategory.tripRevenue` (boolean) - `platform.planningSettings.defaultTollCostPricingCategory.identifiers` (array) - `platform.planningSettings.mapUris` (array) - `platform.planningSettings.mapUris.name` (string) - `platform.planningSettings.mapUris.previewUrl` (string) - `platform.planningSettings.mapUris.url` (string) - `platform.planningSettings.preferredTransportModes` (array) List of transport modes preferred by the platform for trip planning. Enum: "maritime", "road", "rail", "air", "inlandWaterway" - `platform.planningSettings.onlyCalculateRouteOnTripConfirmed` (boolean) When enabled, only calculates detailed road routes when trip status is CONFIRMED. Before confirmation, uses direct line (as-the-crow-flies) routing for better performance. - `platform.planningSettings.onlyCalculateCapacityOnTripConfirmed` (boolean) When enabled, only calculates capacity change events when trip status is CONFIRMED. Improves performance for draft and planning stages. - `platform.planningSettings.onlyCalculateFinanceOnTripConfirmed` (boolean) When enabled, only processes trip financials (pricing, costs) when trip status is CONFIRMED. Improves performance for draft and planning stages. - `platform.planningSettings.actionResultQuestionnaires` (object) Configurable questionnaires for action results, keyed by action type. Enables dynamic question-answer flows that can set result status and modify action/consignment fields. - `platform.planningSettings.sortActionsOnConsignmentDrop` (boolean) When enabled, actions are automatically sorted in a logical geographic order (nearest-neighbour, as the crow flies) when a consignment is drag-and-dropped onto an existing trip or vehicle. - `platform.planningSettings.includeQuoteLinesOnTransportOrderPdf` (boolean) When enabled, the transport order PDF includes the associated quote lines (pricing) when a quote exists for the order. - `platform.pricingSettings` (object) - `platform.pricingSettings.defaultChauffeurCostPricing` (array) - `platform.pricingSettings.defaultChauffeurCostPricing.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.pricingSettings.defaultChauffeurCostPricing.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. - `platform.pricingSettings.defaultChauffeurCostPricing.createdAt` (string) The date and time this Entity has been created - `platform.pricingSettings.defaultChauffeurCostPricing.updatedAt` (string) The date and time this Entity has been updated - `platform.pricingSettings.defaultChauffeurCostPricing.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" - `platform.pricingSettings.defaultChauffeurCostPricing.name` (string) - `platform.pricingSettings.defaultChauffeurCostPricing.sequenceNr` (integer) - `platform.pricingSettings.defaultChauffeurCostPricing.description` (string) - `platform.pricingSettings.defaultChauffeurCostPricing.category` (object) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates` (array) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.pricingSettings.defaultChauffeurCostPricing.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. - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.createdAt` (string) The date and time this Entity has been created - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.updatedAt` (string) The date and time this Entity has been updated - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.sequenceNr` (integer) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.name` (string) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.description` (string) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.taxRate` (object) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.filters` (array) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.filters.selector` (string) - `platform.pricingSettings.defaultChauffeurCostPricing.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" - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.filters.value` (string) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.filters.linkType` (string) Enum: "and", "or" - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.filters.filters` (array) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.filters.sequenceNr` (integer) - `platform.pricingSettings.defaultChauffeurCostPricing.taxRates.filters.valueSelector` (string) - `platform.pricingSettings.defaultChauffeurCostPricing.filters` (array) - `platform.pricingSettings.defaultChauffeurCostPricing.oncePerInvoice` (boolean) - `platform.pricingSettings.defaultVehicleCostPricing` (array) - `platform.credentialSettings` (object) - `platform.credentialSettings.force2FA` (boolean) - `platform.credentialSettings.stripeKey` (string) - `platform.credentialSettings.stripePublicKey` (string) - `platform.credentialSettings.ptvKey` (string) - `platform.credentialSettings.ptvSecret` (string) - `platform.credentialSettings.awsKey` (string) - `platform.credentialSettings.awsSecret` (string) - `platform.credentialSettings.googleApiKey` (string) - `platform.credentialSettings.googleApiSecret` (string) - `platform.credentialSettings.hereApiKey` (string) - `platform.credentialSettings.osrmUrl` (string) - `platform.credentialSettings.cloverOptApiKey` (string) - `platform.credentialSettings.googleCaptchaKey` (string) - `platform.credentialSettings.googleCaptchaSecret` (string) - `platform.routingSettings` (object) - `platform.routingSettings.routingEngine` (string) Enum: "transportial", "ptv", "here", "google", "osrm" - `platform.routingSettings.seaPassages` (object) - `platform.routingSettings.seaPassages.allowSuez` (boolean) - `platform.routingSettings.seaPassages.allowPanama` (boolean) - `platform.routingSettings.seaPassages.allowMalacca` (boolean) - `platform.routingSettings.seaPassages.allowGibraltar` (boolean) - `platform.routingSettings.seaPassages.allowDover` (boolean) - `platform.routingSettings.seaPassages.allowBering` (boolean) - `platform.routingSettings.seaPassages.allowMagellan` (boolean) - `platform.routingSettings.seaPassages.allowBabelmandeb` (boolean) - `platform.routingSettings.seaPassages.allowKiel` (boolean) - `platform.routingSettings.seaPassages.allowCorinth` (boolean) - `platform.routingSettings.seaPassages.allowNorthwest` (boolean) - `platform.routingSettings.seaPassages.allowNortheast` (boolean) - `platform.translationSettings` (object) - `platform.translationSettings.languagesLabels` (array) - `platform.translationSettings.languagesLabels.language` (string) - `platform.translationSettings.languagesLabels.labels` (string) - `platform.uiSettings` (object) - `platform.uiSettings.hiddenFields` (array) - `platform.uiSettings.requiredFields` (array) - `platform.uiSettings.validationRules` (array) - `platform.uiSettings.requireVerifiedBusinesses` (boolean) - `platform.uiSettings.userSettableMessageAutomations` (array) - `platform.alertsSettings` (object) - `platform.alertsSettings.enableCapacityAlerts` (boolean) Enable or disable capacity availability warnings for trips. Defaults to true. - `platform.alertsSettings.enableDocumentsNeededAlerts` (boolean) Enable or disable warnings for completed trip actions missing documents. Defaults to true. - `platform.alertsSettings.enableVehicleConflictAlerts` (boolean) Enable or disable warnings for vehicle conflicts (double booking). Defaults to true. - `platform.alertsSettings.enableTransportEquipmentConflictAlerts` (boolean) Enable or disable warnings for transport equipment conflicts (double booking). Defaults to true. - `platform.alertsSettings.enableChauffeurConflictAlerts` (boolean) Enable or disable warnings for chauffeur conflicts (double booking). Defaults to true. - `platform.financialSettings` (object) - `platform.financialSettings.defaultTaxRate` (object) - `platform.financialSettings.enableInvoiceApprovalFlow` (boolean) - `platform.aiSettings` (object) - `platform.aiSettings.aiProvider` (string) Enum: "OPENAI", "GEMINI", "CLAUDE" - `platform.customerPortalSettings` (object) - `platform.customerPortalSettings.portalEnabled` (boolean) - `platform.customerPortalSettings.portalShowOrders` (boolean) - `platform.customerPortalSettings.portalShowQuotes` (boolean) - `platform.customerPortalSettings.portalShowInvoices` (boolean) - `platform.customerPortalSettings.portalShowDocuments` (boolean) - `platform.customerPortalSettings.portalShowLiveTracking` (boolean) - `platform.customerPortalSettings.portalShowNotifications` (boolean) - `platform.customerPortalSettings.portalShowOrderRequest` (boolean) - `platform.customerPortalSettings.portalShowSettings` (boolean) - `platform.onboardingState` (object) - `platform.canRegister` (boolean) - `platform.canRequestAccess` (boolean) - `platform.description` (string) - `platform.contactEmail` (string) - `platform.business` (object) - `platform.childOf` (object) circular reference - `platform.billing` (object) - `platform.billing.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.billing.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. - `platform.billing.createdAt` (string) The date and time this Entity has been created - `platform.billing.updatedAt` (string) The date and time this Entity has been updated - `platform.billing.plan` (object) - `platform.billing.plan.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.billing.plan.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. - `platform.billing.plan.createdAt` (string) The date and time this Entity has been created - `platform.billing.plan.updatedAt` (string) The date and time this Entity has been updated - `platform.billing.plan.amount` (object) - `platform.billing.plan.usageElementTypePrices` (object) - `platform.billing.plan.identifiers` (array) - `platform.billing.plan.primary` (boolean) - `platform.billing.plan.name` (string) - `platform.billing.plan.description` (string) - `platform.billing.plan.interval` (string) Enum: "endOfWeek", "endOfWeekOrMonth", "endOfMonth", "endOfQuarter", "endOfTrip", "endOfTransportOrder" - `platform.billing.plan.intervalCount` (integer) - `platform.billing.plan.trialPeriodDays` (integer) - `platform.billing.plan.startedAt` (string) - `platform.billing.plan.expiredAt` (string) - `platform.billing.companyName` (string) - `platform.billing.vat` (string) - `platform.billing.email` (string) - `platform.billing.administrativeReference` (object) - `platform.billing.customerId` (string) - `platform.billing.intentId` (string) - `platform.billing.lastBilled` (string) - `platform.billing.lastUsageEventsRun` (string) - `platform.billing.approvedBillingElementTypes` (array) Enum: "user", "vehicle", "consignment", "invoice", "quote", "trip", "messageAutomation", "integration" - `platform.apps` (array) - `platform.apps.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.apps.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. - `platform.apps.createdAt` (string) The date and time this Entity has been created - `platform.apps.updatedAt` (string) The date and time this Entity has been updated - `platform.apps.logo` (object) - `platform.apps.name` (string) - `platform.apps.description` (string) - `platform.apps.publisher` (object) - `platform.apps.publisher.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.apps.publisher.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. - `platform.apps.publisher.createdAt` (string) The date and time this Entity has been created - `platform.apps.publisher.updatedAt` (string) The date and time this Entity has been updated - `platform.apps.publisher.logo` (object) - `platform.apps.publisher.name` (string) - `platform.apps.publisher.description` (string) - `platform.apps.publisher.approved` (boolean) - `platform.apps.publisher.verified` (boolean) - `platform.apps.publisher.users` (array) - `platform.apps.termsAndConditions` (string) - `platform.apps.lastVersion` (object) - `platform.apps.lastVersion.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.apps.lastVersion.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. - `platform.apps.lastVersion.createdAt` (string) The date and time this Entity has been created - `platform.apps.lastVersion.updatedAt` (string) The date and time this Entity has been updated - `platform.apps.lastVersion.name` (string) - `platform.apps.lastVersion.description` (string) - `platform.apps.lastVersion.buildNumber` (integer) - `platform.apps.lastVersion.version` (string) - `platform.apps.lastVersion.permissions` (array) - `platform.apps.lastVersion.hooks` (array) - `platform.apps.lastVersion.hooks.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.apps.lastVersion.hooks.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. - `platform.apps.lastVersion.hooks.createdAt` (string) The date and time this Entity has been created - `platform.apps.lastVersion.hooks.updatedAt` (string) The date and time this Entity has been updated - `platform.apps.lastVersion.hooks.type` (string) Enum: "ui", "api" - `platform.apps.lastVersion.hooks.subtype` (string) Enum: "ui_dashboard_tab", "ui_menu_tab" - `platform.apps.lastVersion.hooks.name` (string) - `platform.apps.lastVersion.hooks.description` (string) - `platform.apps.lastVersion.hooks.iframeURI` (string) - `platform.apps.lastVersion.approved` (boolean) - `platform.apps.versions` (array) - `platform.apps.category` (object) - `platform.apps.category.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `platform.apps.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. - `platform.apps.category.createdAt` (string) The date and time this Entity has been created - `platform.apps.category.updatedAt` (string) The date and time this Entity has been updated - `platform.apps.category.name` (string) - `platform.apps.category.description` (string) - `platform.apps.category.enabled` (boolean) - `platform.apps.screenshots` (array) - `platform.apps.approved` (boolean) - `platform.apps.public` (boolean) - `platform.apps.pricingModel` (string) Enum: "FREE", "PAID", "FREEMIUM", "SUBSCRIPTION", "USAGE_BASED" - `platform.apps.price` (number) - `platform.apps.currency` (string) - `platform.apps.billingCycle` (string) Enum: "MONTHLY", "YEARLY", "ONE_TIME" - `platform.apps.freeTrialDays` (integer) - `platform.apps.usageTiers` (string) - `platform.disablingAt` (string) - `platform.disabled` (boolean) - `platform.inWaitList` (boolean) ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)