AEB BSM API
The bundled BSM (Business Solution Modules) HTTP API that AEB exposes for SAP and partner-system integration — one surface spanning BSM Carrier, AEB Delivery, BSM International Customs, Export Control, Origin & Preferences / Declaration of Origin, Routing and the SAP add-on endpoints, plus an /x360/handleEvent inbound event endpoint. Documented in the public AEB-labs docs-bsm repository; no live public ReadMe hub for it was found on 2026-07-30.
AEB BSM API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include SAP, Customs, Export Control, Origin and Preferences, and Shipping. The published artifact set on APIs.io includes an OpenAPI specification, a GitHub repository, and API documentation.
This API exposes 180 operations across 174 paths, organized into 24 resource areas, and defines 689 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://rz3.aeb.de/test2bsm/rest.
180 operations
174 paths
689 schemas
3 DELETE31 GET145 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB BSM API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-XNSG_WEB_TOKEN (SWAGGER_AUTH_KEY).
It accepts HTTP basic authentication (BASIC_AUTH).
By default, every request must be authenticated.
Paths & Operations 180
Across 174 paths, the API surfaces 180 operations — 3 DELETE, 31 GET, 145 POST, 1 PUT. They span 24 resource areas, including BSM Carrier, AEB Delivery, BSM International Customs, BSM Sync, SAP®, CoreBFBean, Shipping, Export Control, and 16 more. Each is listed below with its method, path, parameters, and response codes.
BSM Carrier 3
The API for BSM Carrier operations
POST
/BSMCarrierBFBean/createShipment
createShipment
POST
/BSMCarrierBFBean/getQuotes
getQuotes
POST
/BSMCarrierBFBean/getShipment
getShipment
AEB Delivery 3
API for the AEBDelivery
POST
/AEBDeliveryBFBean/deleteDelivery
deleteDelivery
POST
/AEBDeliveryBFBean/getDelivery
getDelivery
POST
/AEBDeliveryBFBean/updateDelivery
updateDelivery
BSM International Customs 1
API for BSM International Customs operations
POST
/BSMInternationalCustomsBFBean/createConsignment
createConsignment
BSM Sync 6
API for synchronizing data asynchronous from an engine to a client system
POST
/BSMSyncBFBean/acknowledgeEvents
acknowledgeEvents
POST
/BSMSyncBFBean/getNotAcknowledgedEvents
getNotAcknowledgedEvents
POST
/BSMSyncBFBean/getPartnerSystemSubscriptions
getPartnerSystemSubscriptions
POST
/BSMSyncBFBean/subscribePartnerSystem
subscribePartnerSystem
POST
/BSMSyncBFBean/synchronizeEvents
synchronizeEvents
POST
/BSMSyncBFBean/unsubscribePartnerSystem
unsubscribePartnerSystem
SAP® 1
All SAP® specific APIs to interact with the BSM.
POST
/SAP/handleEvent
Handle SAP® events.
CoreBFBean 12
API for the XNSGFoundation
POST
/CoreBFBean/checkBFFunctionExists
Can be called to know if a BF function exist.
POST
/CoreBFBean/echo
Returns the given echo parameter value.
POST
/CoreBFBean/echoUpperCase
Returns the given echo parameter value in uppercase.
GET
/CoreBFBean/getAllMonitoringValues
Returns all available monitoring values of the server.
GET
/CoreBFBean/getBuildForSolution
Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFBLDSOL\".
GET
/CoreBFBean/getMonitoringValue
Returns the current monitoring value for the given group and name.
GET
/CoreBFBean/getProductInfo
Return information about the server that is answering this request. This includes the product name and various version informations. The RFC name of this function is \"/AEB/XNSGIFPRINFO\".
GET
/CoreBFBean/getRuntimeInfo
Return runtime information about the server that is answering this request. This includes the server name, ports and various other runtime informations. The RFC name of this function is \"/AEB/XNSGIF…
POST
/CoreBFBean/getRuntimeState
Return runtime state information about the server that is answering this request. This includes if the server is doing fine or not. Also included are the supported operations (bfs) for the installati…
GET
/CoreBFBean/getThreadDump
Generate Thread-Dump.
GET
/CoreBFBean/getVersionForSolution
Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFVERSOL\".
POST
/CoreBFBean/restartRFCServer
This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure def…
Shipping 21
API for the CarrierEngine service
POST
/DLCarrierBFBean/addShipmentAttachments
addShipmentAttachments
POST
/DLCarrierBFBean/cancelShipment
cancelShipment
POST
/DLCarrierBFBean/createPickup
createPickup
POST
/DLCarrierBFBean/createShipment
createShipment
POST
/DLCarrierBFBean/deleteItem
deleteItem
POST
/DLCarrierBFBean/deletePackage
deletePackage
POST
/DLCarrierBFBean/deletePickup
deletePickup
POST
/DLCarrierBFBean/getAllCarriers
getAllCarriers
POST
/DLCarrierBFBean/getCarrierPortfolioNames
getCarrierPortfolioNames
POST
/DLCarrierBFBean/getCarrierPortfolioDetails
getCarrierPortfolioDetails
POST
/DLCarrierBFBean/getCarrierProperties
getCarrierProperties
POST
/DLCarrierBFBean/getPickups
getPickups
POST
/DLCarrierBFBean/getShipments
getShipments
POST
/DLCarrierBFBean/processPackage
processPackage
POST
/DLCarrierBFBean/processPackageReturnEnclosedLabel
processPackageReturnEnclosedLabel
POST
/DLCarrierBFBean/processPickup
processPickup
POST
/DLCarrierBFBean/processShipment
processShipment
POST
/DLCarrierBFBean/syncPickups
syncPickups
POST
/DLCarrierBFBean/syncShipments
syncShipments
POST
/DLCarrierBFBean/updateCustomsData
updateCustomsData
POST
/DLCarrierBFBean/validateShipment
validateShipment
Export Control 8
API for export control
POST
/ExportControl/v2/acknowledgeGetChangedTransactions
Acknowledge changed results of EC check transactions.
POST
/ExportControl/v2/checkTransaction
Check a transaction in Export Controls.
POST
/ExportControl/v2/createQuestionnaireForTransaction
Create a new questionnaire for a transaction in Export Controls
POST
/ExportControl/v2/deleteTransaction
To be invoked when a transaction in the partner system is deleted.
POST
/ExportControl/v2/finalizeClearing
Finalize a clearing.
POST
/ExportControl/v2/getChangedTransactions
Get the changed results of EC check transactions.
POST
/ExportControl/v2/getTransactionCheckResult
Gets the check result for a certain EC check transaction.
POST
/ExportControl/v2/updateCustomsInfo
Update customs info.
FoundationAFBean 2
Business facade for the XNSGFoundation UI API
POST
/FoundationAFBean/releaseApplicationFacade
Release a UI API which is no longer needed. This call will save resources in the server, because the server must not wait for the timeout of the UI API session but can release it earlier. The method…
POST
/FoundationAFBean/workplace
Creates an UI API to be able to display the workplace. The difference of this method compared to the the method \"IFoundationBF.getWorkplaceURL()\" is the fact, that no logon mask will be dipsplayed…
Logon 2
Authentication handler for the XNSGFoundation
GET
/logon/authToken
Logon from the "Authorization" header (e.g. type "Basic"). The generated authentication token can be used in subsequent calls in the "Authorization" header, type "Bearer".
POST
/logon/user
Logon with classical procedure: user, client and password.
DataFeedBFBean 3
DataFeedBFBean
POST
/DataFeedBFBean/acknowledgePublishedDataFeedParts
Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.
GET
/DataFeedBFBean/dataFeedParts/{client}/{id}
Retrieve the data feed part content.
POST
/DataFeedBFBean/getPublishedDataFeedParts
Poll data about the next 10 published data feed parts. This data contains an id, which can be used to download the content of a part. To download the content, use the endpoint /DataFeedBFBean/dataFee…
ExternalTelemetryBFBean 3
API for sending telemetry data from a third party system.
POST
/ExternalTelemetryBFBean/getStatus
Returns the current status of the telemetry system. The external system id must be sent with the request.
GET
/ExternalTelemetryBFBean/status
Returns the current status of the telemetry system. The external system id must be sent with the request.
POST
/ExternalTelemetryBFBean/telemetryReport
Submits telemetry data for a new telemetry report. The external system id must be sent with the request, a client IdentCode only if client dependent.
FoundationBFBean 31
REST endpoint for FoundationBF
POST
/FoundationBFBean/acknowledgeFile
Acknowledges a file download.
POST
/FoundationBFBean/announceStop
Announces a stop of the installation.
POST
/FoundationBFBean/cancelAnnounceStop
Revokes an already announced stop.
POST
/FoundationBFBean/changeAdminPassword
Changes the admin password.
GET
/FoundationBFBean/client
Requests all clients from this engine, or one client identified by values in query parameter
POST
/FoundationBFBean/client
Create a client.
POST
/FoundationBFBean/downloadFile
Retrieves a file for download.
POST
/FoundationBFBean/generateClientIdentCode
Generates a client ident code.
GET
/FoundationBFBean/client/active
Requests all active clients from this engine.
GET
/FoundationBFBean/monitoringValue
Requests all monitoring values from this engine.
GET
/FoundationBFBean/solution/{name}/build
Requests the build info for a solution from this engine.
POST
/FoundationBFBean/downloadableFileRefs
Retrieves refs for download.
GET
/FoundationBFBean/monitoringValue/{groupName}/{valueName}
Requests a specific monitoring value from this engine.
GET
/FoundationBFBean/numberOfClients
Returns the number of clients.
GET
/FoundationBFBean/productInfo
Requests the product info from this engine.
GET
/FoundationBFBean/runtimeInfo
Requests the runtime info from this engine.
POST
/FoundationBFBean/scriptExecutionState
gets a script execution state
POST
/FoundationBFBean/tableUpdateState
Retrieve the status of the table update.
POST
/FoundationBFBean/uploadSettings
Retrieves the upload settings.
GET
/FoundationBFBean/solution/{name}/version
Requests the version info for a solution from this engine.
GET
/FoundationBFBean/workplaceURL
Requests the workplace url from this engine.
GET
/FoundationBFBean/checkDebtorNumber
Checks if debtor number is known.
POST
/FoundationBFBean/publishUserMessage
creates a user message, in several languages if required
GET
/FoundationBFBean/roles
Requests the current engine to report all its roles
GET
/FoundationBFBean/roles/{clientIdentCode}
Requests the current engine to report all roles for a specific client
POST
/FoundationBFBean/restartRFCServer
This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure def…
POST
/FoundationBFBean/sendMail
Sends a mail.
POST
/FoundationBFBean/startScriptExecution
Starts a script execution
POST
/FoundationBFBean/startTableUpdate
Starts the table update.
POST
/FoundationBFBean/systemSearch/{language}
Performs a system search in this engine.
POST
/FoundationBFBean/uploadFileMultiPart
Uploads a file using multipart.
RemoteAdminBFBean 2
Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR).
GET
/RemoteAdminBFBean/clientRoles/{clientId}
getRoles
GET
/RemoteAdminBFBean/roles
getRoles
SyncBFBean 6
API for synchronizing data asynchronous from an engine to a client system.
POST
/SyncBFBean/acknowledgeEvents
Acknowledge events got with {@link getNotAcknowledgedEvents(SyncEventsRequestDTO)}. Since XNSG 4.0, Nov. FP, 2017 .
POST
/SyncBFBean/getNotAcknowledgedEvents
Poll any not acknowledged events for the client system. This method does not require, that the client system fills {@link SyncEventsRequestDTOsyncId}. However, it requires, that a call to {@link ackn…
POST
/SyncBFBean/getPartnerSystemSubscriptions
Fetch a list of registered subscriptions (either all or filtered by the business object type). Only subscription belonging to the provided clientSystemId are returned (mandatory field) Since XNSG 4.0…
POST
/SyncBFBean/subscribePartnerSystem
Subscribe a partner system to be able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both mandatory fi…
POST
/SyncBFBean/synchronizeEvents
Poll the next events for the client system. This method requires the client system to persist the synchronisation state itself and passing a proper value for {@link SyncEventsRequestDTOsyncId} See {@…
POST
/SyncBFBean/unsubscribePartnerSystem
Unsubscribe a partner system from being able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both manda…
International Customs API 16
Interface overview for Customs Management
POST
/InternationalCustomsBFBean/acknowledgeGetChangedDeclarations
Acknowledge call of get changed declarations
POST
/InternationalCustomsBFBean/addDeclarationAttachmentsdeprecated
Add declaration attachments
POST
/InternationalCustomsBFBean/cancelConsignment
Cancel consignment
POST
/InternationalCustomsBFBean/cancelConsignmentManifest
Cancel consignment manifest
POST
/InternationalCustomsBFBean/cancelDeclaration
Cancel declaration
POST
/InternationalCustomsBFBean/createConsignment
Create a consignment
POST
/InternationalCustomsBFBean/createConsignmentManifest
Create a consignment manifest
POST
/InternationalCustomsBFBean/createDelivery
Create a delivery
POST
/InternationalCustomsBFBean/getBrokerDeclarations
Get broker declarations
POST
/InternationalCustomsBFBean/getChangedDeclarations
Get changed declarations
POST
/InternationalCustomsBFBean/getCodes
Get codes
POST
/InternationalCustomsBFBean/getConsignmentsOfManifest
Get consignments of manifest
POST
/InternationalCustomsBFBean/getDeclarationAttachments
Get declaration attachments
POST
/InternationalCustomsBFBean/getDeclarations
Get declarations
POST
/InternationalCustomsBFBean/sendDeclarations
Send declarations
POST
/InternationalCustomsBFBean/setDeclarationAttachmentsStatus
Set declaration attachment status
LISBF20Bean 27
Business facade for LIS, version 2.0
POST
/LISBF20Bean/calculateTargetTime
calculateTargetTime
POST
/LISBF20Bean/getConsignments
getConsignments
POST
/LISBF20Bean/getDocumentCategories
getDocumentCategories
POST
/LISBF20Bean/getEventDefinitions
getEventDefinitions
POST
/LISBF20Bean/getMODocument
getMODocument
POST
/LISBF20Bean/getOrderFulfillmentPlans
getOrderFulfillmentPlans
POST
/LISBF20Bean/getQuickSearchResult
getQuickSearchResult
POST
/LISBF20Bean/getTrackingEvents
getTrackingEvents
POST
/LISBF20Bean/getTrackingObjectEvents
getTrackingObjectEvents
POST
/LISBF20Bean/getUniqueConsignment
getUniqueConsignment
POST
/LISBF20Bean/lisBfDummyMethod
lisBfDummyMethod
POST
/LISBF20Bean/receiveAreaDependSchedule
receiveAreaDependSchedule
POST
/LISBF20Bean/receiveConsignment
receiveConsignment
POST
/LISBF20Bean/receiveConsignmentWithTransports
receiveConsignmentWithTransports
POST
/LISBF20Bean/receiveEventCodeList
receiveEventCodeList
POST
/LISBF20Bean/receiveHandlingUnits
receiveHandlingUnits
POST
/LISBF20Bean/receiveMaterialMasterFile
receiveMaterialMasterFile
POST
/LISBF20Bean/receiveMultiReferenceTrackingObjectDocuments
receiveMultiReferenceTrackingObjectDocuments
POST
/LISBF20Bean/receiveOrder
receiveOrder
POST
/LISBF20Bean/receivePhysicalTransport
receivePhysicalTransport
POST
/LISBF20Bean/receiveTrackingEvent
receiveTrackingEvent
POST
/LISBF20Bean/receiveTrackingEventList
receiveTrackingEventList
POST
/LISBF20Bean/receiveTrackingObjectDocuments
receiveTrackingObjectDocuments
POST
/LISBF20Bean/receiveTransport
receiveTransport
POST
/LISBF20Bean/receiveTransportUnit
receiveTransportUnit
POST
/LISBF20Bean/resetConsignmentWithTransports
resetConsignmentWithTransports
POST
/LISBF20Bean/syncConsignments
syncConsignments
Companies 5
Rest API for companies
GET
/companies/{id}
Returns the company with the requested ID (company number). In some cases the ID (company number) is not unique . In this case an error is returned.
PUT
/companies/{id}
Create or update a company with the specified ID (company number). If the company with the given ID does not exist, a new company is created. If the company exist, the existing company is fully updat…
DELETE
/companies/{id}
Delete the company with the specified ID (company number). The ID is in some AEB services not unique , in this case a conflict (409) is returned.
GET
/companies
Returns all companies matching the given filter criteria. In case no company matches the given filter criteria an empty companies collection is returned. All filter fields are case insensitive. If th…
GET
/company-roles
Returns all company roles of this AEB service. Company roles are domain specific characteristics and can differ between the different AEB services.
O&P UI 1
The API with all about Origin and Preferences UIs
POST
/OriginAndPreferencesUIs/openMaterialMasterDataSearchUI
openMaterialMasterDataSearchUI
Declaration of Origin 1
The API with all about declaration of origin
POST
/DeclarationOfOriginBFBean/getDeclarationOfOrigin
getDeclarationOfOrigin
O&P 9
The API with all about Origin and Preferences
POST
/OriginAndPreferencesBFBean/acknowledgeGetChangedMaterialMasterData
acknowledgeGetChangedMaterialMasterData
POST
/OriginAndPreferencesBFBean/getChangedMaterialMasterData
getChangedMaterialMasterData
POST
/OriginAndPreferencesBFBean/getMaterialMasterData
getMaterialMasterData
POST
/OriginAndPreferencesBFBean/transferAddresses
transferAddresses
POST
/OriginAndPreferencesBFBean/transferBillOfMaterials
transferBillOfMaterials
POST
/OriginAndPreferencesBFBean/transferGoodsReceipts
transferGoodsReceipts
POST
/OriginAndPreferencesBFBean/transferMaterials
transferMaterials
POST
/OriginAndPreferencesBFBean/transferPurchaseOrders
transferPurchaseOrders
POST
/OriginAndPreferencesBFBean/transferSalesOrders
transferSalesOrders
WorkstationServiceAgent 6
Connection handler for the Workstation Service Agent
GET
/wssagent/connectdeprecated
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connectdeprecated
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/connection/{id}
Returns response object with information about given workstation service agent.
POST
/wssagent/connection/{id}
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connection/{id}
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/statusdeprecated
Returns response object with information about given workstation service agent.
Routing 10
API for the handling of routing tasks
POST
/RoutingBFBean/createRoutingTask
createRoutingTask
POST
/RoutingBFBean/createSupplementTask
createSupplementTask
POST
/RoutingBFBean/getAllCarriers
getAllCarriers
POST
/RoutingBFBean/getHandoverPoints
getHandoverPoints
POST
/RoutingBFBean/getRatingProfiles
getRatingProfiles
POST
/RoutingBFBean/getRejectedRoutingTaskResult
getRejectedRoutingTaskResult
POST
/RoutingBFBean/getRoutingRequirementTypes
getRoutingRequirementTypes
POST
/RoutingBFBean/getRoutingTaskResult
getRoutingTaskResult
POST
/RoutingBFBean/getSupplementTaskResult
getSupplementTaskResult
POST
/RoutingBFBean/waitForRoutingTaskResult
waitForRoutingTaskResult
x360 1
All Haufe x360 specific APIs to interact with the BSM.
POST
/x360/handleEvent
Endpoint to perfom a compliance screening for a Haufe x360 customer
Schemas 689
The contract defines 689 schemas that model the data the API accepts and returns. The most detailed are DLShipmentResponseDataDTO (102 properties), DLShipmentRequestDataDTO (93 properties), LISConsignmentHead20DTO (58 properties), LISExpConsignmentHead20DTO (54 properties). Each schema is shown below with its type and property counts.
DLCreateShipmentResponseDTO
object
Response DTO for the createShipment business facade method
14 properties
DLDocumentDTO
object
DTO for a document to be printed out by the client system.
7 properties
DLPackageProcessingResultDTO
object
DTO holding result information of a package processing. The package is created and basic validation checks are performed synchronously. The carrier data prepar…
11 properties
DLShipmentAccountInfoResponseDataDTO
object
Holds information from the account used for the shipment
3 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
BSInteractionControlDTO
object
DTO for interaction control
2 properties
BSInteractionControlIDDTO
object
DTO for interaction control id
2 properties
BSInteractionControlUsecaseDTO
object
Usecase for interaction control
1 property
BSMDLCreateShipmentRequestDTO
object
Request DTO for the createShipment business facade method
8 properties
3 required
DLContainerDataDTO
object
DTO containing data for container package types.
3 properties
DLCuboidDimensionsDTO
object
DLCuboidDimensionsDTO with length, width, height and identCode.
4 properties
4 required
DLDocumentOutputModeDTO
object
DTO specifying the output mode for documents.
3 properties
1 required
DLDocumentScopeDTO
object
DTO specifying the scope of documents to be processed.
1 property
1 required
DLHazardousGoodsItemRequestDataDTO
object
DTO for request information of a DLHazardousGoodsItem.
37 properties
1 required
DLPackageCumulationRequestDataDTO
object
DTO for package cumulation data.
7 properties
2 required
DLPackageHazardousGoodsDataRequestDTO
object
Holds hazardous goods data concerning the package.
3 properties
1 required
DLPackageRequestDataDTO
object
DTO for package data.
26 properties
3 required
DLPartyDTO
object
DLPartyDTO containing address data
19 properties
DLPersonDTO
object
DLPersonDTO containing contact data.
4 properties
DLProcessModeDTO
object
DTO specifying the mode in which an operation is processed.
1 property
1 required
DLReferenceTextDTO
object
DTO for reference numbers and texts of a certain (predefined) type.
2 properties
DLShipmentCarrierInfoTextDTO
object
DTO specifying a carrier's info text for a shipment.
2 properties
1 required
DLShipmentCreationParmsDTO
object
Creation parameters for a shipment. Specifies when and how to create a shipment or it's packages.
1 property
1 required
DLShipmentItemReferenceDTO
object
DTO for uniquely identifying an item within a shipment.
5 properties
1 required
DLShipmentItemReferenceTextDTO
object
DTO for reference texts of shipment items.
2 properties
DLShipmentItemRequestDataDTO
object
DTO for shipment item data in a request.
18 properties
1 required
DLShipmentProcessParmsDTO
object
Process parameters for a shipment. Specifies which operations have to be performed after a shipment has been created.
6 properties
6 required
DLShipmentReferenceDTO
object
DTO for uniquely identifying a DLShipment within a specific client.
3 properties
DLShipmentRequestDataDTO
object
DTO for shipment data in a request.
93 properties
9 required
DLShipmentTotalsRequestDataDTO
object
DTO for shipment totals in a request.
4 properties
DLTransportEquipmentDTO
object
DTO representing a specific transport equipment such as a containers or a pallets.
7 properties
2 required
DLTransportEquipmentReferenceDTO
object
DTO for uniquely identifying a transport equipment within a shipment.
2 properties
1 required
DLValueAddedServiceReferenceDTO
object
DTO to reference a value added service within a carrier.
1 property
1 required
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
NamedGenericDataRecordDTO
object
A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
2 properties
QuantityDTO
object
A quantity with a value and a quantity unit. Quantity units are encoded by using AEB unit codes mainly based on the International System of Unit (e.g. 'Gram' i…
3 properties
GetQuotedDataDTO
object
The total net price of the quoted service. Contains the price negotiated with the carrier for the account, if possible; otherwise the list price is used. May b…
5 properties
GetQuotedServiceDTO
object
The quoted service result for one service of a carrier.
4 properties
GetQuotesResponseDTO
object
The response of a getQuotes call.
5 properties
QuotedServiceMessageDTO
object
A text with a code and a hint to the customer. Sources can be the original carrier response or generated by the service
2 properties
GetQuotesRequestDTO
object
The data needed to request quoted services for a shipment.
6 properties
ComboboxEntryDTO
object
For common use in BF methods which return combobox entries, e.g. for a list of master file data.
2 properties
DLHazardousGoodsItemResponseDataDTO
object
DTO for response information of a DLHazardousGoodsItem.
33 properties
DLPackageHazardousGoodsDataResponseDTO
object
Holds hazardous goods data concerning the package.
3 properties
DLPackageResponseDataDTO
object
DTO for response information of a DLPackage. Contains also errors that occurred during carrier data preparation (performed asynchronously by a job). These are…
27 properties
DLShipmentItemResponseDataDTO
object
DTO for shipment item data in a response.
20 properties
DLShipmentResponseDataDTO
object
DTO for response information of a DLShipment. Contains also errors that occurred during carrier data preparation (performed asynchronously by a job). These are…
102 properties
DLShipmentTotalsResponseDataDTO
object
DTO for shipment totals in a request.
6 properties
DLValueAddedServiceDTO
object
Response information about a value added service.
3 properties
GetShipmentResponseDTO
object
The response of a getShipment call.
5 properties
ShipmentResponseDataDTO
object
The data of a shipment.
2 properties
GetShipmentRequestDTO
object
The request to get the data of the shipment including the quoted service.
7 properties
DeleteAEBDeliveryResponseDTO
object
Response for deleting an AEBDelivery
4 properties
DeleteAEBDeliveryRequestDTO
object
Request for deleting an AEBDelivery
5 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
GetAEBAdditionalFieldDTO
object
Additional field to extend data of the business object where it is referenced.
2 properties
GetAEBClassificationDTO
object
Classification data
2 properties
GetAEBCostDTO
object
Cost data
3 properties
GetAEBDeliveryDTO
object
Delivery data
19 properties
GetAEBDeliveryItemDTO
object
Delivery item
17 properties
GetAEBDeliveryResponseDTO
object
Response for getting an AEBDelivery
5 properties
GetAEBGoodsDescriptionDTO
object
Goods description
2 properties
GetAEBHandlingUnitDTO
object
Handling unit
16 properties
GetAEBInvoiceDTO
object
Invoice data
5 properties
GetAEBPackedItemDTO
object
Packed item
2 properties
GetAEBPartyDTO
object
Party/Partner
20 properties
GetAEBPersonDTO
object
Person
6 properties
GetAEBQuantityDTO
object
Quantity
3 properties
GetAEBTransportMeansDTO
object
Transport means
5 properties
GetAEBDeliveryRequestDTO
object
Request data for getting an AEBDelivery.
5 properties
UpdateAEBDeliveryResponseDTO
object
Response for updating/creating an AEBDelivery
6 properties
BSInteractionControlItemDTO
object
Item for interaction control
2 properties
BSInteractionControlItemIDDTO
object
The DTO for the item id of an interaction control.
3 properties
UpdateAEBAdditionalFieldDTO
object
Additional field to extend data of the business object where it is referenced.
2 properties
UpdateAEBClassificationDTO
object
Classification data
2 properties
UpdateAEBCostDTO
object
Cost data
3 properties
UpdateAEBDeliveryDTO
object
Delivery data for update
20 properties
UpdateAEBDeliveryItemDTO
object
Delivery item
20 properties
UpdateAEBDeliveryRequestDTO
object
Data for updating/creating an AEBDelivery
6 properties
UpdateAEBGoodsDescriptionDTO
object
Goods description
2 properties
UpdateAEBHandlingUnitDTO
object
Handling unit
17 properties
UpdateAEBInvoiceDTO
object
Invoice data
5 properties
UpdateAEBPackedItemDTO
object
Packed item
2 properties
UpdateAEBPartyDTO
object
Party/Partner
20 properties
UpdateAEBPersonDTO
object
Person
6 properties
UpdateAEBQuantityDTO
object
Quantity
3 properties
UpdateAEBTransportMeansDTO
object
Transport means
5 properties
BSMICCreateConsignmentResponseDTO
object
The DTO for the createConsignment-API response.
5 properties
ICConsignmentResultDTO
object
The result DTO which contains the information to the consignment created on the system.
5 properties
BSMICConsignmentDTO
object
DTO for a consignment.
14 properties
2 required
BSMICCreateConsignmentRequestDTO
object
The DTO for the request.
5 properties
BSMICDeliveryDTO
object
DTO for a delivery.
28 properties
2 required
BSMICDeliveryItemDTO
object
DTO for a delivery item.
34 properties
ClientSpecificFieldDTO
object
Represents a client specific declaration field. Client specific fields must be configured for the resulting declaration and are never intended to be used as ac…
3 properties
ClientSpecificFieldsDTO
object
Represents the container for client specific fields.
1 property
ICAdditionDeductionDTO
object
DTO to hold data for additions and deductions to a base value.
3 properties
ICAdditionalOperationCHDTO
object
DTO to hold data for EU produced documents.
6 properties
ICAdditionalReferenceDTO
object
DTO to hold data of a additional reference.
5 properties
ICAttachmentDTO
object
DTO to hold attachment data.
7 properties
ICAttachmentLinkDTO
object
DTO to hold link data.
2 properties
ICClassificationDTO
object
DTO to hold data for classification.
3 properties
ICCostDTO
object
DTO to hold data for costs.
4 properties
ICCurrencyRateDTO
object
DTO to hold data of currency rate.
2 properties
ICCustomsIdentifcationDTO
object
DTO to hold data for customs identification.
2 properties
ICCustomsOfficeDTO
object
DTO to hold data for a customs office.
3 properties
ICCustomsProcedureDTO
object
DTO to hold data for customs procedure codes
2 properties
ICCustomsSpecialProceduresDTO
object
DTO to hold data for customs special procedures.
2 properties
ICCustomsSpecialProceduresReferencesDTO
object
DTO to hold references to a booking request.
1 property
1 required
ICCustomsWarehouseItemReferenceDEDTO
object
DTO to hold specific item reference data for a customs warehouse termination.
8 properties
ICCustomsWarehouseTerminationDEDTO
object
Customs warehouse termination
2 properties
ICDeferredPaymentDTO
object
DTO to hold data for deferred payments.
3 properties
ICDeliveryBrokerDTO
object
DTO to hold Broker extension data for a ICDeliveryDTO.
1 property
ICDeliveryConsumerShipmentXIDTO
object
GB specific extension data for Consumer shipments items XI.
3 properties
ICDeliveryDTO
object
DTO to hold data of a delivery.
27 properties
2 required
ICDeliveryEUDTO
object
DTO to hold EU extension data for a ICDeliveryDTO.
7 properties
ICDeliveryExportCHDTO
object
DTO to hold CH extension data for a ICDeliveryDTO.
4 properties
ICDeliveryExportDEDTO
object
DTO to hold Export DE specific extension data for a ICDeliveryDTO.
12 properties
ICDeliveryExportUSDTO
object
DTO to hold Export US specific extension data for a ICDeliveryDTO.
10 properties
ICDeliveryExtensionDataDTO
object
DTO to hold delivery extension data for customs processes. Extension data is only required in some cases. Not all customs processes are supported.
33 properties
ICDeliveryGMRCHDTO
object
CH specific extension data for a goods movement record.
10 properties
ICDeliveryGVMSGBDTO
object
GB specific extension data for a goods movement record.
3 properties
ICDeliveryImportCHDTO
object
DTO to hold CH import extension data for a ICDeliveryDTO.
ICDeliveryImportDEDTO
object
DTO to hold Import DE specific extension data for a ICDeliveryDTO.
12 properties
ICDeliveryItemBrokerDTO
object
DTO to hold Broker specific extension data for a ICDeliveryItemDTO}.
2 properties
ICDeliveryItemConsumerShipmentXIDTO
object
GB specific extension data for Consumer shipments XI.
1 property
ICDeliveryItemDTO
object
DTO to hold data of a delivery item.
33 properties
ICDeliveryItemEUDTO
object
DTO to hold EU specific extension data for a ICDeliveryItemDTO.
5 properties
ICDeliveryItemExportCHDTO
object
DTO to hold CH specific extension data for a ICDeliveryItemDTO.
2 properties
ICDeliveryItemExportDEDTO
object
DTO to hold Export DE specific extension data for a ICDeliveryItemDTO.
8 properties
ICDeliveryItemExportUSDTO
object
DTO to hold US specific extension data for a ICDeliveryItemDTO.
6 properties
ICDeliveryItemExtensionDataDTO
object
DTO to hold delivery item extension data for customs processes. Extension data is only required in very rare cases. Not all customs processes are supported.
32 properties
ICDeliveryItemImportCHDTO
object
DTO to hold CH specific extension data for a ICDeliveryItemDTO.
ICDeliveryItemImportDEDTO
object
DTO to hold Import DE specific extension data for a ICDeliveryItemDTO.
12 properties
ICDeliveryItemIntrastatDEDTO
object
DTO to hold Intrastat DE specific extension data for a ICDeliveryItemDTO.
5 properties
ICDeliveryItemSTIDTO
object
DTO to hold STI specific extension data for a ICDeliveryItemDTO.
6 properties
ICDeliveryItemTransitEUDTO
object
Holds item data that is specific to the EU NCTS / transit processes.
2 properties
ICDeliverySTIDTO
object
DTO to hold STI specific extension data for a ICDeliveryDTO.
9 properties
ICDeliverySumDecWriteOffInfoDEDTO
object
DTO to hold the write off data for summary declaration assignment.
2 properties
ICDeliverySummaryDeclarationDEDTO
object
DTO to hold Summary Declaration DE specific extension data for a ICDeliveryDTO.
4 properties
ICDeliveryTransitEUDTO
object
Holds delivery data that is specific to the EU NCTS / transit processes.
3 properties
ICExtraFieldDTO
object
Represents an extra field (or additional field). Extra fields must be configured in ICI and linked to the customs process.
2 properties
ICFreeTemplateCriterionDTO
object
DTO to hold data of a party.
2 properties
ICGnssDTO
object
Global Navigation Satellite System data
2 properties
ICGuaranteeDTO
object
DTO to hold data of a guarantee.
5 properties
ICInvoiceDTO
object
DTO to hold data of an invoice.
5 properties
ICLicenseDTO
object
DTO to hold data of an license for a transaction.
10 properties
ICLicenseDataDTO
object
DTO to hold a list of an licenses.
1 property
ICLocationDTO
object
DTO to hold data of a location.
16 properties
ICMaterialDTO
object
DTO to hold data of a material.
1 property
1 required
ICPackageDTO
object
DTO to hold data of a package.
10 properties
ICPackedItemDTO
object
DTO to hold data of a packed item.
2 properties
ICPartyDTO
object
DTO to hold data of a party.
15 properties
ICPersonDTO
object
DTO to hold data of a person.
7 properties
ICPreferentialDataEUDTO
object
DTO to hold data for preferential request (EU).
1 property
ICPreviousDocumentDTO
object
DTO to hold data for previous documents.
9 properties
ICProducedDocumentBrokerDTO
object
DTO to hold data for produced documents.
11 properties
ICProducedDocumentEUDTO
object
DTO to hold data for EU produced documents.
15 properties
ICQuantityDTO
object
DTO to hold data for quantity.
2 properties
ICReturnsHandlingDTO
object
DTO to hold data related to a returns process.
3 properties
ICRoutingCountryDTO
object
DTO to hold data for a routing country.
2 properties
ICSealDTO
object
DTO to hold data for a seal.
1 property
ICTradeTermsDTO
object
DTO to hold data of trade terms.
5 properties
ICTransportEquipmentDTO
object
DTO to hold data of transport equipment.
3 properties
ICTransportMeansDTO
object
DTO to hold data for transport means.
6 properties
ICWarehouseDTO
object
DTO to hold data of customs warehouse.
3 properties
OutwardProcessingCommodityCodeFieldDTO
object
Represents a commodity code field for outward processing
2 properties
OutwardProcessingFieldDTO
object
Represents an outward processing field
5 properties
OutwardProcessingIdentificationMeansFieldDTO
object
Represents an identification means field for outward processing
2 properties
AcknowledgeEventsResponseDTO
object
Response DTO for acknowledging events.
4 properties
BSMAcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
7 properties
SyncEventDTO
object
DTO to hold data of one synchronized event.
7 properties
SyncEventsResponseDTO
object
Response DTO for synchronizing events.
8 properties
BSMSyncEventsRequestDTO
object
Request DTO for synchronizing events.
10 properties
GetPartnerSystemSubscriptionsResponseDTO
object
Response parameter with fetched partner system subscriptions to sync events.
5 properties
SyncPartnerSystemDTO
object
Identification and other data of a single partner system subscription.
3 properties
2 required
BSMGetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
6 properties
SubscribePartnerSystemResponseDTO
object
Response parameter of a partner system subscription to sync events.
5 properties
BSMSubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
7 properties
1 required
UnsubscribePartnerSystemResponseDTO
object
Response parameter of a partner system unsubscription from sync events.
5 properties
BSMUnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
6 properties
1 required
BFFunctionExistsDTO
object
Result DTO for the checkBusinessFacadeFunctionExists function
2 properties
BFFunctionDTO
object
Describe a API to be called.
2 properties
MonitoringDataProviderDTO
object
Data Transfer Object for monitoring provider
3 properties
ProductInfoDTO
object
This class holds various information items of the server which serves this request.
4 properties
VersionInfoDTO
object
This class holds version information about a solution or product in a server.
2 properties
RuntimeInfoDTO
object
This class holds various runtime information items of the server which serves this request.
16 properties
RuntimeStateResultDTO
object
This class holds various information items of the server which serves this request.
5 properties
RuntimeStateParmDTO
object
This class contains parameter about asking the server about its runtime state.
DLAddShipmentAttachmentsResponseDTO
object
Response DTO for the addShipmentAttachments business facade method
4 properties
DLAddShipmentAttachmentsRequestDTO
object
Request DTO for the addShipmentAttachments business facade method
7 properties
1 required
DLAttachmentDTO
object
DTO to hold attachment data.
4 properties
DLCancelShipmentResponseDTO
object
Response DTO for the cancelShipment business facade method
4 properties
DLCancelShipmentRequestDTO
object
Request DTO for the cancelShipment business facade method
6 properties
2 required
DLShipmentCancelParmsDTO
object
Parameters for the cancle operation for a shipment.
1 property
1 required
DLCreatePickupResponseDTO
object
Response DTO for the processPickup business facade method
6 properties
DLCreatePickupRequestDTO
object
Request DTO for the processPickup business facade method
7 properties
3 required
DLPickupCreationParmsDTO
object
Creation parameters for a shipment. Specifies when and how to create a pickup and the shipment it contains.
1 property
1 required
DLPickupProcessParmsDTO
object
Process parameters for a pickup. Especially controls the handling of the manifest documents.
3 properties
3 required
DLPickupRequestDataDTO
object
DTO for pickup data.
12 properties
5 required
DLSignatureDTO
object
DLSignatureDTO containing driver's signature data
3 properties
DLCreateShipmentRequestDTO
object
Request DTO for the createShipment business facade method
7 properties
3 required
DLDeleteItemResponseDTO
object
Response DTO for the deleteItem business facade method
4 properties
DLDeleteItemRequestDTO
object
Request DTO for the deleteItem business facade method
5 properties
1 required
DLDeletePackageResponseDTO
object
Response DTO for the deletePackage business facade method
4 properties
DLDeletePackageRequestDTO
object
Request DTO for the deletePackage business facade method
5 properties
1 required
DLPackageReferenceDTO
object
DTO for uniquely identifying a package. The context settings clientIdentCode and clientSystemId are also applied when filled.
3 properties
2 required
DLDeletePickupResponseDTO
object
Response DTO for the cancelPickup business facade method
4 properties
DLDeletePickupRequestDTO
object
Request DTO for the cancelShipment business facade method
5 properties
1 required
DLPickupReferenceDTO
object
DTO for uniquely identifying a shipment pickup within a client.
3 properties
DLCarrierListItemDTO
object
Minimum carrier info to use in lists.
5 properties
DLGetAllCarriersResponseDTO
object
Response DTO containing a list of available carrier for a client.
5 properties
DLGetAllCarriersRequestDTO
object
Request DTO to retrieve the codes and names of all available carriers for a client.
4 properties
DLAdditionalValueDTO
object
Information about an additional value defined for a carrier.
4 properties
DLCarrierBusinessDivisionDTO
object
Response information about the supported business Divisions from a carrier
2 properties
DLCarrierDespatchCountryDTO
object
Response information about the supported countries from a carrier
4 properties
DLCarrierExtendedInfosDTO
object
Response information for the extended Infos URL and WebLogo for the Carrier.
4 properties
DLCarrierInfoTextDTO
object
Information about an additional info text a carrier offers.
2 properties
DLCarrierNetworkDTO
object
Response information about the networks in which the carrier is involved.
2 properties
DLGetCarrierPortfolioDetailsResponseDTO
object
Response DTO for all available carriers with their detail information.
5 properties
DLGetCarrierPropertiesResponseDTO
object
Response DTO containing the properties of a specific carrier.
19 properties
DLServiceDTO
object
Information about a service a carrier offers.
8 properties
DLGetCarrierPortfolioDetailsRequestDTO
object
Response DTO for carrier properties for all carriers
5 properties
DLCarrierPortfolioNameDTO
object
DTO for the code and name of a carrier.
8 properties
DLGetCarrierPortfolioNamesResponseDTO
object
Response DTO containing the codes and names of all available carriers.
5 properties
DLGetCarrierPortfolioNamesRequestDTO
object
Request DTO to retrieve the codes and names of all available carriers.
5 properties
DLGetCarrierPropertiesRequestDTO
object
Request DTO to retrieve various properties for a specific carrier.
5 properties
1 required
DLGetPickupsResponseDTO
object
Data Transfer Object for pickup search result.
5 properties
DLPickupResponseDataDTO
object
DTO for response information of a DLShipmentPickup.
32 properties
DLShipmentPickupEDIDTO
object
Response-DTO for an EDI message for a pickup.
12 properties
DLGetPickupsRequestDTO
object
DTO to search for pickups and request detail information about them.
8 properties
DLPickupFilterDTO
object
DTO to set a filter for a pickup query.
14 properties
DLGetShipmentsResponseDTO
object
Data Transfer Object for shipment search result.
5 properties
DLGetShipmentsRequestDTO
object
DTO to search for shipments and request detail information about them.
8 properties
DLShipmentFilterDTO
object
DTO to set a filter for a shipment query.
11 properties
DLProcessPackageResponseDTO
object
Response DTO for the getPackageDocuments business facade method
8 properties
DLMasterPackageReferenceDTO
object
DTO for uniquely identifying a master package.
1 property
1 required
DLPackageDocumentPrepareModeDTO
object
DTO specifying the prepare mode for documents on package level.
1 property
1 required
DLPackageOperationModeDTO
object
Holds a special operation ID to be performed on the package. NOTE: this function has BETA status.
1 property
1 required
DLPackageProcessParmsDTO
object
Process parameters for a package. Specifies which operations have to be performed on a package.
5 properties
4 required
DLProcessPackageRequestDTO
object
Request DTO for the getPackageDocuments business facade method.
10 properties
2 required
DLProcessPackageUpdateRequestDataDTO
object
DTO for package fields which can be updated after the initial creation of the package
2 properties
1 required
DLProcessPackageReturnEnclosedLabelResponseDTO
object
Response DTO for the processPackageReturnEnclosedLabel business facade method
5 properties
DLPackageReturnEnclosedLabelProcessParmsDTO
object
Process parameters for a package enclosed return label. Specifies which operations have to be performed on a package return enclosed label.
2 properties
2 required
DLProcessPackageReturnEnclosedLabelRequestDTO
object
Request DTO for the processPackageReturnEnclosedLabel business facade method.
6 properties
2 required
DLReturnEnclosedLabelOutputModeDTO
object
DTO specifying the output mode for return enclosed labels.
1 property
1 required
DLProcessPickupResponseDTO
object
Response DTO for the printDocumentsForPickup business facade method
5 properties
DLPickupUpdateRequestDataDTO
object
DTO for pickup fields which can be updated after the initial creation of the pickup
1 property
DLProcessPickupRequestDTO
object
Request DTO for the printDocumentsForPickup business facade method
9 properties
2 required
DLProcessShipmentResponseDTO
object
Response DTO for the processShipment business facade method. For possible validation and preparation warnings and errors see DLCreateShipmentResponseDTO
10 properties
DLProcessShipmentRequestDTO
object
Request DTO for the processShipment business facade method
15 properties
2 required
DLShipmentUpdateRequestDataDTO
object
DTO for shipment fields which can be updated after the initial creation of the shipment
24 properties
DLSyncPickupsResponseDTO
object
Data Transfer Object for a pickup synchronize result.
7 properties
DLSyncPickupsRequestDTO
object
Request DTO for pickup synchronization.
8 properties
DLSyncShipmentsResponseDTO
object
Data Transfer Object for a shipment synchronize result.
7 properties
DLSyncShipmentsRequestDTO
object
Request DTO for shipment synchronization.
7 properties
DLUpdateCustomsDataResponseDTO
object
Response DTO for the updateCustomsData business facade method
4 properties
DLReferenceTextUCDDTO
object
DTO for reference numbers and texts of a certain (predefined) type.
2 properties
DLShipmentItemReferenceTextUCDDTO
object
DTO for reference numbers and texts of a certain (predefined) type. This is the same DTO like DLShipmentItemReferenceTextDTO, but supports fewer types.
2 properties
DLShipmentItemReferenceUCDDTO
object
DTO for uniquely identifying an item within a shipment.
2 properties
DLUpdateCustomsDataRequestDTO
object
Request DTO for the updateCustomsData business facade method
9 properties
1 required
DLUpdateCustomsItemRequestDataDTO
object
DTO for a few shipment item fields which can be updated after the initial creation of the shipment. This DTO includes customs data ONLY. No item net / gross we…
9 properties
1 required
DLUpdateCustomsShipmentRequestDataDTO
object
Request DTO for a few shipment fields which can be updated after the initial creation of the shipment.
3 properties
DLValidateShipmentResponseDTO
object
Possible Result Values: VALIDATIONFAILED VALIDATIONOK VALIDATIONREQUESTNOTSUPPORTED VALIDATIONMISSINGDATA VALIDATIONNOCHECKSELECTED VALIDATIONEXECUTIONERROR
5 properties
DLShipmentValidationParmsDTO
object
DTO class for shipment validation parameter request data. Possible validation modes: ROUTESERVED and SERVICECOMPLIANT
1 property
1 required
DLValidateShipmentRequestDTO
object
DTO class for shipment validation request data.
6 properties
2 required
AcknowledgeGetChangedTransactionsResponseDTO
object
Response for /ExportControl/v2/acknowledgeGetChangedTransactions .
4 properties
ErrorData
object
2 properties
AcknowledgeGetChangedTransactionsRequestDTO
object
Request to acknowledge changed results of EC check transactions.
5 properties
CheckTransactionResponseDTO
object
Represents a response of checking a transaction in Export Controls.
6 properties
ECApprovalInfoDTO
object
DTO representing an approval used in the current item to release a restriction or a required license.
7 properties
ECItemCheckResultDTO
object
The export control result for one item of the transaction.
4 properties
ECLicenseReferenceDTO
object
DTO used for referencing a real license and license item.
2 properties
ECLocalizedTextDTO
object
Encapsulates a text in one language.
2 properties
ECPluginCheckResultDTO
object
The export control result of a jurisdiction checked for a transaction item.
3 properties
CheckTransactionRAParmsDTO
object
Parameters to integrate Risk Assessment in an export control check.
4 properties
CheckTransactionRequestDTO
object
Represents a request to check a transaction in Export Controls. clientIdentCode and clientSystemId are mandatory fields. Client system ID "COMPLIANCE SERVER" i…
9 properties
2 required
CreateRAQuestionnaireDataDTO
object
Initial data for a new questionnaire.
5 properties
ECAmountDTO
object
A pair of a value with a currency.
2 properties
ECClassificationDTO
object
An attribute with a value for a transaction item.
2 properties
ECCompletionStatusDTO
object
The completion status of the product data for a specific jurisdiction.
2 properties
ECIdentityOfGoodsDTO
object
Specifies the identity of goods.
2 properties
ECItemDTO
object
One item of a transaction to be checked for export control restrictions.
22 properties
2 required
ECJurisdictionFilterDTO
object
Allows to filter (, i.e., restrict) the jurisdictions to consider in export control checks. This is possible in the following ways: Limiting filter mode (value…
2 properties
1 required
ECPartnerDTO
object
DTO for a partner (typically a company) related to this export process. A partner can be the seller, the buyer, the receiver the final user, ...
19 properties
1 required
ECTransactionDTO
object
Data about the transaction.
6 properties
2 required
CreateQuestionnaireForTransactionResponseDTO
object
The response to a request to explicitly create a questionnaire. Empty on success.
4 properties
CreateQuestionnaireForTransactionRequestDTO
object
A request to explicitly create a questionnaire for an EC check transaction.
8 properties
3 required
DeleteTransactionResponseDTO
object
Response of /ExportControl/v2/deleteTransaction .
4 properties
DeleteTransactionRequestDTO
object
Represents a request to delete a check transaction in Export Controls. clientIdentCode and clientSystemId are mandatory fields. Client system ID "COMPLIANCE SE…
5 properties
1 required
FinalizeApprovalResponseDTO
object
Response of /ExportControl/v2/finalizeApproval .
4 properties
FinalizeApprovalRequestDTO
object
Represents a request to finalize an approval in Export Controls. clientIdentCode is a mandatory field.
7 properties
3 required
GetChangedTransactionsRequestDTO
object
Request to get the changed results of EC check transactions.
4 properties
ECApprovalInfoV2DTO
object
DTO representing an approval used to release a restriction or a required license in a jurisdiction for a transaction item.
6 properties
ECItemCheckResultV2DTO
object
The export control result for one item of the transaction.
4 properties
ECPluginCheckResultV2DTO
object
The export control result of a jurisdiction checked for a transaction item.
3 properties
ECTransactionCheckResultV2DTO
object
The export control result for a whole transaction. Note that this DTO is inspired by ECTotalCheckResultDTO and CheckTransactionResponseDTO. There is no explici…
4 properties
GetChangedTransactionsResponseDTO
object
Response when getting the changed results of EC check transactions.
7 properties
GetTransactionCheckResultResponseDTO
object
Response when getting the check result of a certain EC check transaction.
6 properties
GetTransactionCheckResultRequestDTO
object
Request to get the check result of a certain EC check transaction.
5 properties
1 required
UpdateCustomsInfoResponseDTO
object
Response of /ExportControl/v2/updateCustomsInfo .
4 properties
UpdateCustomsInfoRequestDTO
object
Represents a request to update customs information in Export Controls. clientIdentCode is a mandatory field.
12 properties
3 required
AFExecuteProcessParmsDTO
object
Parameters of UI API invocation when this is to be done via create process: The client has to invoke the process as specified by the properties of this object.
3 properties
AFShellExecuteParmsDTO
object
Parameters of application UI API when this is to be done via shellexecute: The client has to create a file with the given name in a temporary directory, the co…
2 properties
ApplicationFacadeDTO
object
A data transfer object which describes an UI API. There are various techniques possible how to "open" the "application" on the client; typically only one of th…
5 properties
ApplicationFacadeParmsDTO
object
A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
16 properties
LogonResponse
object
5 properties
LogonArgument
object
4 properties
AcknowledgePublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
4 properties
AcknowledgePublishedDataFeedPartsRequestDTO
object
Request parameter for Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
5 properties
GetPublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
7 properties
PublishedDataFeedPartDTO
object
DTO to hold the data of a published data feed part.
9 properties
GetPublishedDataFeedPartsRequestDTO
object
Request parameter for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
4 properties
ExternalTMStatusResponseDTO
object
Response DTO for ExternalTelemetryBFBean/getStatus & ExternalTelemetryBFBean/status.
8 properties
ExternalTMIdentificationRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
6 properties
ExternalTMResponseDTO
object
Response DTO for all calls to ExternalTelemetryBFBean.
10 properties
ExternalTMRDateEntryDTO
object
telemetry report entry for date values
3 properties
ExternalTMRDoubleEntryDTO
object
telemetry report entry for string double
3 properties
ExternalTMRIntegerEntryDTO
object
telemetry report entry for integer values
3 properties
ExternalTMRLongEntryDTO
object
telemetry report entry for long values
3 properties
ExternalTMRStringArrayEntryDTO
object
telemetry report entry for string array values
3 properties
ExternalTMRStringEntryDTO
object
telemetry report entry for string values
3 properties
ExternalTMReportRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
8 properties
ExternalTelemetryReportDTO
object
report dto to ship the telemetry data to an XNSG engine
6 properties
AcknowledgeFileResponseDTO
object
Contains the result for an acknowledge file request.
2 properties
AcknowledgeFileRequestDTO
object
Contains information about the result of a file transfer
3 properties
SimpleFileDTO
object
Meta-data for a transfer file
2 properties
AnnounceStopResultDTO
object
the result of the announce stop API
AnnounceStopParmDTO
object
parameter necessary to announce a stop of the server
3 properties
CancelAnnounceStopResultDTO
object
Contains the result information of the cancel announce stop bf
CancelAnnounceStopParmDTO
object
parameter necessary to cancel an announced stop
ChangeAdminPasswordResultDTO
object
Contains the result information of the change admin password bf
1 property
ChangeAdminPasswordParmDTO
object
This class contains the old and the new admin password
2 properties
CreateClientResponseDTO
object
encapsulates the response parameters
1 property
CreateClientRequestDTO
object
encapsulates the request parameters
3 properties
ActivationDataFlavor
object
2 properties
CommandInfo
object
2 properties
CommandMap
object
1 property
DataHandler
object
The content of a file
10 properties
DataSource
object
4 properties
DownloadFileResponseDTO
object
Contains the result for a download file request
3 properties
FileDTO
object
Data Transfer Object for a file.
7 properties
DownloadFileRequestDTO
object
Contains information on how to select a file for transferring
4 properties
TransferFileParameterDTO
object
A generic parameter for use-case specific information
2 properties
GenerateClientIdentCodeRequestDTO
object
encapsulates the request parameters
2 properties
ClientDTO
object
DTO representing an XNSG Client.
6 properties
DLFilesRefsResponseDTO
object
Contains the result for a request to get the number of files available for download
3 properties
DLFilesRefsRequestDTO
object
Contains information on how to select files for transferring
3 properties
ScriptExecutionRowDTO
object
This dto contains the data of a single line in script result
2 properties
ScriptExecutionStateResultDTO
object
Contains the result information of the script execution bf
4 properties
ScriptExecutionStateParmDTO
object
parameters necessary to ask the server for the current state of the script execution
1 property
TableUpdateStateResultDTO
object
Contains the result information of the get table update state bf
5 properties
TableUpdateStateParmDTO
object
the parameter necessary to ask the server for the current state of the table update
UploadSettingsResponseDTO
object
retrieves the server settings for uploading files via SFT interface
3 properties
UploadSettingsRequestDTO
object
retrieves the server settings for uploading files via SFT interface
2 properties
MessageDataDTO
object
resulting user tip for one locale
3 properties
PublishMessageResponseDTO
object
Contains ids of user tips that were created, or error messages
1 property
LinkDTO
object
links associated with the tip
3 properties
MessageTextsDTO
object
locale specific data of the user tip. key is the language iso code.This language must be defined, or tip is not created.
7 properties
PublishMessageRequestDTO
object
the for user tip, possibly in several locales
14 properties
RoleInfoDTO
object
dto for roles
9 properties
SendMailResultDTO
object
Contains the result of the sendMail method.
2 properties
SendMailAttachmentParmDTO
object
Contains an attachment for an email.
3 properties
SendMailParmDTO
object
Parameter necessary for sending a mail
9 properties
StartScriptExecutionResultDTO
object
result of start script execution
3 properties
StartScriptExecutionParmDTO
object
parameters for start script execution
4 properties
StartTableUpdateResultDTO
object
Contains the result information of the start table update bf
StartTableUpdateParmDTO
object
parameter necessary for the table update
SystemSearchResultDTO
object
DTO contained in the result array of systemSearch function
7 properties
SystemSearchParameterDTO
object
DTO used as argument to systemSearch function
3 properties
UploadFileResponseDTO
object
Contains the result for a upload file request.
2 properties
UploadFileMultiPartRequestDTO
object
Contains information on how a transmitted file should be processed
9 properties
RoleDTO
object
data about a role
6 properties
RoleTextDTO
object
language dependent values of a role
2 properties
RolesOfClientDTO
object
Response DTO for listing roles assignable to users of a client.
2 properties
ClientRolesDTO
object
Response DTO for listing client specific roles in GetRolesResponseDTO.
2 properties
GetRolesResponseDTO
object
DTO for GetRoles response
6 properties
AcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
6 properties
SyncEventsRequestDTO
object
Request DTO for synchronizing events.
9 properties
GetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
5 properties
SubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
6 properties
1 required
UnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
5 properties
1 required
ICAcknowledgeGetChangedDeclarationsResponseDTO
object
Response for IInternationalCustomsBFacknowledgeGetChangedDeclarations
4 properties
ICAcknowledgeGetChangedDeclarationsRequestDTO
object
Request parameter for IInternationalCustomsBFacknowledgeGetChangedDeclarations
6 properties
ICAddDeclarationAttachmentsResponseDTO
object
Result data for the add-declaration-attachments operation.
4 properties
ICAddDeclarationAttachmentsRequestDTO
object
Body data for adding one or more attachments to a declaration.
8 properties
ICCancelConsignmentResponseDTO
object
The response dto of the cancellation of consignments or consignment manifests.
5 properties
ICCancelConsignmentRequestDTO
object
Body data for the cancellation of a consignment or consignment manifest.
9 properties
ICCancelDeclarationResponseDTO
object
The response dto for cancellation of declarations.
5 properties
ICCancelDeclarationRequestDTO
object
The request dto for the cancellation of declarations BF.
9 properties
2 required
ICCustomsProcessTypeDTO
object
DTO to hold the customs process type.
2 properties
ICCreateConsignmentResponseDTO
object
The response DTO after processing the request. Contains the resulting consignment DTO.
5 properties
ICConsignmentDTO
object
DTO to hold data of a consignment.
12 properties
2 required
ICCreateConsignmentRequestDTO
object
The DTO for the request.
5 properties
1 required
ICConsignmentManifestResultDTO
object
Data of the manifest created.
4 properties
ICCreateConsignmentManifestResponseDTO
object
The response DTO after processing the request. Contains the resulting consignment DTO.
5 properties
ICAdditionalDeliveryDataDTO
object
DTO to hold data of a delivery that augment the original delivery data.
9 properties
ICConsignmentForManifestDTO
object
Data to reference an existing consignment.
1 property
1 required
ICConsignmentManifestDTO
object
Structure of a consignment manifest. Additional data for - and references to existing consignments.
10 properties
2 required
ICCreateConsignmentManifestRequestDTO
object
Body data for creating a consignment manifest.
5 properties
1 required
ICManifestDeliveryExtensionDataDTO
object
DTO to hold additional delivery extension data for customs processes. Extension data is only required in very rare cases. Not all customs processes are support…
7 properties
ICManifestDeliveryExtensionGVMSBG
object
GB specific extension data for a goods movement record.
3 properties
ICManifestDeliveryExtensionICS
object
DTO to hold extension data for import control processes.
1 property
ICManifestDeliveryExtensionSTI
object
DTO to hold extension data for import control processes 2 (STI).
3 properties
ICCreateDeliveryResponseDTO
object
The response DTO after processing the request. Contains the resulting delivery information.
5 properties
ICDeliveryResultDTO
object
The result DTO which contains the information to the delivery created on the system.
4 properties
ICCreateDeliveryRequestDTO
object
The DTO for the request.
5 properties
1 required
ICAmountOfMoneyDTO
object
DTO to hold data representing an amount.
2 properties
ICBrokerDeclarationDTO
object
DTO to hold data for customs broker declaration
11 properties
ICBrokerInstructionDTO
object
DTO to hold data for customs broker instruction
11 properties
ICBusinessObjectStatusDTO
object
DTO to hold data of a status.
4 properties
ICCustomsControlMeasureDTO
object
DTO to hold information about control measures.
4 properties
ICDeliveryReferencesDTO
object
DTO to hold data of a delivery that has been transitioned into the declaration.
2 properties
ICGetBrokerDeclarationsResponseDTO
object
Response containing requested declarations.
5 properties
ICGetBrokerDeclarationsRequestDTO
object
Request for broker declaration data.
8 properties
ICAdditionalFiscalReferenceDTO
object
Data for additional fiscal references
2 properties
ICCustomsBrokerDeclarationDTO
object
DTO to hold data for customs broker declaration
1 property
ICDateDTO
object
DTO to hold data representing an date with optional time.
2 properties
ICDeclarationBrokerDTO
object
Broker specific extension data for a declaration.
3 properties
ICDeclarationCHDTO
object
CH specific extension data for a declaration.
6 properties
ICDeclarationDTO
object
DTO to hold data of a declaration.
44 properties
ICDeclarationExtensionDataDTO
object
DTO to hold declaration extension data for customs processes. Not all customs processes are supported.
11 properties
ICDeclarationGBDTO
object
GB specific extension data for a declaration.
11 properties
ICDeclarationItemCHDTO
object
CH specific extension data for a declaration item.
9 properties
ICDeclarationItemDTO
object
DTO to hold data of a declaration item.
14 properties
ICDeclarationItemExtensionDataDTO
object
DTO to hold declaration item extension data for customs processes. Not all customs processes are supported.
6 properties
ICDeclarationItemSpecialProceduresDTO
object
DTO to hold a declaration item's data for customs special procedures.
1 property
ICDeclarationItemTransitArrivalDTO
object
Transit arrival specific extension data for a declaration item.
1 property
ICDeclarationPackageDTO
object
DTO to hold data of a package for a declaration item.
4 properties
ICGetChangedDeclarationsResponseDTO
object
Response (result) for IInternationalCustomsBFgetChangedDeclarations.
7 properties
ICHouseConsignmentDTO
object
Extension data for a house consignment.
4 properties
ICLinkedProcessInfoDTO
object
DTO to hold data of a customs process that is linked to the main declaration object.
3 properties
ICReferencedItemDTO
object
Referenced item data for a house consignment.
2 properties
ICTransitDeclarationDTO
object
Extension data for a transit.
1 property
ICGetChangedDeclarationsRequestDTO
object
Request parameter for IInternationalCustomsBFgetChangedDeclarations
6 properties
ICCodeDTO
object
The DTO object containing information of a code and its descriptions in given languages.
2 properties
ICGetCodesResponseDTO
object
Response for the requested code list.
5 properties
ICGetCodesRequestDTO
object
Request for a desired code list.
7 properties
2 required
ICConsignmentInfoDTO
object
Information about an existing consignment.
2 properties
ICGetConsignmentsOfManifestResponseDTO
object
Response containing consignments of a manifest
5 properties
ICGetConsignmentsOfManifestRequestDTO
object
Body for requesting consignments of a manifest
6 properties
ICGetDeclarationAttachmentsResponseDTO
object
Response containing requested attachments.
5 properties
ICGetDeclarationAttachmentsRequestDTO
object
Request for declaration attachments.
7 properties
ICGetDeclarationsResponseDTO
object
Response containing requested declarations.
5 properties
ICGetDeclarationsRequestDTO
object
Request for declaration data.
9 properties
ICSendDeclarationMessageResponseDTO
object
Result data for the send-declaration-message operation.
4 properties
ICSendDeclarationMessageRequestDTO
object
Body data containing references to declarations that shall be sent to customs.
8 properties
1 required
ICSetDeclarationAttachmentsStatusResponseDTO
object
The response DTO after setting an attachment status.
4 properties
ICSetDeclarationAttachmentsStatusRequestDTO
object
The request DTO to set the status of an attachment.
9 properties
LISDateAndZoneDTO
object
Contains a date and a timezone.
2 properties
TargetTimeCalculationDiagnosisLogDTO
object
Diagnosis log data of a plan, identified by hostcode
2 properties
TargetTimeCalculationPlanResultDTO
object
Result of a target time calculation
7 properties
TargetTimeCalculationPlanResultStepDTO
object
A single step of a target time calculation, identifiable by sequence number or host code
6 properties
TargetTimeCalculationResponseDTO
object
Response of a target time calculation
6 properties
LISLocationDTO
object
DTO for a location.
6 properties
LISPartyShortDTO
object
Data transfer object to denote parties, e.g. buyer or seller, without address data.
5 properties
TargetTimeCalculationPlanDTO
object
A plan for a target time calculation. A plan represents a route or a chain of steps that will be calculated successively.
6 properties
1 required
TargetTimeCalculationPlanStepDTO
object
A step of a target time calculation plan
5 properties
TargetTimeCalculationPlanStepHandlingDTO
object
Handling data of a target time calculation step
2 properties
TargetTimeCalculationPlanStepTransportDTO
object
Transport data of a target time calculation step
7 properties
TargetTimeCalculationRequestDTO
object
Request for target time calculation of multiple plans.
6 properties
ContactDTO
object
Contains data for contacting a person.
4 properties
LISExpConsignmentList20DTO
object
A list of consignments e.g. as result of a search.
2 properties
LISExpConsignmentListEntry20DTO
object
An entry in a consignment list e.g. retrieved by a search request. A consignment list entry is similar to a consignment head DTO, but contains only a small sub…
4 properties
LISExpStatus20DTO
object
DTO to export status data
4 properties
LISExpTrackingInfo20DTO
object
DTO to deliver tracking information for a tracking object
7 properties
LISPartyLongDTO
object
Data transfer object for parties that contain contact information
18 properties
LISConsignmentRequest20DTO
object
DTO with parameters to request a list of consignments
10 properties
3 required
LISRequestIdentification20DTO
object
DTO suppliying the identification information for making requests.
3 properties
3 required
GetDocumentCategoriesResponseDTO
object
Response for a document categories request.
5 properties
LISExpMODocumentCategoryDTO
object
A single document category.
2 properties
LISExpMODocumentCategoryIdentifierDTO
object
A unique identifier for a document category.
1 property
LISExpMODocumentCategoryTextDTO
object
Texts for a document category
3 properties
1 required
GetDocumentCategoriesRequestDTO
object
Response for a document categories request.
4 properties
LISEventDefinition20DTO
object
Event Definition data
4 properties
LISEventDefinitionRequest20DTO
object
Contains alle fields that are necessary to return a collection of LISEventDefinition20DTO's
3 properties
GetMODocumentDTO
object
Data transfer object for a document.
9 properties
GetMODocumentResponseDTO
object
Data Transfer Object for a get document result.
5 properties
GetMODocumentRequestDTO
object
Data transfer object to request one or several documents.
5 properties
1 required
LISDespatchTypeDTO
object
DTO for the despatch type.
2 properties
LISExpDocumentMetadata20DTO
object
DTO to provide the meta data of documents that are connected to the higher level structure.
6 properties
LISExpMODocument20DTO
object
DTO to export document data to partner systems like the Message Engine Logistics. @see LISBinaryDTO
6 properties
LISExpTrackingEvent20DTO
object
DTO to export trackingevent data to partner systems like the Message Engine Logistics.
22 properties
LISOFSTransport20DTO
object
DTO containing the data for an order fulfillment step of type transport
6 properties
LISOrderFulfillmentPlan20DTO
object
DTO representing an order fulfillment plan
4 properties
LISOrderFulfillmentResult20DTO
object
Result DTO for an order fulfillment request
1 property
LISOrderFulfillmentStep20DTO
object
Abstract DTO as a superclass for classes representing steps in an order fulfillment plan
7 properties
LISPartyDTO
object
Data transfer object to denote parties, e.g. buyer, seller, with full address data.
17 properties
LISQuantityDTO
object
DTO denoting a quantity
4 properties
LISServiceTypeDTO
object
DTO denoting a serivce type of forwarders
2 properties
LISTransportTypeDTO
object
DTO for transport types
1 property
LISOrderFulfillmentRequest20DTO
object
DTO for order fulfillment plan requests. Version 2.0
6 properties
LISAdditionalFieldDTO
object
DTO to implement additional fields not found in the standard DTOs The fields can have any name or value, but the target system must know how to handle these fi…
2 properties
LISAmountOfMoneyDTO
object
An amount of mone with a value and a currency
5 properties
LISDimensionsDTO
object
DTO for Dimensions length, width, height and a quantity unit.
4 properties
LISEquipmentTypeDTO
object
DTO for equipment types
2 properties
LISExpConsignmentHead20DTO
object
The consignment header data to be sent to a partner system.
54 properties
LISExpConsignmentItem20DTO
object
The consignment item data to be sent to a partner system
40 properties
LISExpHandlingUnit20DTO
object
The handling unit data to be sent to a partner system
26 properties
LISExpHandlingUnitHazardousGoodsData20DTO
object
DTO that contains hazardous goods data.
2 properties
LISExpHazardousGoodsItem20DTO
object
This DTO describes a hazardous goods item.
36 properties
LISExpOrderHead20DTO
object
The head of a order. Information in the head applies to all items, unless corresponding item fiels are not null, i.e. explicitly different from the head.
20 properties
LISExpOrderItem20DTO
object
An item of a purchase order.
38 properties
LISExpQuickSearchResult20DTO
object
Contains the result of a quick search.
7 properties
LISExpTransportHead20DTO
object
DTO to export transport data to partner systems like the Message Engine Logistics.
48 properties
LISMaterialDTO
object
DTO which references a material
19 properties
LISMeansOfTransportDTO
object
DTO for means of transports.
5 properties
LISTermsOfDeliveryDTO
object
Describes terms of delivery.
4 properties
LISWarehouseDTO
object
DTO denoting a particular warehouse
8 properties
LISQuickSearchRequest20DTO
object
The request parameters for a quick search.
4 properties
2 required
LISExpHUTransportLeg20DTO
object
DTO to export handling unit transport data to partner systems like the Message Engine Logistics.
37 properties
LISExpTrackingEventList20DTO
object
A list of exported LISExpTrackingEventListEntry20DTO's
2 properties
LISExpTrackingEventListEntry20DTO
object
The event header for the export to a partner system.
7 properties
LISTrackingEventExportRequest20DTO
object
The request DTO for a tracking event export
8 properties
1 required
LISExpTrackingObjectEventList20DTO
object
DTO to export the events of a tracking object to partner systems like the Message Engine Logistics.
1 property
LISTrackingObjectEventRequest20DTO
object
DTO with parameters to request the tracking events for a specific tracking object
2 properties
LISTrackingObjectReference20DTO
object
DTO for reference numbers. Every DTO should have all information to find a specific object of a certain class.
2 properties
LISTrackingObjectReferenceField20DTO
object
DTO for a single reference field with fieldName and the number
2 properties
LISExpConsItemInHandlingUnit20DTO
object
DTO to export consigment item in handling units data to partner systems like the Message Engine Logistics.
3 properties
LISExpConsignment20DTO
object
DTO to export consignment data to partner systems like the Message Engine Logistics.
11 properties
LISUniqueConsignmentRequest20DTO
object
DTO with parameters to request details for a specific consignment
3 properties
LISAreaDependScheduleDTO
object
DTO for TTCSAreaDependSchedule.
3 properties
LISAreaDependScheduleFilterConsignmentDTO
object
DTO for consignment AreaDependScheduleFilters
7 properties
LISAreaDependScheduleFilterHandlingUnitDTO
object
DTO for handling unit AreaDependScheduleFilters
7 properties
LISAreaDependScheduleFilterLCHandlingDTO
object
DTO for handling AreaDependScheduleFilters
7 properties
LISAreaDependScheduleFilterLCStorageDTO
object
DTO for storage AreaDependScheduleFilters
7 properties
LISAreaDependScheduleFilterOrderDTO
object
DTO for order AreaDependScheduleFilters
7 properties
LISAreaDependScheduleFilterOrderItemDTO
object
DTO for order item AreaDependScheduleFilters
7 properties
LISAreaDependScheduleFilterTransportDTO
object
DTO for transport AreaDependScheduleFilters
7 properties
LISAreaDependScheduleHeadDTO
object
DTO for main data of TTCSAreaDependSchedule.
9 properties
LISDayTypeScheduleDTO
object
DTO for day type schedules.
5 properties
LISDurationDTO
object
DTO for Duration
3 properties
LISMessageMetaDataDTO
object
Meta data of a message
9 properties
7 required
LISPeriodicStartScheduleDTO
object
DTO for Peridodic start schedules
3 properties
LISTimeDTO
object
Contains a time.
1 property
LISTrackingObjectFilterConsignmentDTO
object
DTO for TOFConsignment
14 properties
LISTrackingObjectFilterHandlingUnitDTO
object
DTO for CTOFHandlingUnit.
3 properties
LISTrackingObjectFilterLCHandlingDTO
object
DTO for TOFLCHandling. Note for the location: Only 'countryISOCode', 'globLocationNo', and 'postcodeStreet' are relevant for the filter.
2 properties
LISTrackingObjectFilterLCStorageDTO
object
DTO for TOFLCStorage. Not for the location: Only 'countryISOCode', 'globLocationNo', and 'postcodeStreet' are relevant for the filter.
2 properties
LISTrackingObjectFilterOrderDTO
object
DTO for CTOFOrder
3 properties
LISTrackingObjectFilterOrderItemDTO
object
DTO for CTOFOrderItem
10 properties
LISTrackingObjectFilterTransportDTO
object
DTO for CTOFTransportLeg
11 properties
LISArchiveDocumentDTO
object
DTO for document data that has been stored in an archive system e.g. Assist4ContentStorage and shall be accessed via VCP
8 properties
LISBinaryDTO
object
DTO for binaries e.g. document, images.
7 properties
LISBinaryRoleDTO
object
A single binary role.
1 property
LISConsItemInHandlingUnit20DTO
object
This DTO connects a consignment and handling unit. This means that the consignment item can be found in the defined handling unit.
5 properties
LISConsignment20DTO
object
DTO for consigment messages Version 2.0
9 properties
LISConsignmentHead20DTO
object
Header data of the consignment. Valid for all items unless redefined there. Version 2.0 Renamed fields compared to 1.0: suppliersRefNumberForwarder = shipperRe…
58 properties
LISConsignmentItem20DTO
object
This DTO describes a consignment item.
45 properties
LISHUTrackingEventExternalTargetDateDTO
object
DTO containing the event code of a milestone and new target date for this milestone. Additionally a reference to a transport as it is connected to a handling u…
3 properties
LISHandlingUnit20DTO
object
This DTO describes a handling unit as send e.g. with the EANCOM message DESADV.
28 properties
LISHandlingUnitHazardousGoodsData20DTO
object
DTO that contains hazardous goods data.
2 properties
LISHazardousGoodsItem20DTO
object
This DTO describes a hazardous goods item.
36 properties
LISMODocumentCategoryDTO
object
A single binary document category.
1 property
LISTrackingEventExternalTargetDateDTO
object
DTO containing the event code of a milestone and new target date for this milestone.
2 properties
LISConsignmentWithTransports20DTO
object
DTO for a consignment with all transports.
10 properties
LISTransport20DTO
object
A transport message sent by the supplier or buyer. It is usually sent to a forwarder to request the transportation of goods. Version 2.0
5 properties
LISTransportHead20DTO
object
DTO for transport legs.
52 properties
LISEventCodeListDTO
object
DTO for an event code list
3 properties
LISEventCodeListEntryDTO
object
This DTO describes a eventCodeList entry.
3 properties
LISEventCodeListHeadDTO
object
Header data of the event code list.
2 properties
LISHandlingUnitExt20DTO
object
Extension class for LISHandlingUnit20DTO that adds additional fields so that the resulting LISHandlingUnitExt20DTO can be used stand alone and independent from…
45 properties
LISHandlingUnitReceiveRequest20DTO
object
RequestDTO for handling of handling units, used in ILISBF20.
4 properties
LISHandlingUnitWrapper20DTO
object
DTO that bundles a handling unit together to documents.
3 properties
LISMaterialMasterFileDTO
object
DTO for the master file materials.
2 properties
LISMaterialMasterFileHeadDTO
object
DTO for the material master file items.
30 properties
1 required
LISTextTranslationDTO
object
DTO for text translations.
1 property
LISTextTranslationItemDTO
object
DTO for a single text translation. E.g. the german translation of a material description.
2 properties
LISFileSystemDocumentDTO
object
DTO for document data which has already been stored in the file system
9 properties
LISFileSystemSettingsReferenceDTO
object
The reference to file system storage settings in the VCP
2 properties
LISMultiReferenceTrackingObjectDocuments20DTO
object
A document message for multiple tracking objects. @see LISTrackingObjectDocuments20DTO
5 properties
LISOrder20DTO
object
DTO for order messages Version 2.0
7 properties
LISOrderHead20DTO
object
The head of a order. Information in the head applies to all items, unless corresponding item fields are not null, i.e. explicitly different from the head. An o…
31 properties
LISOrderItem20DTO
object
An item of an order.
50 properties
LISPhysicalTransport20DTO
object
Phyiscal transport message.
7 properties
LISPhysicalTransportHead20DTO
object
DTO for physical transport.
33 properties
LISTransportUnitHead20DTO
object
DTO for transport units
33 properties
LISCESDocumentDTO
object
DTO for document data that has been stored in a CES partner server and shall be accessed via VCP
11 properties
LISTrackingEvent20DTO
object
DTO for Tracking events (envelope)
7 properties
LISTrackingEventHead20DTO
object
DTO for main tracking event data
10 properties
LISTrackingEventReference20DTO
object
DTO for reference numbers. Every DTO should have all informations to find one or more TrackingObjects of a certain class. To find the matching tracking object…
3 properties
LISTrackingEventReferenceField20DTO
object
DTO for a single reference field with fieldName and the number
2 properties
LISTrackingEventUpdateField20DTO
object
Class to hold values for updates of the tracking objects generically with fieldname
2 properties
LISTrackingEventList20DTO
object
DTO to receive a list of tracking events
5 properties
LISTrackingObjectDocuments20DTO
object
A document message for a tracking object.
5 properties
LISTransportUnit20DTO
object
A transport unit message send by a partner.
4 properties
LISConsignmentReferenceWithClientDTO
object
Reference fields for identifying a LISConsignment.
3 properties
LISConsignmentSyncResponseDTO
object
Data Transfer Object for a consignment synchronize result.
7 properties
LISConsignmentSyncRequestDTO
object
Request DTO for consignment synchronization.
6 properties
Company
object
A complete address of a company.
24 properties
3 required
CompanyRole
object
A role of a company. Company roles are domain specific characteristics and can differ between the different AEB services.
2 properties
1 required
CompanyPage
object
2 properties
2 required
CompanyRoleList
object
1 property
1 required
ONPMaterialMasterDataSearchDTO
object
Filter Parameters for the material master data search
1 property
ONPMaterialMasterDataSearchRequestDTO
object
Request for the material data search.
2 properties
DeclarationOfOriginItemResponseDTO
object
The item response for a declaration of origin request.
5 properties
DeclarationOfOriginResponseDTO
object
The response data for a declaration of origin request.
9 properties
DeclarationOfOriginItemRequestDTO
object
The item data of a request for the declaration of origin.
7 properties
DeclarationOfOriginRequestDTO
object
With these parameters it is possible to request a declaration of origin
26 properties
AcknowledgeGetChangedMaterialMasterDataResponseDTO
object
Response of acknowledge the changed MaterialMasterData (Limits)
4 properties
AcknowledgeGetChangedMaterialMasterDataRequestDTO
object
DTO to acknowledge the changed MaterialMasterData (Limits) via last handled syncId
5 properties
GetChangedMaterialMasterDataResponseDTO
object
Response DTO for the changed MaterialMasterData (Limits)
7 properties
MaterialMasterDataDTO
object
DTO of content of MaterialMasterData (Limits)
25 properties
GetChangedMaterialMasterDataRequestDTO
object
DTO to request the changed MaterialMasterData (Limits)
4 properties
GetMaterialMasterDataResponseDTO
object
Response DTO for MaterialMasterData (Limits)
5 properties
GetMaterialMasterDataRequestDTO
object
DTO to request MaterialMasterData (Limits)
9 properties
TransferBusinessObjectResponseDTO
object
Response DTO for transfer a business object
4 properties
TransferBusinessObjectsResponseDTO
object
Response DTO for transfer a list of a business objects
5 properties
TransferAddressRequestDTO
object
Request DTO to transfer the address data (Customer,Vendor)
33 properties
TransferAddressesRequestDTO
object
Request DTO to transfer a list of a addresses
5 properties
TransferBillOfMaterialItemRequestDTO
object
Request DTO to transfer the item data of a bom
14 properties
TransferBillOfMaterialRequestDTO
object
Request DTO to transfer the head data of a bom
25 properties
TransferBillOfMaterialsRequestDTO
object
Request DTO to transfer a list of a boms
5 properties
TransferGoodsReceiptItemRequestDTO
object
Transfer DTO for goods receipt item
19 properties
TransferGoodsReceiptRequestDTO
object
Request DTO to transfer goods receipts
15 properties
TransferGoodsReceiptsRequestDTO
object
Request DTO to transfer a list of a goods receipt
5 properties
TransferMaterialDescriptionRequestDTO
object
Request DTO to transfer the material description
3 properties
TransferMaterialRequestDTO
object
Request DTO to transfer the material
29 properties
TransferMaterialsRequestDTO
object
Request DTO to transfer a list of a materials
5 properties
TransferQuantityDTO
object
DTO to transfer a quantity with a type
2 properties
TransferPurchaseOrderItemRequestDTO
object
Transfer DTO for purchase order item
16 properties
TransferPurchaseOrderRequestDTO
object
Request DTO to transfer purchase order
11 properties
TransferPurchaseOrdersRequestDTO
object
Request DTO to transfer a list of a purchase orders
5 properties
TransferSalesOrderItemRequestDTO
object
Transfer DTO for sales order item
14 properties
TransferSalesOrderRequestDTO
object
Request DTO to transfer sales order
11 properties
TransferSalesOrdersRequestDTO
object
Request DTO to transfer a list of a sales orders
5 properties
DesktopAgentInfo
object
16 properties
LauncherInfo
object
2 properties
PerfMonitoringInfo
object
3 properties
ProcessInfo
object
6 properties
SessionInfo
object
1 property
TracingInfo
object
6 properties
WorkstationSessionInfoDTO
object
3 properties
WorkstationAgentConnectionTimeouts
object
4 properties
CreateRoutingTaskResponseDTO
object
Response DTO for create routing rask.
5 properties
BillingAdditionalFreightCalculationDataDTO
object
The BillingAdditionalFreightCalculationDataDTO provides data to send to Logistics Costs Management. It fills some fields BFreightTransportExtendedDataDTO, but…
7 properties
CreateRoutingTaskRequestDTO
object
Request DTO for create routing task.
5 properties
1 required
CuboidDimensionsDTO
object
Dimensions of a cuboid with length, width, height and quantityUnit.
4 properties
CusBillingFieldDTO
object
This is a standard DTO class, which holds customized content. Custom field dto, send to Logistics Cost Management. Must also be defined in Logistics Cost Manag…
3 properties
3 required
DangerousGoodsCodeDTO
object
Information about dangerous goods.
1 property
1 required
HopReferenceDTO
object
Representation of a handover point as a defined entity
1 property
1 required
RoutingAddressDTO
object
DTO to provide address data
7 properties
5 required
RoutingParmsDTO
object
Detailed settings for proposal, supplement and ranking calculations.
1 property
RoutingPartyDTO
object
A party contains a company with information on the address of the given party. Furthermore, the company fulfills one or more certain roles within the routing c…
2 properties
2 required
RoutingRequirementDTO
object
Representation of a requirement, classified by a requirement type and a requirement code. This DTO is used in context of creating a RoutingTasks.
2 properties
2 required
RoutingTaskDTO
object
The RoutingTaskDTO is the main representation of a routing task. The data describes a set of different handling units which shall be transported in one process…
18 properties
4 required
RoutingTaskHandlingUnitDTO
object
Basic data of a handling unit which shall be transported as defined in the RoutingTaskDTO.
5 properties
4 required
RoutingTaskLocationDTO
object
Class for location based routing task data for BF. Contains data of a complete address or a reference to a hand over point and its location/address in the mast…
2 properties
CreateSupplementTaskResponseDTO
object
Response DTO for create supplement task.
5 properties
CreateSupplementTaskRequestDTO
object
Request DTO for create supplement task.
5 properties
1 required
ServiceDTO
object
Representation of a service classified by a service code, a provider code and value-added service codes. This DTO is used in context of creating a SupplementTa…
3 properties
2 required
SupplementTaskDTO
object
The SupplementTaskDTO is the main representation of a supplement task. The data describes a set of different handling units which shall be transported in one p…
18 properties
5 required
CarrierDTO
object
Representation of a carrier.
3 properties
1 required
GetAllCarriersResponseDTO
object
ResponseDTO for an access request of carriers.
5 properties
ServiceInfoDTO
object
DTO to provide service data
1 property
1 required
ValueAddedServiceDTO
object
Representation of a value-added service.
1 property
1 required
GetAllCarriersRequestDTO
object
Request DTO to access all carriers existing for the given target client in the Routing engine.
4 properties
GetHandoverPointsResponseDTO
object
ResponseDTO for an access request of handover points.
5 properties
HandoverPointDTO
object
Representation of an handover point.
3 properties
2 required
GetHandoverPointsRequestDTO
object
Request DTO to access all handover points existing for the given target client in the Routing engine.
4 properties
GetRatingProfilesResponseDTO
object
ResponseDTO for an access request of rating profiles.
5 properties
RatingProfileDTO
object
DTO representation of a rating profile
2 properties
1 required
GetRatingProfilesRequestDTO
object
Request DTO to access all rating profiles configured for the given target client in the Routing engine.
4 properties
GetRoutingTaskResultResponseDTO
object
Response DTO of a routing task request.
5 properties
HopDTO
object
Representation of an handover point
PricingSupplementDataDTO
object
Price information.
3 properties
3 required
RouteLegScheduleDTO
object
DTO to provide a leg of a route schedule calculation. It's values are filled depending on the calculation state and the calculation mode.
4 properties
RouteScheduleDTO
object
DTO to provide a result of a schedule calculation. It's values are filled depending on the calculation state and the calculation mode.
8 properties
2 required
RoutingLegProposalDTO
object
Describes one leg ('part') of a whole transport chain. The entirety of legs describes a set of services of one proposal. In case of direct simple routing, a pr…
9 properties
4 required
RoutingProposalDTO
object
Main DTO to hold data on a proposal. Each leg contains information on services enriched with supplements as additional information. The entirety of legs descri…
5 properties
3 required
RoutingScheduleTypeDTO
object
Holds a reference of a schedule configuration.
1 property
RoutingSupplementDTO
object
This supplement DTO is a container for additional information. One proposal can have multiple supplements. Supplements are calculated individually. A routing t…
5 properties
3 required
RoutingSupplementDataDTO
object
Container class for all supplement dependent data for BF. Contains additional data calculated by respective adapters based on a proposal for a routing task. De…
4 properties
RoutingSupplementTypeDTO
object
Each supplement is characterized by a unique name defined by the user and its dataType. It defines one type of supplement.
2 properties
2 required
RoutingTaskResultDTO
object
Contains a list of ranked proposals and information on the current calculation status for for the routing task with the given taskId.
6 properties
3 required
ServiceVasValidationSupplementDataDTO
object
Result of validation
1 property
1 required
StarRatingSupplementDataDTO
object
Holds the star rating
1 property
1 required
ValueRatingSupplementDataDTO
object
Holds the value rating.
1 property
1 required
GetRoutingTaskResultRequestDTO
object
Request DTO to get the a list of ranked proposals and the current calculation status for the routing task defined by the provided task id.
5 properties
1 required
GetRoutingRequirementTypesResponseDTO
object
ResponseDTO for a request of requirement types.
5 properties
RoutingRequirementInTypeDTO
object
DTO representation of a routing requirement contained in a routing requirement type. This DTO is used in context of getting a list of all available requirement…
2 properties
1 required
RoutingRequirementTypeDTO
object
DTO representation of a routing requirement type. This DTO is used in context of getting a list of all available requirements available for a target client.
3 properties
2 required
GetRoutingRequirementTypesRequestDTO
object
Request DTO to access all requirement types configured for the given target client in the Routing engine.
4 properties
GetSupplementTaskResultResponseDTO
object
Response DTO of a supplement task request.
5 properties
SupplementTaskResultDTO
object
Contains a list of calculated supplements and information on the current calculation status for for the routing task with the given taskId.
7 properties
4 required
GetSupplementTaskResultRequestDTO
object
Request DTO to get the current calculation status for the supplement task defined by the provided task id.
5 properties
1 required
WaitForRoutingTaskResultRequestDTO
object
Request DTO to get the a list of ranked proposals and the current calculation status for the routing task defined by the provided task id.
6 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AEB 10
Other APIs AEB publishes across the network.
AEB Customs Management API
AEB Customs Inventory Management API
AEB Customs Broker Portal API
AEB Product Classification API
AEB Trade Compliance Management API
AEB Carrier Connect API
AEB Carrier Select API
AEB Carrier Event Service API
AEB Logistics Cost Management API
AEB Document Service API
#SAP#Customs#Export Control#Origin and Preferences#Shipping#Logistics
Where this information came from
This is an independent, third-party profile of AEB BSM API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.