AEB Logistics Cost Management API
Freight cost management and freight settlement. Exposes billing scenarios, services, rates, settlements, settlement items and invoices so freight charges can be calculated, accrued and reconciled against carrier invoices.
AEB Logistics Cost 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 Freight Cost, Freight Settlement, Billing, Rates, and Logistics. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes 39 operations across 32 paths, organized into 11 resource areas, and defines 102 schemas. It is described by OpenAPI 3.0.1, at version 2.0.
Requests are made against a single base URL, https://rz3.aeb.de/demo1billing/rest.
39 operations
32 paths
102 schemas
4 DELETE15 GET18 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB Logistics Cost 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 39
Across 32 paths, the API surfaces 39 operations — 4 DELETE, 15 GET, 18 POST, 2 PUT. They span 11 resource areas, including BillingScenario, Service, Settlement, SettlementItem, Billing, Rates, Invoices, Logon, and 3 more. Each is listed below with its method, path, parameters, and response codes.
BillingScenario 2
REST API for billing scenarios
GET
/billing-scenarios/{id}
Returns the billing scenario with the requested ID
GET
/billing-scenarios
Returns all billing scenarios matching the given filter criteria. In case no scenario matches the given filter criteria, an empty collection is returned. If the filter field supports place holders ('…
Service 4
REST API for services
GET
/billing-scenarios/{id}/services/{service-id}
Returns the service of the billing scenario with the requested ID
PUT
/billing-scenarios/{id}/services/{service-id}
Create or update a service in a billing scenario with the requested ID. If the service with the given ID does not exist, a new service is created. If the service exists, the existing service is fully…
DELETE
/billing-scenarios/{id}/services/{service-id}
Deletes a service in a billing scenario with the requested ID.
GET
/billing-scenarios/{id}/services
Returns all services of a billing scenario matching the given filter criteria. In case no service matches the given filter criteria, an empty collection is returned. If the filter field supports plac…
Settlement 2
REST API for settlements
GET
/settlements/{id}
get settlement
GET
/settlements
Search settlements
SettlementItem 1
REST API for settlementitems
GET
/settlements/{id}/settlement-items
Search settlements
Billing 10
API for the billing of services
POST
/BillingBFBean/acknowledgeChangedSettlements
acknowledgeChangedSettlements
POST
/BillingBFBean/cancelServiceItems
cancelServiceItems
POST
/BillingBFBean/createServiceItems
createServiceItems
POST
/BillingBFBean/getBillingScenarios
getBillingScenarios
POST
/BillingBFBean/getBillingServices
getBillingServices
POST
/BillingBFBean/getChangedSettlements
getChangedSettlements
POST
/BillingBFBean/getServiceItems
getServiceItems
POST
/BillingBFBean/offsetServiceItems
offsetServiceItems
POST
/BillingBFBean/setServiceMasterFileData
setServiceMasterFileData
POST
/BillingBFBean/simulateCreateServiceItems
simulateCreateServiceItems
Rates 1
API for handling rates
POST
/RateBFBean/updateRateSheetEntries
updateRateSheetEntries
Invoices 3
API for handling external invoices
POST
/ExternalInvoice/acknowledgeChangedExternalInvoices
acknowledgeChangedExternalInvoices
POST
/ExternalInvoice/createExternalInvoices
createExternalInvoices
POST
/ExternalInvoice/getChangedExternalInvoices
getChangedExternalInvoices
Logon 2
Authentication handler for the XNSGFoundation
GET
/logon/authToken
Logon from the "Authorization" header (e.g. type "Basic"). The generated authentication token can be used in subsequent calls in the "Authorization" header, type "Bearer".
POST
/logon/user
Logon with classical procedure: user, client and password.
DataFeedBFBean 3
DataFeedBFBean
POST
/DataFeedBFBean/acknowledgePublishedDataFeedParts
Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.
GET
/DataFeedBFBean/dataFeedParts/{client}/{id}
Retrieve the data feed part content.
POST
/DataFeedBFBean/getPublishedDataFeedParts
Poll data about the next 10 published data feed parts. This data contains an id, which can be used to download the content of a part. To download the content, use the endpoint /DataFeedBFBean/dataFee…
Companies 5
Rest API for companies
GET
/companies/{id}
Returns the company with the requested ID (company number). In some cases the ID (company number) is not unique . In this case an error is returned.
PUT
/companies/{id}
Create or update a company with the specified ID (company number). If the company with the given ID does not exist, a new company is created. If the company exist, the existing company is fully updat…
DELETE
/companies/{id}
Delete the company with the specified ID (company number). The ID is in some AEB services not unique , in this case a conflict (409) is returned.
GET
/companies
Returns all companies matching the given filter criteria. In case no company matches the given filter criteria an empty companies collection is returned. All filter fields are case insensitive. If th…
GET
/company-roles
Returns all company roles of this AEB service. Company roles are domain specific characteristics and can differ between the different AEB services.
WorkstationServiceAgent 6
Connection handler for the Workstation Service Agent
GET
/wssagent/connectdeprecated
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connectdeprecated
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/connection/{id}
Returns response object with information about given workstation service agent.
POST
/wssagent/connection/{id}
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connection/{id}
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/statusdeprecated
Returns response object with information about given workstation service agent.
Schemas 102
The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are SettlementItem (44 properties), BSettlementRestDTO (32 properties), BServiceItemDTO (25 properties), Company (24 properties). Each schema is shown below with its type and property counts.
BillingScenario
object
List of billing scenarios.
2 properties
2 required
BillingScenarioTextTranslation
object
Name of the billing scenario in a certain language.
2 properties
1 required
BillingScenarioList
object
1 property
1 required
Service
object
List of services.
4 properties
3 required
ServiceTextTranslation
object
Name of the service in a certain language.
2 properties
1 required
AebProblem
object
8 properties
AebProblemError
object
Array of related errors
4 properties
ServicePage
object
2 properties
2 required
BAmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
BSettlementCompanyRestDTO
object
Beneficiary company (VAT/context party).
1 property
1 required
BSettlementRestDTO
object
Settlement REST Data Transfer Object containing master data, status flags and monetary totals for a settlement.
32 properties
18 required
BSettlementStatusRestDTO
object
Business object status (workflow / lifecycle state).
2 properties
2 required
PeriodRestDTO
object
Period covered by this settlement item.
3 properties
3 required
SettlementTypeRestDTO
object
Settlement type (workflow classification).
2 properties
2 required
SettlementPage
object
2 properties
2 required
BQuantityDTO
object
Quantities for Billing.
3 properties
BSettlementItemStatusRestDTO
object
Business object status of the settlement item.
2 properties
2 required
BSettlementItemTranslationRestDTO
object
localized descriptions.
2 properties
1 required
CalculationReferencesRestDTO
object
Calculation references (contract/component numbers).
11 properties
ComparisonCodeRestDTO
object
Comparison codes (used for audits / grouping).
2 properties
2 required
CurrencyRateRestDTO
object
Currency rate information for settlement price.
5 properties
SettlementItem
object
Settlement item REST DTO containing pricing, partner and status information, mapped from the BSettlementItem domain object.
44 properties
18 required
VATInfoRestDTO
object
VAT info including rate and type.
4 properties
4 required
BSettlementItemListRestDTO
object
2 properties
2 required
BAcknowledgeChangedSettlementsResponseDTO
object
Response for IBillingBFacknowledgeChangedSettlements.
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
BAcknowledgeChangedSettlementsRequestDTO
object
Request parameter for IBillingBFacknowledgeChangedSettlements.
5 properties
BReverseServiceItemResultDTO
object
Result for one item. Messages for this particular item, e.g. for errors or warnings. The following messageIdentCodes are used: "ITEMRETRANSMISSIONERROR": Retra…
4 properties
BReverseServiceItemsResponseDTO
object
Return value for the the method IBillingBF.cancelServiceItems or IBillingBF.offsetServiceItems
5 properties
BReverseServiceItemsRequestDTO
object
Request parameter for the the method IBillingBF.cancelServiceItems or IBillingBF.offsetServiceItems
6 properties
BServiceItemReferenceDTO
object
A reference identifying a serviceItem.
1 property
BCompanyDTO
object
A complete address of a company for Logistics Cost Management.
18 properties
BCreateServiceItemsResponseDTO
object
Return value for the the method IBillingBF.createServiceItems().
5 properties
BPriceTypeResultDTO
object
Information about a price type in a response.
2 properties
BServiceItemResultDTO
object
Result for one service item, used both by IBillingBFcreateServiceItems and IBillingBFgetServiceItems. --IBillingBFcreateServiceItems-- The following messageIde…
18 properties
BSettlementItemResultDTO
object
A result object for a created or retrieved settlement item.
11 properties
BContactDTO
object
Contains data for contacting a person for Logistics Cost Management.
4 properties
BCreateServiceItemParmsDTO
object
Detailed settings for service item creation.
5 properties
BCreateServiceItemsRequestDTO
object
Request parameter for the the method IBillingBF.createServiceItems()
6 properties
BDateAndZoneDTO
object
Date and zone for Logistics Cost Management.
2 properties
BServiceItemDTO
object
A serviceItem that contains all information for pricing and invoicing.
25 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
BGetBillingScenariosResponseDTO
object
Return value for the the method IBillingBF.getBillingScenarios.
5 properties
ComboboxEntryDTO
object
For common use in BF methods which return combobox entries, e.g. for a list of master file data.
2 properties
BGetBillingScenariosRequestDTO
object
Request parameter for IBillingBFgetBillingsScenarios.
4 properties
BGetBillingServicesResponseDTO
object
Response for IBillingBFgetBillingServices.
5 properties
BGetBillingServicesRequestDTO
object
Request parameter for IBillingBFgetBillingServices.
5 properties
BAccountingItemResultDTO
object
Accounting item of a settlement. Accumulation of settlement items grouped by cost center and VAT.
4 properties
BAccountingScenarioResultDTO
object
Accounting scenario of a settlement.
4 properties
BGetChangedSettlementsResponseDTO
object
Response of IBillingBFgetChangedSettlements.
7 properties
BSettlementSyncDTO
object
Synchronization data of a settlement.
13 properties
BSettlementTypeResultDTO
object
Type of settlement.
1 property
BVatInfoResultDTO
object
Information about a VAT that was applied to prices.
2 properties
BGetChangedSettlementsRequestDTO
object
Request parameter for IBillingBFgetChangedSettlements.
5 properties
BGetServiceItemsResponseDTO
object
Return value for the the method IBillingBF.getServiceItems.
5 properties
BGetServiceItemsRequestDTO
object
Request dto for the the method IBillingBF.getServiceItems.
6 properties
BServiceMFResultDTO
object
Result for one item. Messages for this particular item, e.g. for errors or warnings. The following messageIdentCodes are used: "INVALIDDATAERROR": One of the i…
5 properties
BSetServiceMasterFileDataResponseDTO
object
Reponse of the setServiceData method.
9 properties
BServiceMFDTO
object
Masterfile Transfer data object for a service.
6 properties
BServiceTranslationDTO
object
Text translation DTO for service.
2 properties
1 required
BSetServiceMasterFileDataRequestDTO
object
Request DTO for the setServiceMasterFileData method.
5 properties
BRateSheetEntryFieldDTO
object
Field of a rate sheet entry.
2 properties
1 required
BUpdateRateSheetEntriesResponseDTO
object
Response for RateBFBean/updateRateSheetEntries
5 properties
BUpdateRateSheetOmittedEntryResponseDTO
object
Entries that were obmited because of duplication
5 properties
4 required
BRateSheetEntryUpdateDTO
object
Update data for a rate sheet entry.
5 properties
4 required
BUpdateRateSheetEntriesRequestDTO
object
Request parameter for RateBFBean/updateRateSheetEntries
7 properties
2 required
BAcknowledgeChangedExternalInvoicesResponseDTO
object
Response for IExternalInvoiceBFacknowledgeGetChangedExternalInvoices
4 properties
BAcknowledgeChangedExternalInvoicesRequestDTO
object
Request parameter for IExternalInvoiceBFacknowledgeGetChangedExternalInvoices.
5 properties
BCreateExternalInvoicesResponseDTO
object
Response DTO which contains errors / infos / warnings about data import of external invoices
8 properties
BExternalInvoiceResultDTO
object
Result DTO for external invoice
4 properties
BAttachmentBytesInfoDTO
object
DTO including bytes and some additional data, from which an attachment is created and linked to it's model object.
4 properties
BAttachmentFileInfoDTO
object
DTO for importing references to a file which should be attached to its model object. DTO including an absolute path reference to a file and some additional dat…
2 properties
BCreateExternalInvoicesParmsDTO
object
Request parameter for BCreateExternalInvoicesRequestDTO
1 property
BCreateExternalInvoicesRequestDTO
object
A DTO which contains all data for creating at minimum one external invoice including: - General informations, like data for storing the invoice(s) at the corre…
8 properties
BExternalInvoiceDTO
object
An external invoice that contains all prices and invoice items.
21 properties
BExternalInvoiceItemDTO
object
DTO for external invoice items, used to import external invoices
15 properties
BExternalInvoiceSettlementSyncDTO
object
Synchronization data of a settlement that is associated with an invoice.
8 properties
BExternalInvoiceSyncDTO
object
Synchronization data of an invoice and its associated settlement.
17 properties
BGetChangedExternalInvoicesResponseDTO
object
Response of ExternalInvoiceBFgetChangedExternalInvoices.
7 properties
BGetChangedExternalInvoicesRequestDTO
object
Request parameter for IExternalInvoiceBFgetChangedExternalInvoices.
4 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
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AEB 10
Other APIs AEB publishes across the network.
AEB Customs Management API
AEB Customs Inventory Management API
AEB Customs Broker Portal API
AEB Product Classification API
AEB Trade Compliance Management API
AEB Carrier Connect API
AEB Carrier Select API
AEB Carrier Event Service API
AEB Document Service API
AEB BSM API
#Freight Cost#Freight Settlement#Billing#Rates#Logistics
Where this information came from
This is an independent, third-party profile of AEB Logistics Cost 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.