# Delete business Delete a business Endpoint: DELETE /business/{id} Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Header parameters: - `Authorization` (string, required) ## Path parameters: - `id` (string, required) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `business` (object) - `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 - `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. - `business.uuid` (string, required) - `business.primaryPlatformId` (string, required) - `business.createdAt` (string) The date and time this Entity has been created - `business.updatedAt` (string) The date and time this Entity has been updated - `business.language` (object) circular reference - `business.name` (string) The name of the business - `business.relationType` (string) - `business.alias` (string) The alias name of the business - `business.description` (string) - `business.transportLicenseNumber` (string) - `business.eori` (string) - `business.scacCode` (string) - `business.industry` (object) - `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 - `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. - `business.industry.uuid` (string, required) - `business.industry.primaryPlatformId` (string, required) - `business.industry.createdAt` (string) The date and time this Entity has been created - `business.industry.updatedAt` (string) The date and time this Entity has been updated - `business.industry.language` (object) circular reference - `business.industry.name` (string) - `business.industry.abbreviated` (string) - `business.industry.enabled` (boolean) - `business.website` (string) - `business.coc` (string) - `business.vat` (string) - `business.invoiceAttentionTo` (string) - `business.invoiceEmail` (string) - `business.quoteAttentionTo` (string) - `business.quoteEmail` (string) - `business.verified` (boolean) - `business.documents` (array) - `business.documents.associationType` (string) Enum: "inline", "reference" - `business.logo` (object) - `business.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 - `business.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. - `business.logo.createdAt` (string) The date and time this Entity has been created - `business.logo.updatedAt` (string) The date and time this Entity has been updated - `business.logo.url` (string) - `business.logo.path` (string) - `business.logo.name` (string) - `business.logo.originalName` (string) - `business.logo.size` (integer) - `business.logo.purpose` (string) - `business.logo.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `business.logo.mimeType` (string) - `business.logo.extension` (string) - `business.logo.identifiers` (array) - `business.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 - `business.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. - `business.logo.identifiers.createdAt` (string) The date and time this Entity has been created - `business.logo.identifiers.updatedAt` (string) The date and time this Entity has been updated - `business.logo.identifiers.name` (string) - `business.logo.identifiers.system` (string) - `business.logo.identifiers.value` (string) - `business.logo.identifiers.expiredAt` (string) - `business.logo.bucket` (object) - `business.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 - `business.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. - `business.logo.bucket.createdAt` (string) The date and time this Entity has been created - `business.logo.bucket.updatedAt` (string) The date and time this Entity has been updated - `business.logo.bucket.name` (string) - `business.logo.uploadedAt` (string) - `business.logo.tempFile` (string) - `business.banners` (array) - `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 - `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. - `business.banners.uuid` (string, required) - `business.banners.primaryPlatformId` (string, required) - `business.banners.createdAt` (string) The date and time this Entity has been created - `business.banners.updatedAt` (string) The date and time this Entity has been updated - `business.banners.language` (object) circular reference - `business.banners.url` (string) - `business.banners.path` (string) - `business.banners.name` (string) - `business.banners.originalName` (string) - `business.banners.size` (integer) - `business.banners.purpose` (string) - `business.banners.type` (string) Enum: "IMAGE", "VIDEO", "MUSIC", "WORD", "EXCEL", "CSV", "PDF", "EMAIL", "JSON" - `business.banners.mimeType` (string) - `business.banners.extension` (string) - `business.banners.identifiers` (array) - `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 - `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. - `business.banners.identifiers.uuid` (string, required) - `business.banners.identifiers.primaryPlatformId` (string, required) - `business.banners.identifiers.createdAt` (string) The date and time this Entity has been created - `business.banners.identifiers.updatedAt` (string) The date and time this Entity has been updated - `business.banners.identifiers.language` (object) circular reference - `business.banners.identifiers.name` (string) - `business.banners.identifiers.system` (string) - `business.banners.identifiers.value` (string) - `business.banners.identifiers.expiredAt` (string) - `business.banners.bucket` (object) - `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 - `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. - `business.banners.bucket.uuid` (string, required) - `business.banners.bucket.primaryPlatformId` (string, required) - `business.banners.bucket.createdAt` (string) The date and time this Entity has been created - `business.banners.bucket.updatedAt` (string) The date and time this Entity has been updated - `business.banners.bucket.language` (object) circular reference - `business.banners.bucket.name` (string) - `business.banners.uploadedAt` (string) - `business.banners.tempFile` (string) - `business.banners.contentMatrix` (array) - `business.locations` (array) - `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 - `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. - `business.locations.uuid` (string, required) - `business.locations.primaryPlatformId` (string, required) - `business.locations.createdAt` (string) The date and time this Entity has been created - `business.locations.updatedAt` (string) The date and time this Entity has been updated - `business.locations.language` (object) circular reference - `business.locations.type` (string) Enum: "warehouse", "store", "environmentalZone", "restrictedArea", "customer", "parkingSpot", "loadingUnloadingArea", "operationalBase", "fuelStation" - `business.locations.name` (string) - `business.locations.unCode` (string) - `business.locations.geoReference` (object) - `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 - `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. - `business.locations.geoReference.uuid` (string, required) - `business.locations.geoReference.primaryPlatformId` (string, required) - `business.locations.geoReference.createdAt` (string) The date and time this Entity has been created - `business.locations.geoReference.updatedAt` (string) The date and time this Entity has been updated - `business.locations.geoReference.language` (object) circular reference - `business.locations.geoReference.type` (string) Enum: "addressGeoReference", "zoneGeoReference", "tmcArrayGeoReference", "tmcLocationGeoReference", "openLRGeoReference", "GeoReference", "Feature", "latLonArrayGeoReference", "latLonPointGeoReference" - `business.locations.administrativeReference` (object) - `business.locations.administrativeReference.name` (string) - `business.locations.administrativeReference.street` (string) - `business.locations.administrativeReference.houseNumber` (string) - `business.locations.administrativeReference.houseNumberAddition` (string) - `business.locations.administrativeReference.postalCode` (string) - `business.locations.administrativeReference.city` (string) - `business.locations.administrativeReference.country` (string) - `business.locations.contactDetails` (array) - `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 - `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. - `business.locations.contactDetails.uuid` (string, required) - `business.locations.contactDetails.primaryPlatformId` (string, required) - `business.locations.contactDetails.createdAt` (string) The date and time this Entity has been created - `business.locations.contactDetails.updatedAt` (string) The date and time this Entity has been updated - `business.locations.contactDetails.language` (object) circular reference - `business.locations.contactDetails.type` (string) Enum: "iban", "gln", "vatCode", "name", "lastName", "middleName", "firstName", "phone", "mobilePhone", "email", "language", "other" - `business.locations.contactDetails.value` (string) - `business.locations.contactDetails.remarks` (string) - `business.locations.openingTimes` (object) - `business.locations.openingTimes.monday` (object) - `business.locations.openingTimes.monday.start` (string) - `business.locations.openingTimes.monday.end` (string) - `business.locations.openingTimes.monday.open` (boolean) - `business.locations.openingTimes.monday.day` (string) - `business.locations.openingTimes.monday.name` (string) - `business.locations.openingTimes.monday.description` (string) - `business.locations.openingTimes.tuesday` (object) - `business.locations.openingTimes.wednesday` (object) - `business.locations.openingTimes.thursday` (object) - `business.locations.openingTimes.friday` (object) - `business.locations.openingTimes.saturday` (object) - `business.locations.openingTimes.sunday` (object) - `business.locations.terminal` (object) - `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 - `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. - `business.locations.terminal.uuid` (string, required) - `business.locations.terminal.primaryPlatformId` (string, required) - `business.locations.terminal.createdAt` (string) The date and time this Entity has been created - `business.locations.terminal.updatedAt` (string) The date and time this Entity has been updated - `business.locations.terminal.language` (object) circular reference - `business.locations.terminal.name` (string, required) - `business.locations.terminal.integrationType` (string) Enum: "portbase", "psa", "dpworld" - `business.locations.terminal.ean` (string) - `business.locations.terminal.bicsCode` (string) - `business.locations.terminal.quayName` (string) - `business.locations.terminal.smdgCode` (string) - `business.locations.terminal.locations` (array) - `business.locations.terminal.allowedModalities` (array) - `business.locations.terminal.terminalSettings` (array) - `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 - `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. - `business.locations.terminal.terminalSettings.uuid` (string, required) - `business.locations.terminal.terminalSettings.primaryPlatformId` (string, required) - `business.locations.terminal.terminalSettings.createdAt` (string) The date and time this Entity has been created - `business.locations.terminal.terminalSettings.updatedAt` (string) The date and time this Entity has been updated - `business.locations.terminal.terminalSettings.language` (object) circular reference - `business.locations.terminal.terminalSettings.loading` (boolean) - `business.locations.terminal.terminalSettings.full` (boolean) - `business.locations.terminal.terminalSettings.modality` (string) - `business.locations.terminal.terminalSettings.sealNumberAllowed` (boolean) - `business.locations.terminal.terminalSettings.reeferAllowed` (boolean) - `business.locations.terminal.terminalSettings.grossWeightAllowed` (boolean) - `business.locations.terminal.terminalSettings.outOfGaugeAllowed` (boolean) - `business.locations.terminal.terminalSettings.dangerousGoodsAllowed` (boolean) - `business.locations.terminal.terminalSettings.cargoCutOffInMinutes` (integer) - `business.locations.terminal.tarRequired` (boolean) - `business.locations.terminal.roadLicenseIdRequired` (boolean) - `business.locations.actions` (array) - `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 - `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. - `business.locations.actions.uuid` (string, required) - `business.locations.actions.primaryPlatformId` (string, required) - `business.locations.actions.createdAt` (string) The date and time this Entity has been created - `business.locations.actions.updatedAt` (string) The date and time this Entity has been updated - `business.locations.actions.language` (object) circular reference - `business.locations.actions.type` (string) Enum: "load", "unload", "handOver", "stop", "move", "attachTransportEquipment", "detachTransportEquipment", "attachChauffeur", "detachChauffeur", "genericAction", "wait", "break", "refuel", "customs", "weighing", "typeTakeAndReturn", "booking" - `business.locations.actions.groupId` (string) - `business.locations.actions.name` (string, required) The name of the action - `business.locations.actions.externalAttributes` (object) - `business.locations.actions.identifiers` (array) - `business.locations.actions.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `business.locations.actions.result` (object) - `business.locations.actions.result.status` (string) Enum: "succeeded", "failed", "partiallySucceeded", "cancelled" - `business.locations.actions.result.remark` (string) - `business.locations.actions.result.reason` (string) - `business.locations.actions.result.results` (array) - `business.locations.actions.result.answers` (object) - `business.locations.actions.result.attachments` (array) - `business.locations.actions.result.attachments.questionId` (string) - `business.locations.actions.result.attachments.type` (string) Enum: "photo", "signature", "document" - `business.locations.actions.result.attachments.documentId` (string) - `business.locations.actions.result.attachments.dataUrl` (string) - `business.locations.actions.remark` (string) - `business.locations.actions.sequenceNr` (integer) The number in which order the Action occurs - `business.locations.actions.tripSequenceNr` (integer) The number in which order the Action occurs within the trip - `business.locations.actions.location` (object) - `business.locations.actions.location.associationType` (string) Enum: "inline", "reference" - `business.locations.actions.startTime` (string) - `business.locations.actions.endTime` (string) - `business.locations.actions.eta` (string) - `business.locations.actions.etd` (string) - `business.locations.actions.timeFormat` (string) - `business.locations.actions.recurrence` (string) - `business.locations.actions.duration` (integer) The actual duration of the action in minutes - `business.locations.actions.estimatedDuration` (integer) The estimated duration of the action in minutes - `business.locations.actions.inTripOnly` (boolean) - `business.locations.actions.actions` (array) - `business.locations.actions.actions.associationType` (string) Enum: "inline", "reference" - `business.locations.actions.communicationRequests` (array) - `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 - `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. - `business.locations.actions.communicationRequests.uuid` (string, required) - `business.locations.actions.communicationRequests.primaryPlatformId` (string, required) - `business.locations.actions.communicationRequests.createdAt` (string) The date and time this Entity has been created - `business.locations.actions.communicationRequests.updatedAt` (string) The date and time this Entity has been updated - `business.locations.actions.communicationRequests.language` (object) circular reference - `business.locations.actions.communicationRequests.name` (string) - `business.locations.actions.communicationRequests.description` (string) - `business.locations.actions.communicationRequests.status` (string) Enum: "pending", "processing", "success", "failure" - `business.locations.actions.communicationRequests.responseMessage` (string) - `business.locations.actions.communicationRequests.responseValue` (string) - `business.locations.actions.documents` (array) - `business.locations.actions.documents.associationType` (string) Enum: "inline", "reference" - `business.locations.actions.contextEvents` (array) - `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 - `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. - `business.locations.actions.contextEvents.uuid` (string, required) - `business.locations.actions.contextEvents.primaryPlatformId` (string, required) - `business.locations.actions.contextEvents.createdAt` (string) The date and time this Entity has been created - `business.locations.actions.contextEvents.updatedAt` (string) The date and time this Entity has been updated - `business.locations.actions.contextEvents.language` (object) circular reference - `business.locations.actions.contextEvents.type` (string) Enum: "generalEvent", "sensorUpdateEvent", "gateInEvent", "gateOutEvent", "arrivalEvent", "departureEvent", "stopEngineEvent", "startEngineEvent", "startWaitingEvent", "stopWaitingEvent", "stopMovingEvent", "startMovingEvent", "locationUpdateEvent", "updateEvent", "associationRemovedEvent", "associationCreatedEvent", "capacityChangeEvent" - `business.locations.actions.contextEvents.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `business.locations.actions.contextEvents.externalAttributes` (object) - `business.locations.actions.contextEvents.identifiers` (array) - `business.locations.actions.contextEvents.dateTime` (string) - `business.locations.actions.attributes` (array) - `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 - `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. - `business.locations.actions.attributes.uuid` (string, required) - `business.locations.actions.attributes.primaryPlatformId` (string, required) - `business.locations.actions.attributes.createdAt` (string) The date and time this Entity has been created - `business.locations.actions.attributes.updatedAt` (string) The date and time this Entity has been updated - `business.locations.actions.attributes.language` (object) circular reference - `business.locations.actions.attributes.name` (string) - `business.locations.actions.attributes.color` (string) - `business.locations.actions.versionNumber` (integer) - `business.locations.actions.constraints` (array) - `business.locations.actions.constraints.associationType` (string, required) - `business.locations.constraints` (array) - `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 - `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. - `business.locations.constraints.uuid` (string, required) - `business.locations.constraints.primaryPlatformId` (string, required) - `business.locations.constraints.createdAt` (string) The date and time this Entity has been created - `business.locations.constraints.updatedAt` (string) The date and time this Entity has been updated - `business.locations.constraints.language` (object) circular reference - `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" - `business.locations.constraints.name` (string) - `business.locations.constraints.enforceability` (string) Enum: "enforced", "preference" - `business.locations.pricingElements` (array) - `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 - `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. - `business.locations.pricingElements.uuid` (string, required) - `business.locations.pricingElements.primaryPlatformId` (string, required) - `business.locations.pricingElements.createdAt` (string) The date and time this Entity has been created - `business.locations.pricingElements.updatedAt` (string) The date and time this Entity has been updated - `business.locations.pricingElements.language` (object) circular reference - `business.locations.pricingElements.sequenceNr` (integer) - `business.locations.pricingElements.quantity` (integer) - `business.locations.pricingElements.name` (string) - `business.locations.pricingElements.description` (string) - `business.locations.pricingElements.category` (object) - `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 - `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. - `business.locations.pricingElements.category.uuid` (string, required) - `business.locations.pricingElements.category.primaryPlatformId` (string, required) - `business.locations.pricingElements.category.createdAt` (string) The date and time this Entity has been created - `business.locations.pricingElements.category.updatedAt` (string) The date and time this Entity has been updated - `business.locations.pricingElements.category.language` (object) circular reference - `business.locations.pricingElements.category.name` (string) - `business.locations.pricingElements.category.creditCode` (string) - `business.locations.pricingElements.category.debitCode` (string) - `business.locations.pricingElements.category.defaultValue` (number) - `business.locations.pricingElements.category.enabled` (boolean) - `business.locations.pricingElements.category.tripRevenue` (boolean) - `business.locations.pricingElements.business` (object) circular reference - `business.locations.pricingElements.amount` (object) - `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 - `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. - `business.locations.pricingElements.amount.uuid` (string, required) - `business.locations.pricingElements.amount.primaryPlatformId` (string, required) - `business.locations.pricingElements.amount.createdAt` (string) The date and time this Entity has been created - `business.locations.pricingElements.amount.updatedAt` (string) The date and time this Entity has been updated - `business.locations.pricingElements.amount.language` (object) circular reference - `business.locations.pricingElements.amount.amount` (number) - `business.locations.pricingElements.amount.currency` (object) - `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 - `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. - `business.locations.pricingElements.amount.currency.uuid` (string, required) - `business.locations.pricingElements.amount.currency.primaryPlatformId` (string, required) - `business.locations.pricingElements.amount.currency.createdAt` (string) The date and time this Entity has been created - `business.locations.pricingElements.amount.currency.updatedAt` (string) The date and time this Entity has been updated - `business.locations.pricingElements.amount.currency.language` (object) circular reference - `business.locations.pricingElements.amount.currency.name` (string) - `business.locations.pricingElements.amount.currency.short` (string) - `business.locations.pricingElements.amount.currency.sign` (string) - `business.locations.pricingElements.amount.currency.decimalDelimiter` (string) - `business.locations.pricingElements.amount.currency.thousandDelimiter` (string) - `business.locations.pricingElements.amount.currency.enabled` (boolean) - `business.locations.pricingElements.amount.taxRate` (object) - `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 - `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. - `business.locations.pricingElements.amount.taxRate.createdAt` (string) The date and time this Entity has been created - `business.locations.pricingElements.amount.taxRate.updatedAt` (string) The date and time this Entity has been updated - `business.locations.pricingElements.amount.taxRate.creditCode` (string) - `business.locations.pricingElements.amount.taxRate.debitCode` (string) - `business.locations.pricingElements.amount.taxRate.identifiers` (array) - `business.locations.pricingElements.amount.taxRate.name` (string) - `business.locations.pricingElements.amount.taxRate.description` (string) - `business.locations.pricingElements.amount.taxRate.jurisdiction` (string) - `business.locations.pricingElements.amount.taxRate.percentage` (number) - `business.locations.pricingElements.amount.taxRate.inclusive` (boolean) - `business.locations.pricingElements.amount.taxRate.active` (boolean) - `business.locations.pricingElements.amount.inclusiveOfTax` (boolean) - `business.locations.pricingElements.subTotal` (object) - `business.locations.pricingElements.tax` (object) - `business.locations.pricingElements.total` (object) - `business.locations.remark` (string) - `business.locations.hash` (string) - `business.locations.identifiers` (array) - `business.locations.externalAttributes` (object) - `business.locations.dataIsComplete` (boolean) - `business.identification` (array) - `business.identifiers` (array) - `business.contactDetails` (array) - `business.contactPersons` (array) - `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 - `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. - `business.contactPersons.uuid` (string, required) - `business.contactPersons.primaryPlatformId` (string, required) - `business.contactPersons.createdAt` (string) The date and time this Entity has been created - `business.contactPersons.updatedAt` (string) The date and time this Entity has been updated - `business.contactPersons.language` (object) circular reference - `business.contactPersons.firstName` (string) - `business.contactPersons.lastName` (string) - `business.contactPersons.position` (string) - `business.contactPersons.email` (string) - `business.contactPersons.phone` (string) - `business.contactPersons.mobilePhone` (string) - `business.notes` (array) - `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 - `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. - `business.notes.uuid` (string, required) - `business.notes.primaryPlatformId` (string, required) - `business.notes.createdAt` (string) The date and time this Entity has been created - `business.notes.updatedAt` (string) The date and time this Entity has been updated - `business.notes.language` (object) circular reference - `business.notes.author` (object) circular reference - `business.notes.name` (string) - `business.notes.text` (string) - `business.partOf` (array) - `business.administration` (object) - `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 - `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. - `business.administration.uuid` (string, required) - `business.administration.primaryPlatformId` (string, required) - `business.administration.createdAt` (string) The date and time this Entity has been created - `business.administration.updatedAt` (string) The date and time this Entity has been updated - `business.administration.language` (object) circular reference - `business.administration.platforms` (array) - `business.administration.name` (string) - `business.administration.primary` (boolean) - `business.administration.transportOrderPrefix` (string) - `business.administration.consignmentPrefix` (string) - `business.administration.business` (object) circular reference - `business.administration.currency` (object) - `business.administration.balance` (object) - `business.administration.bankAccounts` (array) - `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 - `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. - `business.administration.bankAccounts.uuid` (string, required) - `business.administration.bankAccounts.primaryPlatformId` (string, required) - `business.administration.bankAccounts.createdAt` (string) The date and time this Entity has been created - `business.administration.bankAccounts.updatedAt` (string) The date and time this Entity has been updated - `business.administration.bankAccounts.language` (object) circular reference - `business.administration.bankAccounts.accountHolderName` (string) - `business.administration.bankAccounts.accountHolderType` (string) - `business.administration.bankAccounts.bankName` (string) - `business.administration.bankAccounts.routingNumber` (string) - `business.administration.bankAccounts.accountNumber` (string) - `business.administration.bankAccounts.last4` (string) - `business.administration.bankAccounts.currency` (object) - `business.administration.bankAccounts.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 - `business.administration.bankAccounts.currency.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `business.administration.bankAccounts.currency.createdAt` (string) The date and time this Entity has been created - `business.administration.bankAccounts.currency.updatedAt` (string) The date and time this Entity has been updated - `business.administration.bankAccounts.currency.name` (string) - `business.administration.bankAccounts.currency.short` (string) - `business.administration.bankAccounts.currency.sign` (string) - `business.administration.bankAccounts.currency.decimalDelimiter` (string) - `business.administration.bankAccounts.currency.thousandDelimiter` (string) - `business.administration.bankAccounts.currency.enabled` (boolean) - `business.administration.bankAccounts.country` (string) - `business.administration.bankAccounts.validation` (object) circular reference - `business.administration.bankAccounts.validated` (boolean) - `business.administration.bankAccounts.identifiers` (array) - `business.administration.numberFormat` (string) - `business.administration.numberLength` (integer) - `business.administration.dueDays` (integer) - `business.administration.invoiceNumberIndex` (object) - `business.administration.quoteNumberIndex` (object) - `business.administration.invoiceSendMessageAutomation` (object) - `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 - `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. - `business.administration.invoiceSendMessageAutomation.uuid` (string, required) - `business.administration.invoiceSendMessageAutomation.primaryPlatformId` (string, required) - `business.administration.invoiceSendMessageAutomation.createdAt` (string) The date and time this Entity has been created - `business.administration.invoiceSendMessageAutomation.updatedAt` (string) The date and time this Entity has been updated - `business.administration.invoiceSendMessageAutomation.language` (object) circular reference - `business.administration.invoiceSendMessageAutomation.type` (string) Enum: "messageAutomation", "questionAnswerAutomation", "fileRequestAutomation" - `business.administration.invoiceSendMessageAutomation.name` (string, required) The name of a messageAutomation - `business.administration.invoiceSendMessageAutomation.description` (string, required) The description of a messageAutomation - `business.administration.invoiceSendMessageAutomation.automationConfig` (object) - `business.administration.invoiceSendMessageAutomation.automationConfig.triggerType` (string) Enum: "trigger", "scheduler", "listener" - `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" - `business.administration.invoiceSendMessageAutomation.automationConfig.schedule` (object) - `business.administration.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleValue` (integer) - `business.administration.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleType` (string) Enum: "seconds", "minutes", "hours", "days", "months" - `business.administration.invoiceSendMessageAutomation.automationConfig.schedule.milliseconds` (integer) - `business.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSelector` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSchedule` (object) - `business.administration.invoiceSendMessageAutomation.automationConfig.filters` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.filters.selector` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.filters.comparisonType` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `business.administration.invoiceSendMessageAutomation.automationConfig.filters.value` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.filters.linkType` (string) Enum: "and", "or" - `business.administration.invoiceSendMessageAutomation.automationConfig.filters.filters` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.filters.sequenceNr` (integer) - `business.administration.invoiceSendMessageAutomation.automationConfig.filters.valueSelector` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.query` (object) - `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 - `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. - `business.administration.invoiceSendMessageAutomation.automationConfig.query.createdAt` (string) The date and time this Entity has been created - `business.administration.invoiceSendMessageAutomation.automationConfig.query.updatedAt` (string) The date and time this Entity has been updated - `business.administration.invoiceSendMessageAutomation.automationConfig.query.fields` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.fields.name` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.fields.groupByAggregate` (string) Enum: "count", "max", "min", "sum", "avg" - `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" - `business.administration.invoiceSendMessageAutomation.automationConfig.query.joins` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.joins.type` (string) Enum: "inner_join" - `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" - `business.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onLeft` (object) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.joins.onRight` (object) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters` (array) - `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 - `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. - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.createdAt` (string) The date and time this Entity has been created - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.updatedAt` (string) The date and time this Entity has been updated - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.sequenceNr` (integer) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.field` (string) - `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" - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.value` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.valueType` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `business.administration.invoiceSendMessageAutomation.automationConfig.query.filters.linkType` (string) Enum: "and", "or" - `business.administration.invoiceSendMessageAutomation.automationConfig.query.groupBy` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.having` (object) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.sortFields` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.sortDirection` (string) Enum: "asc", "desc" - `business.administration.invoiceSendMessageAutomation.automationConfig.query.limit` (integer) - `business.administration.invoiceSendMessageAutomation.automationConfig.query.offset` (integer) - `business.administration.invoiceSendMessageAutomation.automationConfig.recipients` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.recipientSelector` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.toggleForAll` (boolean) - `business.administration.invoiceSendMessageAutomation.automationConfig.channel` (string) Enum: "email", "chat", "notification", "whatsapp", "telegram" - `business.administration.invoiceSendMessageAutomation.automationConfig.manualIntegration` (object) circular reference - `business.administration.invoiceSendMessageAutomation.automationConfig.includeAttachments` (boolean) - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentSourceType` (string) Enum: "ENTITY_PDF", "CUSTOM_TEMPLATE", "INSIGHT_REPORT", "STATIC_FILE" - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentType` (string) Enum: "cmr", "waybill", "invoice", "quote", "transportOrder", "trip", "custom" - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentTemplateId` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileUrl` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.insightType` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.reportParameters` (object) - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.entityIdSelector` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileNameTemplate` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.subject` (string) The subject of a message for a particular messageAutomation - `business.administration.invoiceSendMessageAutomation.automationConfig.currentTriggerPosition` (integer) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts` (array) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language` (object) - `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 - `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. - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.createdAt` (string) The date and time this Entity has been created - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.updatedAt` (string) The date and time this Entity has been updated - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.name` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.localName` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.code` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.iso3166` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.decimalDelimiter` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.thousandDelimiter` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.dateFormat` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.measurementUnit` (string) Enum: "metric", "imperial" - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.content` (string, required) The template of a message for a particular messageAutomation - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.messageTemplate` (string, required) The template of a message for a particular messageAutomation - `business.administration.invoiceSendMessageAutomation.automationConfig.localizedTexts.subject` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.defaultLanguageId` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.languageSelector` (string) - `business.administration.invoiceSendMessageAutomation.automationConfig.userEnableable` (boolean) - `business.administration.invoiceSendMessageAutomation.automationConfig.userPermissionFilters` (array) - `business.administration.invoiceSendMessageAutomation.messageAutomationIntegration` (object) circular reference - `business.administration.invoiceSendMessageAutomation.enabled` (boolean) - `business.administration.invoiceSendMessageAutomation.lastHandled` (string) - `business.administration.invoiceSendMessageAutomation.template` (boolean) - `business.administration.invoiceSendMessageAutomation.templateCategory` (string) - `business.administration.automaticallySendReminders` (boolean) - `business.administration.invoiceFirstReminderMessageAutomation` (object) - `business.administration.invoiceSecondReminderMessageAutomation` (object) - `business.administration.invoiceThirdReminderMessageAutomation` (object) - `business.administration.invoicePaidMessageAutomation` (object) - `business.administration.quoteSendMessageAutomation` (object) - `business.administration.invoiceTermsAndConditions` (array) - `business.administration.invoiceTermsAndConditions.language` (object) - `business.administration.invoiceTermsAndConditions.text` (string) - `business.administration.quoteTermsAndConditions` (array) - `business.administration.transportOrderTermsAndConditions` (array) - `business.administration.identifiers` (array) - `business.dataIsComplete` (boolean) - `business.pricingConfigurationCount` (integer) - `business.hasAgreedToPrice` (boolean) ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)