How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AEB Customs Management API

Electronic customs declaration filing for import, export and transit. Creates consignments and deliveries, transmits them to national customs systems (German ATLAS, EU AES/NCTS, UK CHIEF), and polls declarations, statuses, MRNs, documents and attachments back. Also exposes Intrastat, EMCS and tariff/fee calculation operations.

AEB Customs Management API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customs, Trade Compliance, Customs Declaration, Atlas, and NCTS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a changelog.

This API exposes 122 operations across 115 paths, organized into 20 resource areas, and defines 366 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/test2ici/rest.

122 operations 115 paths 366 schemas 3 DELETE39 GET79 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://rz3.aeb.de/test2ici/rest
Authentication
API Key, HTTP Basic
Resource Areas
20

Authentication & Security 2

AEB Customs Management 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 122

Across 115 paths, the API surfaces 122 operations — 3 DELETE, 39 GET, 79 POST, 1 PUT. They span 20 resource areas, including FinanceDataCHBFBean, CoreBFBean, FoundationAFBean, Logon, DataFeedBFBean, ExternalTelemetryBFBean, FoundationBFBean, RemoteAdminBFBean, and 12 more. Each is listed below with its method, path, parameters, and response codes.

FinanceDataCHBFBean 2

Interface overview for Finance data API for Switzerland

POST
/FinanceDataCHBFBean/getSummary
Gets the data of the specified summary.
getSummary body → 200
POST
/FinanceDataCHBFBean/listSummaries
Queries for available summaries.
listSummaries body → 200
CoreBFBean 12

API for the XNSGFoundation

POST
/CoreBFBean/checkBFFunctionExists
Can be called to know if a BF function exist.
checkBFFunctionExists body → 200
POST
/CoreBFBean/echo
Returns the given echo parameter value.
echo 1 param → 200
POST
/CoreBFBean/echoUpperCase
Returns the given echo parameter value in uppercase.
echoUpperCase 1 param → 200
GET
/CoreBFBean/getAllMonitoringValues
Returns all available monitoring values of the server.
getAllMonitoringValues → 200
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\".
getBuildForSolution 1 param → 200
GET
/CoreBFBean/getMonitoringValue
Returns the current monitoring value for the given group and name.
getMonitoringValue 2 params → 200
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\".
getProductInfo → 200
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…
getRuntimeInfo → 200
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…
getRuntimeState body → 200
GET
/CoreBFBean/getThreadDump
Generate Thread-Dump.
getThreadDump → 200
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\".
getVersionForSolution 1 param → 200
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…
restartRFCServer → 200
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…
releaseApplicationFacade 1 param → 200
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…
workplace body → 200
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".
authToken → 200401
POST
/logon/user
Logon with classical procedure: user, client and password.
logonUser body → 200
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.
acknowledgePublishedDataFeedParts body → 200
GET
/DataFeedBFBean/dataFeedParts/{client}/{id}
Retrieve the data feed part content.
getDataFeedPartContentForRest 2 params → 200
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…
getPublishedDataFeedParts body → 200
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.
getTelemetryStatus body → 200
GET
/ExternalTelemetryBFBean/status
Returns the current status of the telemetry system. The external system id must be sent with the request.
getTelemetryStatusByParams 2 params → 200
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.
sendTelemetryReport body → 200
FoundationBFBean 31

REST endpoint for FoundationBF

POST
/FoundationBFBean/acknowledgeFile
Acknowledges a file download.
acknowledgeFile body → 200
POST
/FoundationBFBean/announceStop
Announces a stop of the installation.
announceStop body → 200
POST
/FoundationBFBean/cancelAnnounceStop
Revokes an already announced stop.
cancelAnnounceStop body → 200
POST
/FoundationBFBean/changeAdminPassword
Changes the admin password.
changeAdminPassword body → 200
GET
/FoundationBFBean/client
Requests all clients from this engine, or one client identified by values in query parameter
queryClients 2 params → 200
POST
/FoundationBFBean/client
Create a client.
createClient body → 200
POST
/FoundationBFBean/downloadFile
Retrieves a file for download.
downloadFile body → 200
POST
/FoundationBFBean/generateClientIdentCode
Generates a client ident code.
generateClientIdentCode body → 200
GET
/FoundationBFBean/client/active
Requests all active clients from this engine.
getAllActiveClients → 200
GET
/FoundationBFBean/monitoringValue
Requests all monitoring values from this engine.
getAllMonitoringValues_1 → 200
GET
/FoundationBFBean/solution/{name}/build
Requests the build info for a solution from this engine.
getBuildForSolution_1 1 param → 200
POST
/FoundationBFBean/downloadableFileRefs
Retrieves refs for download.
getDownloadableFilesRefs body → 200
GET
/FoundationBFBean/monitoringValue/{groupName}/{valueName}
Requests a specific monitoring value from this engine.
getMonitoringValue_1 2 params → 200
GET
/FoundationBFBean/numberOfClients
Returns the number of clients.
getNumberOfClients → 200
GET
/FoundationBFBean/productInfo
Requests the product info from this engine.
getProductInfo_1 → 200
GET
/FoundationBFBean/runtimeInfo
Requests the runtime info from this engine.
getRuntimeInfo_1 → 200
POST
/FoundationBFBean/scriptExecutionState
gets a script execution state
getScriptExecutionState body → 200
POST
/FoundationBFBean/tableUpdateState
Retrieve the status of the table update.
getTableUpdateState body → 200
POST
/FoundationBFBean/uploadSettings
Retrieves the upload settings.
getUploadSettings body → 200
GET
/FoundationBFBean/solution/{name}/version
Requests the version info for a solution from this engine.
getVersionForSolution_1 1 param → 200
GET
/FoundationBFBean/workplaceURL
Requests the workplace url from this engine.
getWorkplaceURL → 200
GET
/FoundationBFBean/checkDebtorNumber
Checks if debtor number is known.
isDebtorNumberKnown 1 param → 200
POST
/FoundationBFBean/publishUserMessage
creates a user message, in several languages if required
publishUserMessage body → 200
GET
/FoundationBFBean/roles
Requests the current engine to report all its roles
requestReport → 200
GET
/FoundationBFBean/roles/{clientIdentCode}
Requests the current engine to report all roles for a specific client
requestReport_1 1 param → 200400404
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…
restartRFCServer_1 → default
POST
/FoundationBFBean/sendMail
Sends a mail.
sendMail body → 200
POST
/FoundationBFBean/startScriptExecution
Starts a script execution
startScriptExecution body → 200
POST
/FoundationBFBean/startTableUpdate
Starts the table update.
startTableUpdate body → 200
POST
/FoundationBFBean/systemSearch/{language}
Performs a system search in this engine.
systemSearch 1 param body → 200
POST
/FoundationBFBean/uploadFileMultiPart
Uploads a file using multipart.
uploadFileMultiPart body → 200
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
getRolesForClient 1 param → 200404
GET
/RemoteAdminBFBean/roles
getRoles
getRolesGET 3 params → 200
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 .
acknowledgeEvents body → 200
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…
getNotAcknowledgedEvents body → 200
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…
getPartnerSystemSubscriptions body → 200
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…
subscribePartnerSystem body → 200
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 {@…
synchronizeEvents body → 200
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…
unsubscribePartnerSystem body → 200
InternationalCustomsAFBean 4

Application facades for Customs Management

POST
/InternationalCustomsAFBean/openConsignmentFolder
Open consignment folder
openConsignmentFolder body → default
POST
/InternationalCustomsAFBean/openDeclarationAttachment
Open declaration attachment
openDeclarationAttachment body → default
POST
/InternationalCustomsAFBean/openDeclarationFolder
Open declaration folder
openDeclarationFolder body → default
POST
/InternationalCustomsAFBean/openDeclarationSearch
Open declaration search
openDeclarationSearch body → default
Consignment profiles 3

Consignment profiles API

GET
/v1/consignment-profiles/{code}
Returns a consignment profile of the given client
getConsignmentProfile 3 params → 200400404500
GET
/v1/consignment-profiles
Returns a list of consignment profiles of the given client
getConsignmentProfiles 3 params → 200400500
GET
/v1/consignment-profiles/transitions
Returns a list of consignment profile transitions of the given client
getConsignmentProfilesTransitions 5 params → 200400500
CustomsTransitBFBean 1

Business facade for transit processes

POST
/CustomsTransitBFBean/sendConformUnloadingRemarks
Send conform unloading remarks
sendConformUnloadingRemarks body → default
Document extractions 1

Document extractions API

POST
/v1/document-extractions
Creates a list of document extractions for the given documents
create-document-extractions body → 200400500
InternationalCustomsBFBean 17

Interface overview for Customs Management

POST
/InternationalCustomsBFBean/acknowledgeGetChangedDeclarations
Acknowledge call of get changed declarations
acknowledgeGetChangedDeclarations body → default
POST
/InternationalCustomsBFBean/addDeclarationAttachmentsdeprecated
Add declaration attachments
addDeclarationAttachments body → default
POST
/InternationalCustomsBFBean/cancelConsignment
Cancel consignment
cancelConsignment body → default
POST
/InternationalCustomsBFBean/cancelConsignmentManifest
Cancel consignment manifest
cancelConsignmentManifest body → default
POST
/InternationalCustomsBFBean/cancelDeclaration
Cancel declaration
cancelDeclaration body → default
POST
/InternationalCustomsBFBean/createConsignment
Create a consignment
createConsignment body → default
POST
/InternationalCustomsBFBean/createConsignmentManifest
Create a consignment manifest
createConsignmentManifest body → default
POST
/InternationalCustomsBFBean/createDelivery
Create a delivery
createDelivery body → default
POST
/InternationalCustomsBFBean/getBrokerDeclarations
Get broker declarations
getBrokerDeclarations body → default
POST
/InternationalCustomsBFBean/getChangedDeclarations
Get changed declarations
getChangedDeclarations body → default
GET
/InternationalCustomsBFBean/getCodes
getCodes_1 4 params → default
POST
/InternationalCustomsBFBean/getCodes
Get codes
getCodes body → default
POST
/InternationalCustomsBFBean/getConsignmentsOfManifest
Get consignments of manifest
getConsignmentsOfManifest body → default
POST
/InternationalCustomsBFBean/getDeclarationAttachments
Get declaration attachments
getDeclarationAttachments body → default
POST
/InternationalCustomsBFBean/getDeclarations
Get declarations
getDeclarations body → default
POST
/InternationalCustomsBFBean/sendDeclarations
Send declarations
sendDeclarations body → default
POST
/InternationalCustomsBFBean/setDeclarationAttachmentsStatus
Set declaration attachment status
setDeclarationAttachmentsStatus body → default
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.
getCompany 1 param → 200400404
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…
createOrUpdateCompany 1 param body → 200400404409
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.
deleteCompany 1 param → 200400404409
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…
searchCompanies 9 params → 200400
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.
getCompanyRoles → 200
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.
connect 1 param → 200401
DELETE
/wssagent/connectdeprecated
Ends existing workstation agent. Noop if there is no agent for the id.
disconnect0 1 param → 204401
GET
/wssagent/connection/{id}
Returns response object with information about given workstation service agent.
status0 2 params → 200404401
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.
connect0 5 params → 200401
DELETE
/wssagent/connection/{id}
Ends existing workstation agent. Noop if there is no agent for the id.
disconnect1 1 param → 204401
GET
/wssagent/statusdeprecated
Returns response object with information about given workstation service agent.
status 2 params → 200401
GenericAFBean 2

API to open views that support this generic interface.

GET
/GenericAFBean/getGenericApplicationFacadeInfo
getGenericApplicationFacadeInfo → default
POST
/GenericAFBean/applications/{applicationName}
open 1 param body → default
TariffContentFeeCalculationBFBean 2

API for fee calculation using the tariff content solution

POST
/TariffContentFeeCalculationBFBean/calculateCustomsDuty
Result including the calculated custom duties packed into a DTO
calculateCustomsDuty body → default
POST
/TariffContentFeeCalculationBFBean/calculateTax
Result including the calculated packed taxes into a DTO
calculateTax body → default
TariffContent20BFBean 15

API for the tariff content solution (version 2.0).

POST
/TariffContent20BFBean/getAESCertificateTypes
Gets all certificates for a specific country.
getAESCertificateTypes body → default
POST
/TariffContent20BFBean/getAdditionalCodeProposals
Gets proposals additional codes for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code.
getAdditionalCodeProposals body → default
POST
/TariffContent20BFBean/getCertificateProposals
Gets proposals for certificates/documents for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code.
getCertificateProposals body → default
POST
/TariffContent20BFBean/getCommodityCode
Gets the data of exactly one commodity code. This function can also be used to check the validity of a commodity code.
getCommodityCode body → default
POST
/TariffContent20BFBean/getCommodityCodeSubstitutions
A list of commodity code substitutions, normally relevant for a turn of the year.
getCommodityCodeSubstitutions body → default
POST
/TariffContent20BFBean/getCommodityCodes
All valid commodity codes for the given decisive date.
getCommodityCodes body → default
POST
/TariffContent20BFBean/getContents
A list of contents which are licensed for the given client.
getContents body → default
POST
/TariffContent20BFBean/getCountriesForCountryGroup
A list of countries referenced in the given country group.
getCountriesForCountryGroup body → default
POST
/TariffContent20BFBean/getCountryGroups
A list of all country groups related in the tariff content.
getCountryGroups body → default
POST
/TariffContent20BFBean/getExportControlNumber
Gets the data of exactly one export control number. This function can also be used to check the validity of a export control number.
getExportControlNumber body → default
POST
/TariffContent20BFBean/getExportControlNumberMapping
Gets the mapping data of a commodity code to a list of export control numbers.
getExportControlNumberMapping body → default
POST
/TariffContent20BFBean/getExportControlNumbers
All valid export control numbers for the given decisive date.
getExportControlNumbers body → default
POST
/TariffContent20BFBean/getImportMeasures
Gets all valid import measures for a commodity code, country, content and decisive date.
getImportMeasures body → default
POST
/TariffContent20BFBean/getKnCodeCertificateProposalsdeprecated
Gets the proposals for certificates/documents for a specific combination of commodity code, decisive date, destination country's ISO-code and a descriptions' language ISO-code. @deprecated This metho…
getKnCodeCertificateProposals body → default
POST
/TariffContent20BFBean/getKnCodeCertificateTypes
Gets all certificates for a specific knCode/country/destination-id/decisive date combination.
getKnCodeCertificateTypes body → default
CustomsContentServiceBF 3

API providing services around customs content (nomenclatures, export control lists).

GET
/CustomsContentServiceBF/content/{contentIdentCode}/finalCode/{code}
Requests one final code from a catalog.
getFinalCode 7 params → default
GET
/CustomsContentServiceBF/content/{contentIdentCode}/finalCodes
Requests final codes from a catalog. Result may be resticted with a prefix.
getFinalCodes 7 params → default
GET
/CustomsContentServiceBF/content/{contentIdentCode}/search/{searchTerm}
Searches for codes matching the given criteria.
searchCodes 7 params → default

Schemas 366

The contract defines 366 schemas that model the data the API accepts and returns. The most detailed are ICDeclarationDTO (44 properties), ICDeliveryExtensionDataDTO (33 properties), ICDeliveryItemDTO (33 properties), ICDeliveryItemExtensionDataDTO (32 properties). Each schema is shown below with its type and property counts.

AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
GetSummaryResponseDTO
object
Response for the requested summaries.
5 properties
ICAttachmentDTO
object
DTO to hold attachment data.
7 properties
ICCustomsIdentifcationDTO
object
DTO to hold data for customs identification.
2 properties
ICPartyDTO
object
DTO to hold data of a party.
15 properties
ICPersonDTO
object
DTO to hold data of a person.
7 properties
ICSummaryCHDTO
object
List of found summaries.
17 properties
ICSummaryLineCHDTO
object
Summary lines.
4 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
GetSummaryRequestDTO
object
Request for summary data.
5 properties
ListSummariesResponseDTO
object
Response for the requested list of summaries.
5 properties
ListSummariesRequestDTO
object
Request for a list of summaries.
8 properties
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.
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
AcknowledgeEventsResponseDTO
object
Response DTO for acknowledging events.
4 properties
AcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
6 properties
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
SyncEventDTO
object
DTO to hold data of one synchronized event.
7 properties
SyncEventsResponseDTO
object
Response DTO for synchronizing events.
8 properties
SyncEventsRequestDTO
object
Request DTO for synchronizing events.
9 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
GetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
5 properties
SubscribePartnerSystemResponseDTO
object
Response parameter of a partner system subscription to sync events.
5 properties
SubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
6 properties 1 required
UnsubscribePartnerSystemResponseDTO
object
Response parameter of a partner system unsubscription from sync events.
5 properties
UnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
5 properties 1 required
ICConsignmentFolderParmsDTO
object
Identifies a consignment to be opened in a folder.
2 properties
OpenConsignmentFolderArgumentDTO
object
Arguments to open a consignment folder.
2 properties
ICCustomsProcessTypeDTO
object
DTO to hold the customs process type.
2 properties
ICDeclarationAttachmentParmsDTO
object
Identifies a declaration attachment to be opened.
4 properties
OpenDeclarationAttachmentArgumentDTO
object
Arguments to open an attachment.
2 properties
ICDeclarationFolderParmsDTO
object
Identifies a declaration to be opened in a folder.
2 properties
OpenDeclarationFolderArgumentDTO
object
Arguments to open a declaration folder.
2 properties
AbsoluteIntervalFilterDTO
object
Initializes the filter with a fix interval between two dates.
2 properties
DateTimeIntervalRangeFilterDTO
object
Represents a possibility to pass a date time interval range filter. Use one of the given attributes to pass the filter. If more than one attribute is filledthe…
2 properties
ICDeclarationSearchParmsDTO
object
Parameters for a declaration search.
3 properties
IntervalFromNowFilterDTO
object
Initializes the filter with a time interval relative to 'today'.
2 properties
OpenDeclarationSearchArgumentDTO
object
Arguments to open a declaration search.
2 properties
RelativeIntervalFilterDTO
object
Initializes the filter with a relative time range. If only one attribute is filled, the interval is relative to 'today'.
2 properties
ICConsignmentProfileDTO
object
Data of a certain consignment profile
3 properties 2 required
ICConsignmentProfileTransitionDTO
object
Data of a transition within a consignment profile
4 properties 2 required
ICGetConsignmentProfilesResponseDTO
object
Response data for consignment profiles
5 properties
ErrorResponseMessageDTO
object
DTO for general errors messages or errors messages related to a contraint violation of a certain field.
4 properties
ProblemDTO
object
The response DTO which indicates that a problem occurred when processing the request. See RFC 7807 for further specification details.
6 properties
ICGetTransitionsResponseDTO
object
Response data for transitions of consignment profiles
5 properties
ICSendConformUnloadingRemarksResponseDTO
object
Result data for the send-conform-message operation.
4 properties
ICSendConformUnloadingRemarksRequestDTO
object
Body data containing references to transit arrivals for which conform messages shall be sent to customs.
7 properties 1 required
ICCreateDocumentExtractionResponseDTO
object
The response data of creating a new document extractions.
5 properties
ICDocumentExtractionDTO
object
A document extraction with its current processing state and associated documents.
8 properties
ICDocumentExtractionDocumentDTO
object
A document belonging to a document extraction, without content.
2 properties
ICCreateDocumentExtractionRequestDTO
object
Request data for creating document extractions.
5 properties
ICDocumentExtractionCreationDTO
object
The payload for creating a new document extraction.
5 properties 3 required
ICDocumentExtractionDocumentWithContentDTO
object
A document including its Base64-encoded content.
3 properties 3 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
ICConsignmentResultDTO
object
The result DTO which contains the information to the consignment created on the system.
5 properties
ICCreateConsignmentResponseDTO
object
The response DTO after processing the request. Contains the resulting consignment DTO.
5 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
ICAttachmentLinkDTO
object
DTO to hold link data.
2 properties
ICClassificationDTO
object
DTO to hold data for classification.
3 properties
ICConsignmentDTO
object
DTO to hold data of a consignment.
12 properties 2 required
ICCostDTO
object
DTO to hold data for costs.
4 properties
ICCreateConsignmentRequestDTO
object
The DTO for the request.
5 properties 1 required
ICCurrencyRateDTO
object
DTO to hold data of currency rate.
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
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
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
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
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
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
ApplicationInfoDTO
object
Contains information about an application, that can be accessed via GenericAFopen
2 properties
GenericApplicationFacadeInfoDTO
object
The result DTO for getGenericApplicationFacadeInfo().
5 properties
GenericParameterInfoDTO
object
Information about a specific parameter for an application.
7 properties
GenericApplicationFacadeParmsDTO
object
A generic request for an application facade.
18 properties
GenericParameterDTO
object
A name-value pair representing a single parameter.
2 properties
TCCalculateDutyResponseDTO
object
DTO to hold result data of custom duty calculation additional to common data see TCCalculateDutyOrTaxesResponseDTO .
3 properties
TCCalculationLineDTO
object
DTO to hold result data describing a line in fee calculation.
7 properties
TCCalculationStepDTO
object
DTO to hold result data describing a step in fee calculation.
5 properties
TCUserMessageDTO
object
DTO encapsulates problem and information messages.
2 properties
QuantityWithTypeDTO
object
A quantity with a value, a quantity unit and a quantity unit type.
4 properties
TCCalculateDutyCurrencyRateDTO
object
Represents a one-way currency conversion rate, enabling monetary comparisons involving differing currencies in a single duty measure.
3 properties
TCCalculateDutyRequestDTO
object
DTO to hold request data for calculating custom duties additional to the common fields. See TCCalculateDutyOrTaxesRequestDTO.
12 properties
TCCalculationParameter
object
Parameters that fee calculation might use when calculating fees.
2 properties
TCCustomsQuantity
object
DTO to represent customs quantities.
2 properties
TCCalculateTaxResponseDTO
object
DTO to hold result data of tax calculation additional to common data see TCCalculateDutyOrTaxesResponseDTO .
3 properties
TCCalculateTaxRequestDTO
object
DTO to hold request data for calculating taxes additional to the common fields. See TCCalculateDutyOrTaxesRequestDTO.
9 properties
TCAESCertificateTypeDTO
object
DTO containing the extended field of a aes certificate.
13 properties
TCDateDTO
object
Contains a date as string.
1 property
TCGetAESCertificateTypesResultDTO
object
Result DTO to hold all certificates for a given country.
2 properties
TCGetAESCertificateTypesRequestDTO
object
DTO to hold request data to get all certificates of a specific country
2 properties
TCCommodityCodeAdditionalCodeDTO
object
Result DTO to hold code and description of an additional code
1 property
TCCommodityCodeMeasureAdditionalCodeDTO
object
Result DTO to hold information of a measure with additional code.
2 properties
TCCommodityCodeMeasureTypeDTO
object
Result DTO to hold code and description of a measure.
2 properties
TCGetAdditionalCodeProposalsResultDTO
object
Result DTO to hold measures with additional codes.
2 properties
TCGetAdditionalCodeProposalsRequestDTO
object
DTO to hold request data to get additional codes.
6 properties
TCCommodityCodeCertificateDTO
object
Result DTO to hold the information of a certificate/produced document
2 properties
TCCommodityCodeMeasureCertificatesDTO
object
Result DTO to hold information of a measure with certificates.
4 properties
TCGetCertificateProposalsResultDTO
object
Result DTO to hold the proposals for certificates/documents. There will be a TCCommodityCodeMeasureCertificatesDTO for each measure that needs to be applied fo…
3 properties
TCGetCertificateProposalsRequestDTO
object
DTO to hold request data to get certificate/document proposals.
7 properties
TCCommodityCodeDTO
object
DTO to hold data of a valid commodity code.
6 properties
TCGetCommodityCodeResultDTO
object
Result DTO to hold exactly one commodity code
2 properties
TCGetCommodityCodeRequestDTO
object
DTO to hold request data to get exactly one commodity codes.
7 properties
TCCommodityCodeSubstitutionDTO
object
DTO to hold data of one commodity code substitution.
5 properties
TCGetCommodityCodeSubstitutionsResultDTO
object
DTO to hold a list of commodity code substitutions.
2 properties
TCGetCommodityCodeSubstitutionsRequestDTO
object
DTO to hold request data to get a list of commodity code substitutions.
5 properties
TCGetCommodityCodesResultDTO
object
Result DTO to hold list of TCCommodityCodeDTO
2 properties
TCGetCommodityCodesRequestDTO
object
DTO to hold request data to get a list of all valid commodity codes.
6 properties
TCContentDTO
object
DTO to hold meta data of a content.
2 properties
TCGetContentsResultDTO
object
Result DTO to hold a list of licensed contents.
2 properties
TCGetContentsRequestDTO
object
DTO to hold request data to get all licensed contents for the given client.
1 property
TCCountryInGroupDTO
object
DTO to hold data of a country referenced in a country group.
3 properties
TCGetCountriesForGroupResultDTO
object
DTO to hold result data of countries referenced in a country group.
2 properties
TCGetCountriesForGroupRequestDTO
object
DTO to hold request data to get all countries which belong to a given group.
4 properties
TCCountryGroupDTO
object
DTO to hold data of a country group
2 properties
TCCountryGroupTTDTO
object
DTO to hold language specific data of a country group.
3 properties
TCGetCountryGroupsResultDTO
object
DTO to hold result data of country groups related in the tariff content.
2 properties
TCGetCountryGroupsRequestDTO
object
DTO to hold request data to get all country groups related in the tariff content.
2 properties
TCExportControlNumberDTO
object
DTO to hold data of a valid export control number.
4 properties
TCGetExportControlNumberResultDTO
object
Result DTO to hold exactly one export control number.
2 properties
TCGetExportControlNumberRequestDTO
object
DTO to hold request data to get exactly one export control number.
5 properties
TCGetExportControlNumberMappingResultDTO
object
Result DTO to hold export control number mappings of a given commodity code
2 properties
TCGetExportControlNumberMappingRequestDTO
object
DTO to hold request data to get all proposed AL numbers for a KN codes.
5 properties
TCGetExportControlNumbersResultDTO
object
Result DTO to hold list of TCExportControlNumberDTO
2 properties
TCGetExportControlNumbersRequestDTO
object
DTO to hold request data to get a list of all valid export control numbers.
4 properties
TCDateRangeDTO
object
Describes a date range, spanning all days between a pair of TCDateDTO .
2 properties
TCGetImportMeasuresResultDTO
object
Result DTO to hold a list of import measures matching the request criteria. A TCImportMeasureDTO is returned for each matching import measure
2 properties
TCImportMeasureAdditionalCodeDTO
object
Represents additional code information within a TCImportMeasureDTO .
2 properties
TCImportMeasureCertificateDTO
object
Represents a certificate within a TCImportMeasureConditionDTO .
1 property
TCImportMeasureConditionDTO
object
Describes a conditional rate within a TCImportMeasureDTO .
6 properties
TCImportMeasureDTO
object
Result DTO representing a single import measure.
13 properties
TCImportMeasureFootnoteDTO
object
Describes a footnote within a TCImportMeasureDTO .
3 properties
TCImportMeasureRateComponentDTO
object
Result DTO representing one rate component of an import measure.
12 properties
TCGetImportMeasuresRequestDTO
object
DTO to hold request data for import measure requests
6 properties
TCKnCodeCertProposalResultDTO
object
Result DTO to hold the proposals for certificates/documents. There will be a TCKnCodeMeasureInfoDTO for each measure that needs to be applied for materials wit…
3 properties
TCKnCodeMeasureCertificateDTO
object
Result DTO to hold the information about a certificate.
1 property
TCKnCodeMeasureInfoDTO
object
Result DTO to hold the certificate proposal for exactly one measure.
5 properties
TCKnCodeNationalCertificateDTO
object
Result DTO to hold the information of a national certificate.
2 properties
TCKnCodeCertProposalRequestDTO
object
DTO to hold request data to get certificate/document proposals.
5 properties
TCAESCertificateTypeSimpleDTO
object
DTO containing the basic fields of a certificate.
5 properties
TCGetKnCodeCertificateTypesResultDTO
object
Result DTO to hold all certificates for a given kn code.
2 properties
TCGetKnCodeCertificateTypesRequestDTO
object
DTO to hold request data to get all certificates for a specific kn code.
5 properties
CodeElementDTO
object
DTO to hold data of one code element of a nomenclature resp. an export control list.
5 properties
GetCodeResultDTO
object
DTO to hold a request result containing one code element of the nomenclature resp. the export control list.
5 properties
SupplementaryCodeElementInfoDTO
object
DTO to hold one type-casted supplementary information about a code element.
2 properties
GetFinalCodesResultDTO
object
DTO to hold a request result containing all final code elements of the nomenclature resp. the export control list.
5 properties
SearchCodesResultDTO
object
DTO to hold a search result containing all matching code elements of the nomenclature resp. the export control list.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-customs-management-openapi.json Raw ↑

Other APIs AEB publishes across the network.

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
AEB BSM API
Where this information came from

This is an independent, third-party profile of AEB Customs Management 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.