2'
format: double
example: 1000.0
currencyIso:
maxLength: 3
type: string
description: The three-letter ISO code of the currency of the amount of money.
example: EUR
description: A pair of a value with a currency.
CreateQuestionnaireForTransactionResponseDTO:
type: object
properties:
hasErrors:
type: boolean
description: True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' description: The response to a request to explicitly create a questionnaire. Empty on success. DeleteTransactionRequestDTO: required: - transactionIdHost type: object properties: clientSystemId: type: string description: 'Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
' example: TEST_ID clientIdentCode: type: string description: 'Client identification code.
Maximum length: 10
' example: APITEST userName: type: string description:User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST resultLanguageIsoCodes: type: array description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: - en - de items: type: string description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]' transactionIdHost: type: string description: A human-readable form of the unique id for the transaction. example: Mandant = 001; Auftragsnr. = 80004989 description: Represents a request to delete a check transaction in Export Controls.clientIdentCode and clientSystemId are mandatory fields."COMPLIANCE SERVER" is reserved for internal usage and therefore it is not allowed to use it as clientSystemId in a request.
CreateQuestionnaireForTransactionRequestDTO:
required:
- profileIdentCode
- templateId
- transaction
type: object
properties:
clientSystemId:
type: string
description: 'Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
' example: TEST_ID clientIdentCode: type: string description: 'Client identification code.
Maximum length: 10
' example: APITEST userName: type: string description:User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST resultLanguageIsoCodes: type: array description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: - en - de items: type: string description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]' profileIdentCode: type: string description: ID of the compliance profile to take settings from. example: DEFAULT transaction: $ref: '#/components/schemas/ECTransactionDTO' templateId: type: string description: Unique technical ID of the questionnaire template to create the questionnaire with. example: '000001' questionnaireData: $ref: '#/components/schemas/CreateRAQuestionnaireDataDTO' description: A request to explicitly create a questionnaire for an EC check transaction. CheckTransactionRequestDTO: required: - profileIdentCode - transaction type: object properties: clientSystemId: type: string description: 'Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
' example: TEST_ID clientIdentCode: type: string description: 'Client identification code.
Maximum length: 10
' example: APITEST userName: type: string description:User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST resultLanguageIsoCodes: type: array description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: - en - de items: type: string description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]' transaction: $ref: '#/components/schemas/ECTransactionDTO' profileIdentCode: type: string description: ID of the compliance profile to take settings for export control check from. example: DEFAULT organisationUnitHost: maxLength: 255 type: - string - 'null' description: Ident code of the organizational unit. May benull.
example: Sales Unit 0711
isAutoCreateClearings:
type: boolean
description: Defines that the transaction can be automatically approved, if an applicable license is found. If the transaction can be approved automatically, an approval is automatically created per jurisdiction and the transaction is no longer blocked.clientIdentCode and clientSystemId are mandatory fields."COMPLIANCE SERVER" is reserved for internal usage and therefore it is not allowed to use it as clientSystemId in a request.
UpdateCustomsInfoResponseDTO:
type: object
properties:
hasErrors:
type: boolean
description: True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' description: Response of/ExportControl/v2/updateCustomsInfo.
ECCompletionStatusDTO:
type: object
properties:
pluginIdentCode:
type: string
description: 'The pluginIdentCode. Possible values: DE-EU-PluginUS-EAR-Plugintrue if the ECClearingDataDTO#productClassifications that are relevant for the jurisdiction, are correctly and completely filled. The classification types are described in ECClassificationDTO.
example: true
description: The completion status of the product data for a specific jurisdiction.
AcknowledgeGetChangedTransactionsResponseDTO:
type: object
properties:
hasErrors:
type: boolean
description: True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' description: Response for/ExportControl/v2/acknowledgeGetChangedTransactions.
ECClassificationDTO:
type: object
properties:
classificationIdentCode:
type: string
description: Identcode of the classification the classificationNumber belongs to.ClassificationMaterialNumbers for material numbersClassificationAusfuhrliste for EU export control numbersCLASSIFICATION_US_EAR_CCL for US export control numbers, i.e., a specific ECCN or EAR99CLASSIFICATION_US_EAR_ACTRELEVANT for the EAR99 property (only supported for clients using version 1 for goods attribute handling)ClassificationStatisticalNumbers for commodity codesClassificationSelfDefined for self defined numbersNOT_LISTED indicating that an item is not listed on the goods list describing the classificationEAR99 indicating that the item is an EAR99 product.Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
' example: TEST_ID clientIdentCode: type: string description: 'Client identification code.
Maximum length: 10
' example: APITEST userName: type: string description:User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST resultLanguageIsoCodes: type: array description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: - en - de items: type: string description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]' transactionIdHost: type: string description: A human-readable form of the unique id for the transaction. example: Mandant = 001; Auftragsnr. = 80004989 itemIdHost: type: string description: Unique id for the item within the transaction. example: '4711' jurisdiction: type: string description: ID of the jurisdiction to which the result belongs.DE-EU-PluginUS-EAR-PluginCustom-PluginRisk-Assessment-Plugin/ComplianceFoundation/getMasterdataIdentifiers.
example: DE-EU-Plugin
customsAcceptanceDate:
type: string
description: Date on which customs office accepts export declaration.
format: date
example: '2015-01-01'
customsOffice:
type: string
description: Code of customs office that decrements the license.
example: DE12345
mrn:
type: string
description: Movement reference number (MRN) of export declaration.
example: 20DE1234567890123
dateOfExport:
type: string
description: Date of export.
format: date
example: '2015-01-01'
customsClientTransactionRef:
type: string
description: Number of transaction/document from which the export declaration was created.
example: '80004989'
description: Represents a request to update customs information in Export Controls.clientIdentCode is a mandatory field.
CreateRAQuestionnaireDataDTO:
type: object
properties:
userName:
type: string
description: Name of the user who fills in the questionnaire. In most cases it is not the user who triggered the creation.
example: User
department:
type: string
description: Department of the user who fills in the questionnaire. Can also be filled out by the user himself.
example: Compliance
emailAddress:
type: string
description: The e-mail address(es) of the user who fill in the questionnaire.DE-EU-PluginUS-EAR-PluginCustom-PluginRisk-Assessment-Plugin/ComplianceFoundation/getMasterdataIdentifiers.
example: DE-EU-Plugin
resultType:
type: string
description: Represents the accumulated result type of the item in the specified jurisdiction (pluginIdentCode)OKINFOCLEAREDCHECKREQUIRECUSTOM_RESTRICTIONRESTRICTIONERRORId of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
' example: TEST_ID clientIdentCode: type: string description: 'Client identification code.
Maximum length: 10
' example: APITEST userName: type: string description:User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST resultLanguageIsoCodes: type: array description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: - en - de items: type: string description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]' transactionIdHost: type: string description: A human-readable form of the unique id for the transaction. example: Mandant = 001; Auftragsnr. = 80004989 itemIdHost: type: string description: Unique id for the item within the transaction. example: '4711' jurisdiction: type: string description: ID of the jurisdiction to which the result belongs.DE-EU-PluginUS-EAR-PluginCustom-PluginRisk-Assessment-Plugin/ComplianceFoundation/getMasterdataIdentifiers.
example: DE-EU-Plugin
description: Represents a request to finalize an approval in Export Controls.clientIdentCode is a mandatory field.
ECLocalizedTextDTO:
type: object
properties:
language:
maxLength: 2
minLength: 2
type: string
description: The language of the text. Possible values:deenName of this field, i.e. the role the field plays in the enclosing record.
When the same name is repeated in the context of the same parent record, it is assumed that the parent defines this element as a repeatable (array) element.
value: type: string description:Value of the field.
The format follows the conventions of xml schema encoding, see http://www.w3.org/TR/xmlschema-2/.
Data type of the field.
This is not strictly necessary since the receiving entity should be able to infer the structure with its own meta data; it may be used however for sanity checks.
The format follows the conventions of xml schema encoding, see http://www.w3.org/TR/xmlschema-2/.
Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
' example: TEST_ID clientIdentCode: type: string description: 'Client identification code.
Maximum length: 10
' example: APITEST userName: type: string description:User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST resultLanguageIsoCodes: type: array description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: - en - de items: type: string description:2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]' description: Request to get the changed results of EC check transactions. GetTransactionCheckResultResponseDTO: type: object properties: hasErrors: type: boolean description:True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' status: type: string description: 'The functional status of the response. It is only filled, if the response indicates a valid request from a functional point of view. Otherwise (, e.g., if there are errors) it is left empty.TRANSACTION_NOT_FOUND: Indicates that the check transaction of the specified transaction ID is not found. This might happen, if the previous EC checks for the checked transaction from host system did not result in a restriction (, i.e., no necessity to release an item). In those cases no check transaction was created. It is suggested to do another EC check (via /ExportControl/v2/checkTransaction) to get the current check result. Another reason for a check transaction not being found could be that it has been deleted in Trade Compliance Management.checkResult should not be evaluated, as it will be undefined.TRANSACTION_FOUND: Indicates that the check transaction of the specified transaction ID exists./ExportControl/v2/getChangedTransactions call.
default: false
totalResultType:
type: string
description: Represents the accumulated result type of the whole transaction.Possible values are:OKINFOCLEAREDCHECKREQUIRECUSTOM_RESTRICTIONRESTRICTIONERRORnull, if isDeleted is set to true
example: OK
itemResults:
type: array
description: The result of the every item of the transaction.
items:
$ref: '#/components/schemas/ECItemCheckResultV2DTO'
description: The export control result for a whole transaction. Note that this DTO is inspired by *ECTotalCheckResultDTO* and *CheckTransactionResponseDTO*. There is no explicit previous version called *ECTransactionCheckResultDTO*.
ECApprovalInfoV2DTO:
type: object
properties:
uniqueApprovalId:
type: string
description: The unique ID of the approval.
licenseReference:
$ref: '#/components/schemas/ECLicenseReferenceDTO'
licenseNumber:
maxLength: 100
type: string
description: The license number of the used license. No license number is provided, if the approval is based on a license, that does not exist in Trade Compliance Management.
licenseItemNumber:
maxLength: 100
type: string
description: The item number of the used license (if it supports items).
licenseStatement:
type: string
description: Text that should be printed on shipping documents.
lmLicenseType:
type: string
description: The type of license applied. Contains the identifier of the License Management license type of the license applied. The LM license type is only available for licenses from License Management.
description: DTO representing an approval used to release a restriction or a required license in a jurisdiction for a transaction item.
ECApprovalInfoDTO:
type: object
properties:
licenseReference:
$ref: '#/components/schemas/ECLicenseReferenceDTO'
licenseNumber:
type: string
description: The license number of the used license.
example: '121'
positionNumber:
maxLength: 100
type: string
description: The item number of the used license (if it supports items).
example: '1'
licenseDescription:
type: array
description: A human-readable description of the license.
items:
$ref: '#/components/schemas/ECLocalizedTextDTO'
licenseStatement:
type: string
description: Text that should be printed on shipping documents.
example: license statement
lmLicenseType:
maxLength: 20
type: string
description: The type of license applied. Contains the identifier of the License Management license type of the license applied. The LM license type is only available for licenses from License Management.
example: EAG
uniqueApprovalId:
type: string
description: A unique id for this approval.
example: '12021'
description: DTO representing an approval used in the current item to release a restriction or a required license.
ECItemCheckResultDTO:
type: object
properties:
itemIdHost:
type: string
description: The itemIdHost of the item as passed with ECItemDTO.
example: item-1
bomItemResults:
type: array
description: The results for BOM items belonging to this item.
The results of these BOM items will not be accumulated into this item result.
items:
$ref: '#/components/schemas/ECItemCheckResultDTO'
resultType:
type: string
description: Represents the accumulated result type of the whole item.
Possible values are:OKINFOCLEAREDCHECKREQUIRECUSTOM_RESTRICTIONRESTRICTIONERROR
example: OK
pluginResults:
type: array
description: Contains one result for each used jurisdiction.
items:
$ref: '#/components/schemas/ECPluginCheckResultDTO'
description: The export control result for one item of the transaction.
CheckTransactionRAParmsDTO:
type: object
properties:
templateId:
type: string
description: "Unique technical ID number of the questionnaire template. This field is mandatory, if\tisRiskAssessmentRequested is true.
\t
\tTemplate ID, client, partner system ID and transaction ID are used to find the appropriate\tquestionnaire for the export control check. If the questionnaire for the reference data\tdoes not exist yet, then it will be created. If the questionnaire exists, then it will\tbe checked, if the questionnaire still suits to the data in the export control\ttransaction (only partner data is considered)."
example: '0001'
isRiskAssessmentRequested:
type: boolean
description: Indicates that Risk Assessment rules should be evaluated in an export control check.
If set and enabled in the profile, questionnaires for Risk Assessment are evaluated as part of the export control check. This involves possibly the creation of a questionnaire and may cause restrictions in the Risk Assessment jurisdiction, depending on status and outcome of the questionnaire.
example: true
default: false
isDataForRAComplete:
type: boolean
description: Indicates that Risk Assessment should be considered in the export control check, but not allrelevant data is available yet.
If this flag is set to false, no questionnaire will be created. This will cause a restriction in the Risk Assessment jurisdiction if Risk Assessment functionality is requested (due to isRiskAssessmentRequested and due to configuration in the profile the Risk Assessment integration is relevant for the transaction.
example: true
default: true
questionnaireData:
$ref: '#/components/schemas/CreateRAQuestionnaireDataDTO'
description: Parameters to integrate Risk Assessment in an export control check.
DeleteTransactionResponseDTO:
type: object
properties:
hasErrors:
type: boolean
description: True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
example: false
hasOnlyRetryableErrors:
type: boolean
description: True, if there are any error messages.
Error details are provided in the messages[] array.
example: true
hasWarnings:
type: boolean
description: True, if there are any error messages.
Error details are provided in the messages[] array.
example: true
messages:
type: array
description: Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items:
$ref: '#/components/schemas/ResponseMessageDTO'
description: Response of /ExportControl/v2/deleteTransaction.
GetTransactionCheckResultRequestDTO:
required:
- transactionIdHost
type: object
properties:
clientSystemId:
type: string
description: 'Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
'
example: TEST_ID
clientIdentCode:
type: string
description: 'Client identification code.
Maximum length: 10
'
example: APITEST
userName:
type: string
description: User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST
resultLanguageIsoCodes:
type: array
description: 2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example:
- en
- de
items:
type: string
description: 2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]'
transactionIdHost:
type: string
description: The unique ID of the transaction to get the result for.
example: MANDANT=001/BELNO=80004989
description: Request to get the check result of a certain EC check transaction.
ECTransactionDTO:
required:
- items
- transactionIdHost
type: object
properties:
transactionIdHost:
type: string
description: A unique id for the transaction.
example: MANDANT=001/BELNO=80004989
transactionLabelHost:
type: string
description: A human-readable form of the unique id for the transaction.
example: Mandant = 001; Auftragsnr. = 80004989
partners:
type: array
description: The partners involved in this transaction. All partners defined with a particular role here will be applied to all items of this transaction that do not have partners with that role defined on their own.
If there is at least one partner defined in the array, all other partners that can be defined with the deprecated partners fields in ECItemDTO (like e.g. recipient), etc. will be ignored.
More information about partners is found on item level; see ECItemDTO.partners.
items:
$ref: '#/components/schemas/ECPartnerDTO'
items:
type: array
description: The items of the transaction. Only fill normal transaction items into this array. BOM sub items should be filled into bomItems.
items:
$ref: '#/components/schemas/ECItemDTO'
transactionType:
type: string
description: The ident code of the transaction type. The transaction type will implicitly (through configuration in Trade Compliance Management) determine the behavior of decrementing quantities or values from the license.
The field defaults to a standard transaction type for outbound transactions.
example: OUTBOUND_STD
customData:
$ref: '#/components/schemas/GenericDataRecordDTO'
description: Data about the transaction.
ErrorData:
type: object
properties:
errorMessage:
type: string
errorCause:
type: string
CheckTransactionResponseDTO:
type: object
properties:
hasErrors:
type: boolean
description: True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
example: false
hasOnlyRetryableErrors:
type: boolean
description: True, if there are any error messages.
Error details are provided in the messages[] array.
example: true
hasWarnings:
type: boolean
description: True, if there are any error messages.
Error details are provided in the messages[] array.
example: true
messages:
type: array
description: Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items:
$ref: '#/components/schemas/ResponseMessageDTO'
totalResultType:
type: string
description: Represents the accumulated result type of the whole transaction. It is filled whenever there are no errors that prevent a check of the transaction.Possible values are:OKINFOCLEAREDCHECKREQUIRECUSTOM_RESTRICTIONRESTRICTIONERROR
example: OK
itemResults:
type: array
description: The results of every item of the transaction. It is filled if at least one item was checked.
items:
$ref: '#/components/schemas/ECItemCheckResultDTO'
description: Represents a response of checking a transaction in Export Controls.
FinalizeApprovalResponseDTO:
type: object
properties:
hasErrors:
type: boolean
description: True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
example: false
hasOnlyRetryableErrors:
type: boolean
description: True, if there are any error messages.
Error details are provided in the messages[] array.
example: true
hasWarnings:
type: boolean
description: True, if there are any error messages.
Error details are provided in the messages[] array.
example: true
messages:
type: array
description: Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items:
$ref: '#/components/schemas/ResponseMessageDTO'
description: Response of /ExportControl/v2/finalizeApproval.
GenericDataRecordDTO:
type: object
properties:
fields:
type: array
description: The fields of the record.
items:
$ref: '#/components/schemas/GenericDataFieldDTO'
subrecords:
type: array
description: Subrecords of the record.
example:
- name: child
record:
fields: []
subrecords: []
items:
$ref: '#/components/schemas/NamedGenericDataRecordDTO'
description: A generic record of data.
Each field is qualified by name and type and has a value.
ECItemCheckResultV2DTO:
type: object
properties:
itemIdHost:
type: string
description: Unique id for the item within the transaction.
resultType:
type: string
description: Represents the accumulated result type of the whole item.
Possible values are:OKINFOCLEAREDCHECKREQUIRECUSTOM_RESTRICTIONRESTRICTIONERROR
example: OK
pluginResults:
type: array
description: The result of every checked jurisdiction of the item.
items:
$ref: '#/components/schemas/ECPluginCheckResultV2DTO'
bomItemResults:
type: array
description: The results for BOM items belonging to this item.
The results of these BOM items will *not* be accumulated into this item result.
items:
$ref: '#/components/schemas/ECItemCheckResultV2DTO'
description: The export control result for one item of the transaction.
ECLicenseReferenceDTO:
type: object
properties:
licenseId:
type: string
description: The license id of the used license. The field is filled, depending on the origin of the license:
In case of- a license from License Management, the internal id of the license is passed, e.g.
00000000000000231543. - a license from Export Controls, the license number of the license with leading prefix "EC_" is passed, e.g.
EC_EU001, EC_AGG09. - no license is required,
NLR is passed. - referencing a license that does not exist in Trade Compliance Management, the field is empty (
null).
example: '00000000000000231543'
licenseItemId:
type: string
description: The id of the license item from a license that has items. For licenses without items, this will be empty.
example: '1'
description: DTO used for referencing a real license and license item.
ECItemDTO:
required:
- decisiveDate
- itemIdHost
type: object
properties:
itemIdHost:
type: string
description: Unique id for the item within the transaction.
example: '4711'
itemLabelHost:
type: string
description: Human-readable label for the item.
example: Positionsnr. = 4711
mainApprovalItemTransIdHost:
maxLength: 255
type: string
description: Unique id of the transaction which includes the item that contains the main approvals. Has to be specified along with the mainApprovalItemIdHost.
mainApprovalItemIdHost:
maxLength: 255
type: string
description: Unique id of the transaction item that contains the main approvals within the transaction of the specified mainApprovalItemTransIdHost (has to be specified along with it).
The item of the main approvals is especially used for automatic creation of partial approvals. If such an item is specified and there is not yet an approval for a certain jurisdiction, the approval will be created as partial approval based on the main approval of the appropriate jurisdiction.
If the parent item does not exist, an error occurs.
Used by /checkTransaction to replace the necessity to specify the main approvals directly using uniqueParentClearingIds.
bomItems:
type: array
description: The BOM (=bill of materials) sub items belonging to this item.
Note that only two-level item hierarchies are allowed, i.e. the bomItems may only contain items that have no bomItems themselves
example:
- itemIdHost: '4711_1'
itemLabelHost: Positionsnr. = 4711-1
items:
$ref: '#/components/schemas/ECItemDTO'
partners:
type: array
description: 'Partners involved in this transaction item.
This array may be used to define partners of the predefined standard roles or partners with other, configured roles.
If there is at least one partner defined in the array, all other partners that can be defined with the deprecated partners fields in this DTO (like *recipient*, etc. will be ignored
Partners of a certain role defined here will replace partners with the same role defined on transaction level. To minimize network traffic, fill the partners on item level only if they differ from the partners on transaction level.
This field will be ignored for BOM items.
The partners of following partner roles are mandatory:CONSIGNOR_STDSELLER_STDCONSIGNEE_STD
For mandatory partners at least the *ECPartnerDTO.countryIso* must be filled.'
items:
$ref: '#/components/schemas/ECPartnerDTO'
ctryProductOrigin:
maxLength: 2
type: string
description: Two-letter ISO code of the country of origin of the goods.
example: DE
decisiveDate:
type: string
description: The decisive date of the transaction. This date will be used to determine country groups and currency rates (which may be both date dependent).
format: date
example: '2015-01-01'
productClassifications:
type: array
description: The attributes of the transaction item, e.g. export control numbers, material number, commodity code and other relevant numbers for export control checks and license matching.
items:
$ref: '#/components/schemas/ECClassificationDTO'
productDataCompletionStatus:
type: array
description: Only relevant when using version 1 for the handling of goods attributes. The completion status indicates whether the product data for DE/EU plug-in and US-EAR plug-in is complete.
Is not supported by /ExportControl/v2/checkTransaction.
When using version 2 for the handling of goods attributes, the completion status can be specified directly via the goods attribute. For not-maintained goods attributes, no classification should be transmitted. To indicate that an item has been classified but is not listed, NOT_LISTED should be transmitted.
items:
$ref: '#/components/schemas/ECCompletionStatusDTO'
identitiesOfGoods:
type: array
description: The identities of goods for this transaction item, e.g. serial numbers, lot numbers, etc.
To ensure to use the same license for the same physical goods between different transactions (inbound, outbound, etc.), these identities may be used for license matching in addition to the product classifications.
items:
$ref: '#/components/schemas/ECIdentityOfGoodsDTO'
descriptionOfGoods1:
maxLength: 40
type: string
description: 'First line of description of commodity.
Maximum length: 40'
example: Description 1
descriptionOfGoods2:
maxLength: 40
type: string
description: 'Second line of description of commodity.
Maximum length: 40'
example: Description 2
descriptionOfGoods3:
maxLength: 40
type: string
description: 'Third line of description of commodity.
Maximum length: 40'
example: Description 3
descriptionOfGoods4:
maxLength: 40
type: string
description: 'Fourth line of description of commodity.
Maximum length: 40'
example: Description 4
finalUsages:
type: string
description: Indicates the end-uses of the goods. Use FINAL_USAGE_NONE or FINAL_USAGE_ALL to indicates that there is no special end-use or all end-uses are possible. Other special end-uses depend on the plug-ins installed and may be separated by ';' if more than one applies.
Possible values are:FINAL_USAGE_NONEFINAL_USAGE_ALLDE-EU-ABC-Nuclear-WeaponsDE-EU-NuclearplantsDE-EU-Conventional-WeaponsDE-EU-IllegalExportedWeaponsDE-EU-Military-ConsigneeDE-EU-Free-Trade-ZoneDE-EU-CyberSurveillance-HumanRights
This field will be ignored for BOM items.
example: FINAL_USAGE_NONE
default: FINAL_USAGE_NONE
valueOfGoods:
type: array
description: The value of the goods, denoted in different currencies. This is either the invoice price or (if no invoice price is known) the statistical value. When checking for the jurisdiction EU, at least the value in EUR should occur in the array, so value limits of general licenses ("Wertfreigrenzen") can be considered. When checking for the jurisdiction US, at least the value in USD should occur in the array, so value limits of license exceptions can be considered.
items:
$ref: '#/components/schemas/ECAmountDTO'
orderNumber:
maxLength: 20
type: string
description: Number of the order (contract) or internal file reference that links to the product/check item.
This field is optional.
example: order-121
quantity:
maxLength: 15
type: number
description: 'The quantity in which the product is exported.
Decimal digits: 3'
format: double
example: 12.0
quantityUnit:
maxLength: 10
type: string
description: The unit of the quantity. Units must be maintained in the master data of Trade Compliance Management. The unit must contain the ident code of the entry in the master data table. This field is usually optional but becomes mandatory if a quantity is given.
example: ST
jurisdictionFilter:
$ref: '#/components/schemas/ECJurisdictionFilterDTO'
customData:
$ref: '#/components/schemas/GenericDataRecordDTO'
description: One item of a transaction to be checked for export control restrictions.
ECIdentityOfGoodsDTO:
type: object
properties:
typeOfIdentity:
type: string
description: The type of the identity of goods, e.g. serial number, lot number, etc.
Each specified type must be maintained in the master data of Trade Compliance Management.
example: SERIAL_NUMBER
value:
type: string
description: The value of the identity of goods.
example: A12
description: Specifies the identity of goods.
ECJurisdictionFilterDTO:
required:
- filterMode
type: object
properties:
filterMode:
type: string
description: The filter mode to apply. Possible values:LIMITINGEXCLUDING
example: LIMITING
jurisdictions:
type: array
description: The jurisdictions to filter for depending on the specified filterMode. Specify at least one jurisdiction to have a valid filter. Additionally, it should not contain jurisdictions that are unknown in Export Controls.
You may use /ComplianceFoundation/getMasterdataIdentifiers to get the possible jurisdictions.
example:
- DE-EU-Plugin
items:
type: string
description: The jurisdictions to filter for depending on the specified filterMode. Specify at least one jurisdiction to have a valid filter. Additionally, it should not contain jurisdictions that are unknown in Export Controls.
You may use /ComplianceFoundation/getMasterdataIdentifiers to get the possible jurisdictions.
example: '["DE-EU-Plugin"]'
description: '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
LIMITING): only the intersection of the enabled jurisdictions (according to the used profile) and the specified jurisdictions is checked, i.e., an enabled jurisdiction is only checked if it is part of the specified jurisdictions of this filter. - Excluding filter mode (value
EXCLUDING): the specified jurisdictions are not checked although they are enabled (according to the used profile).
'
ECPartnerDTO:
required:
- roleIdentCode
type: object
properties:
roleIdentCode:
type: string
description: The ident code of the role of the partner in the transaction. There are some predefined identCode's and others may be configured.
The following predefined role identCodes are supported:CONSIGNOR_STDSELLER_STDBUYER_STDCONSIGNEE_STDENDUSER_STD
example: SELLER_STD
name1:
maxLength: 40
type: string
description: Field 1 for full name of the company/person.
example: Paul
name2:
maxLength: 40
type: string
description: Field 2 for full name of the company/person.
example: Eugene
name3:
maxLength: 40
type: string
description: Field 3 for full name of the company/person.
example: Carl
name4:
maxLength: 40
type: string
description: Field 4 for full name of the company/person.
example: Miller
street:
maxLength: 50
type: string
description: Address - street and number.
example: Main street 10
street2:
maxLength: 50
type: string
description: Address - street 2 and number.
example: Second level
district:
maxLength: 50
type: string
description: Address - district.
example: District of Main
city:
maxLength: 50
type: string
description: Address - city.
example: Main City
postalCode:
maxLength: 20
type: string
description: Address - postal code of the street address (not postal code of P.O. box).
example: '12100'
countryIso:
maxLength: 2
type: string
description: Address - country as two-letter ISO code.
example: DE
poBox:
maxLength: 50
type: string
description: P.O. box.
example: '121200'
postalCodePoBox:
maxLength: 20
type: string
description: Postal code of the P.O. box.
example: '21010'
cityPobox:
maxLength: 50
type: string
description: City of the P.O. box.
example: PO City
customsNumber:
maxLength: 7
type: string
description: German customs number of the company.
example: '1234567'
eoriNumber:
maxLength: 17
type: string
description: The internationally unique identification number of the company assigned by customs. (EORI number - Economic Operators' Registration and Identification).
example: DE012345678912345
establishmentNumber:
maxLength: 4
type: string
description: The number of the respective national office of a company. The EORI number and this identification number will replace the existing customs number.
example: '0000'
companyReference:
maxLength: 20
type: string
description: Internal company number.
example: '12'
isMilitary:
type: boolean
description: Indicates that the company is associated with the armed forces of EC member country. Relevant for the reports about utilized general licenses (AG) that are sent to the BAFA about twice per year
example: false
description: 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, ...
ECPluginCheckResultV2DTO:
type: object
properties:
jurisdiction:
type: string
description: ID of the jurisdiction to which the result belongs.
Possible values are:DE-EU-PluginUS-EAR-PluginCustom-PluginRisk-Assessment-Plugin
Additionally, further jurisdictions may be configured. The IDs of all available jurisdictions of a client can be queried using /ComplianceFoundation/getMasterdataIdentifiers.
example: DE-EU-Plugin
resultType:
type: string
description: Represents the accumulated result type of the item in the specified jurisdiction
Possible values are:OKINFOCLEAREDCHECKREQUIRECUSTOM_RESTRICTIONRESTRICTIONERROR
example: OK
approval:
$ref: '#/components/schemas/ECApprovalInfoV2DTO'
description: The export control result of a jurisdiction checked for a transaction item.
TextInLanguageDTO:
type: object
properties:
languageISOCode:
type: string
description: 2-letter ISO code of the language.
length=2
example: en
text:
type: string
description: The translated text.
example: Some free-form text
description: A translated text in one of the specified languages.
AcknowledgeGetChangedTransactionsRequestDTO:
type: object
properties:
clientSystemId:
type: string
description: 'Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
'
example: TEST_ID
clientIdentCode:
type: string
description: 'Client identification code.
Maximum length: 10
'
example: APITEST
userName:
type: string
description: User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
example: API_TEST
resultLanguageIsoCodes:
type: array
description: 2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example:
- en
- de
items:
type: string
description: 2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
example: '["en","de"]'
syncId:
type: string
description: Synchronization ID for acknowledging.
Use the GetChangedTransactionsResponseDTO.syncId value received with the last call to /ExportControl/v2/getChangedTransactions to acknowledge the processing of the changed results of EC check transactions.
example: '1234'
description: Request to acknowledge changed results of EC check transactions.
ResponseMessageDTO:
type: object
properties:
messageType:
type: string
description: 'Message type
If not stated otherwise, the possible types are:
- ERROR
- WARNING
- INFO
Maximum length: 50
'
example: WARNING
messageIdentCode:
type: string
description: 'Optional identification code for further classification of the message type.
Maximum length: 50
'
example: '5627'
messageTexts:
type: array
description: Detailed message texts in the requested languages.
items:
$ref: '#/components/schemas/TextInLanguageDTO'
indentationLevel:
type: integer
description: The indentation level of the message.
'0' indicates a top level message.
format: int32
example: 0
description: Result messages like errors or warnings.
securitySchemes:
SWAGGER_AUTH_KEY:
type: apiKey
name: X-XNSG_WEB_TOKEN
in: header
BASIC_AUTH:
type: http
scheme: basic
x-refined-from:
- aeb-bsm-openapi.json
- aeb-trade-compliance-management-openapi.json
x-proxy-enabled: false