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.
{
"openapi" : "3.0.1",
"info" : {
"title" : "Logistics Cost Management HTTP API",
"description" : "Thank you for using our HTTP API documentation.",
"version" : "2.0"
},
"servers" : [ {
"url" : "https://rz3.aeb.de/demo1billing/rest"
} ],
"security" : [ {
"SWAGGER_AUTH_KEY" : [ ]
}, {
"BASIC_AUTH" : [ ]
} ],
"tags" : [ {
"name" : "BillingScenario",
"description" : "REST API for billing scenarios"
}, {
"name" : "Service",
"description" : "REST API for services"
}, {
"name" : "Settlement",
"description" : "REST API for settlements"
}, {
"name" : "SettlementItem",
"description" : "REST API for settlementitems"
}, {
"name" : "Billing",
"description" : "API for the billing of services"
}, {
"name" : "Rates",
"description" : "API for handling rates"
}, {
"name" : "Invoices",
"description" : "API for handling external invoices"
}, {
"name" : "Logon",
"description" : "Authentication handler for the XNSGFoundation"
}, {
"name" : "DataFeedBFBean",
"description" : "DataFeedBFBean"
}, {
"name" : "Companies",
"description" : "Rest API for companies"
}, {
"name" : "WorkstationServiceAgent",
"description" : "Connection handler for the Workstation Service Agent"
} ],
"paths" : {
"/billing-scenarios/{id}" : {
"get" : {
"tags" : [ "BillingScenario" ],
"description" : "Returns the billing scenario with the requested ID",
"operationId" : "getBillingScenario",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The requested ID of the billing scenario.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "001"
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BillingScenario"
},
"examples" : {
"Billing scenario entry" : {
"description" : "Billing scenario entry",
"value" : {
"identCode" : "001",
"translations" : [ {
"language" : "DE",
"description" : "001"
}, {
"language" : "EN",
"description" : "001"
} ]
}
}
}
}
}
},
"404" : {
"description" : "Requested billing scenario does not exist.",
"content" : {
"application/json" : {
"examples" : {
"Billing scenario not found" : {
"description" : "Billing scenario not found",
"value" : {
"errorMessage" : "Kein Billingszenario mit dem Kürzel '001' gefunden."
}
}
}
}
}
}
}
}
},
"/billing-scenarios" : {
"get" : {
"tags" : [ "BillingScenario" ],
"description" : "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 ('*' or '%'), all scenarios beginning with the value of the filter are returned. I.e. a place holder at the end of the filter value is added automatically.",
"operationId" : "searchScenarios",
"parameters" : [ {
"name" : "ident_code_like",
"in" : "query",
"description" : "Filters billing scenarios by ident code.<br>In the example, all scenarios which include '0' are returned.<br>This filter field is case insensitive.<br>Place holders are supported. The ident code is unique.",
"schema" : {
"maxLength" : 50,
"minLength" : 0,
"type" : "string"
},
"example" : "*0*"
}, {
"name" : "description_code_like",
"in" : "query",
"description" : "Filters billing scenarios by description.<br>In the example, all scenarios which include 'A' in the description are returned.<br>This filter field is case insensitive.<br>Place holders are supported.",
"schema" : {
"maxLength" : 250,
"minLength" : 0,
"type" : "string"
},
"example" : "*A*"
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BillingScenarioList"
},
"examples" : {
"Billing scenario list" : {
"description" : "Billing scenario list",
"value" : {
"content" : [ {
"identCode" : "001",
"translations" : [ {
"language" : "DE",
"description" : "001"
}, {
"language" : "EN",
"description" : "001"
} ]
}, {
"identCode" : "002",
"translations" : [ {
"language" : "DE",
"description" : "002"
}, {
"language" : "EN",
"description" : "002"
} ]
} ]
}
}
}
}
}
}
}
}
},
"/billing-scenarios/{id}/services/{service-id}" : {
"get" : {
"tags" : [ "Service" ],
"description" : "Returns the service of the billing scenario with the requested ID",
"operationId" : "getService",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The requested ID of the billing scenario.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "001"
}, {
"name" : "service-id",
"in" : "path",
"description" : "The requested ID of the service.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "UPS_EXPR"
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Service"
},
"examples" : {
"Service entry" : {
"description" : "Service entry",
"value" : {
"identCode" : "DHL_EXPR_INT1030",
"translations" : [ {
"language" : "DE",
"description" : "DHL Express International 10:30 Uhr (USA)"
}, {
"language" : "EN",
"description" : "DHL Express International 10:30 (USA)"
} ],
"attribute" : "DHL",
"quantityUnitType" : "QUANTITY"
}
}
}
}
}
},
"404" : {
"description" : "Requested carrier setup does not exist.",
"content" : {
"application/json" : {
"examples" : {
"Service not found" : {
"description" : "Service not found",
"value" : {
"errorMessage" : "Kein Leistungstyp mit dem Kürzel 'UPS_EXPR' für das Billingszenario '001' gefunden."
}
}
}
}
}
}
}
},
"put" : {
"tags" : [ "Service" ],
"description" : "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 updated. Not filled fields in the request are treated thereby as empty data fields and lead to empty fields in an existing service. It is therefore recommended to use GET/billing-scenarios/{id}/services to check whether a service with an ID already exists BEFORE you use PUT/billing-scenarios/{id}/services/{service-id}",
"operationId" : "createOrUpdateService",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The requested ID of the billing scenario.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "001"
}, {
"name" : "service-id",
"in" : "path",
"description" : "The requested ID of the service.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "UPS_EXPR"
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Service"
},
"examples" : {
"Service request" : {
"description" : "Service request",
"value" : {
"identCode" : "DHL_EXPR_INT1030",
"translations" : [ {
"language" : "DE",
"description" : "DHL Express International 10:30 Uhr (USA)"
}, {
"language" : "EN",
"description" : "DHL Express International 10:30 (USA)"
} ],
"attribute" : "DHL",
"quantityUnitType" : "QUANTITY"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Service"
},
"examples" : {
"Service entry" : {
"description" : "Service entry",
"value" : {
"identCode" : "DHL_EXPR_INT1030",
"translations" : [ {
"language" : "DE",
"description" : "DHL Express International 10:30 Uhr (USA)"
}, {
"language" : "EN",
"description" : "DHL Express International 10:30 (USA)"
} ],
"attribute" : "DHL",
"quantityUnitType" : "QUANTITY"
}
}
}
}
}
},
"400" : {
"description" : "Locking error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AebProblem"
}
}
}
},
"404" : {
"description" : "Requested billing scenario does not exist.",
"content" : {
"application/json" : {
"examples" : {
"Service not found" : {
"description" : "Service not found",
"value" : {
"errorMessage" : "Kein Leistungstyp mit dem Kürzel 'UPS_EXPR' für das Billingszenario '001' gefunden."
}
}
}
}
}
}
}
},
"delete" : {
"tags" : [ "Service" ],
"description" : "Deletes a service in a billing scenario with the requested ID.",
"operationId" : "deleteService",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The requested ID of the billing scenario.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "001"
}, {
"name" : "service-id",
"in" : "path",
"description" : "The requested ID of the service.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "UPS_EXPR"
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Service"
},
"examples" : {
"Service entry" : {
"description" : "Service entry",
"value" : {
"identCode" : "DHL_EXPR_INT1030",
"translations" : [ {
"language" : "DE",
"description" : "DHL Express International 10:30 Uhr (USA)"
}, {
"language" : "EN",
"description" : "DHL Express International 10:30 (USA)"
} ],
"attribute" : "DHL",
"quantityUnitType" : "QUANTITY"
}
}
}
}
}
},
"400" : {
"description" : "Locking error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AebProblem"
}
}
}
},
"404" : {
"description" : "Requested billing scenario does not exist.",
"content" : {
"application/json" : {
"examples" : {
"Billing scenario not found" : {
"description" : "Billing scenario not found",
"value" : {
"errorMessage" : "Kein Billingszenario mit dem Kürzel '001' gefunden."
}
}
}
}
}
}
}
}
},
"/billing-scenarios/{id}/services" : {
"get" : {
"tags" : [ "Service" ],
"description" : "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 place holders ('*' or '%'), all scenarios beginning with the value of the filter are returned. I.e. a place holder at the end of the filter value is added automatically.",
"operationId" : "searchServices",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The requested ID of the billing scenario.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "001"
}, {
"name" : "ident_code_like",
"in" : "query",
"description" : "Filter services by ident code.<br>In the example, all services which include 'UPS' are returned.<br>This filter field is case insensitive.<br>Place holders are supported. The ident code is unique for one billing scenario.",
"schema" : {
"maxLength" : 50,
"minLength" : 0,
"type" : "string"
},
"example" : "*UPS*"
}, {
"name" : "description_like",
"in" : "query",
"description" : "Filter services by description.<br>In the example, all services which include 'UPS' in the description are returned.<br>This filter field is case insensitive.<br>Place holders are supported.",
"schema" : {
"maxLength" : 250,
"minLength" : 0,
"type" : "string"
},
"example" : "*UPS*"
}, {
"name" : "attribute_like",
"in" : "query",
"description" : "Filter services by attribute.<br>In the example, all services which include 'A' in the attribute are returned.<br>This filter field is case insensitive.<br>Place holders are supported.",
"schema" : {
"maxLength" : 75,
"minLength" : 0,
"type" : "string"
},
"example" : "*A*"
}, {
"name" : "offset",
"in" : "query",
"description" : "The starting point from which to return elements of the ordered list.<br><i>Minimum : 0</i>",
"schema" : {
"minimum" : 0,
"type" : "integer",
"format" : "int32",
"default" : 0
},
"example" : 0
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of elements to be returned from the ordered list.<br><i>Minimum : 1</i><br><i>Maximum : 1000</i>",
"schema" : {
"maximum" : 1000,
"minimum" : 1,
"type" : "integer",
"format" : "int32",
"default" : 1000
},
"example" : 200
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServicePage"
},
"examples" : {
"Service list" : {
"description" : "Service list",
"value" : {
"totalElements" : 2,
"content" : [ {
"identCode" : "DHL_EXPR_INT1030",
"translations" : [ {
"language" : "DE",
"description" : "DHL Express International 10:30 Uhr (USA)"
}, {
"language" : "EN",
"description" : "DHL Express International 10:30 (USA)"
} ],
"attribute" : "DHL",
"quantityUnitType" : "QUANTITY"
}, {
"identCode" : "DHL_EXPR_WORLD",
"translations" : [ {
"language" : "DE",
"description" : "DHL Express Worldwide"
}, {
"language" : "EN",
"description" : "DHL Express Worldwide"
} ],
"attribute" : "DHL",
"quantityUnitType" : "QUANTITY"
} ]
}
}
}
}
}
}
}
}
},
"/settlements/{id}" : {
"get" : {
"tags" : [ "Settlement" ],
"summary" : "get settlement",
"description" : "Returns the settlement with the requested ID",
"operationId" : "getSettlement",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The Settlementnumber of the requested Settlement.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "000001"
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BSettlementRestDTO"
},
"examples" : {
"Settlement entry" : {
"description" : "Settlement entry",
"value" : {
"settlementNumber" : "SETTL-2025-000123",
"createdAt" : "2025-10-01T08:15:30Z",
"lastDispoDate" : "2025-10-02T09:20:00Z",
"lastDispoUserLoginName" : "jane.doe",
"settlementType" : {
"identCode" : "STANDARD",
"scenIdentCode" : "SCEN_MAIN"
},
"referenceNumber" : "EXT-REF-456",
"additionalReferenceNumber1" : "CUST-ADD-01",
"numberOfCancelledSettlement" : "0",
"settlementDate" : "2025-10-01",
"chargeDateMin" : "2025-09-01",
"chargeDateMax" : "2025-09-30",
"valueDate" : "2025-10-03",
"provider" : {
"companyNo" : "PROV001"
},
"orderer" : {
"companyNo" : "ORD001"
},
"payer" : {
"companyNo" : "PAY001"
},
"isDataReady" : true,
"isCompiled" : false,
"isCumulated" : false,
"isReleased" : false,
"isCompleted" : false,
"isAutoConfirmStatusSuppressed" : false,
"boStatus" : {
"statusID" : 200,
"dirty" : false,
"identCode" : "READY",
"error" : false
},
"isCancelled" : false,
"cancellationType" : null,
"isAnnulation" : false,
"settlementItemRevisionNumber" : 1,
"note" : "Quarterly settlement for September.",
"processingIdentCode" : "PROC_MAIN",
"totalSettlNetPrice" : {
"value" : 1000.0,
"currency" : "EUR"
},
"totalSettlGrsPrice" : {
"value" : 1190.0,
"currency" : "EUR"
},
"totalSettlClNetPrice" : {
"value" : 1065.0,
"currency" : "USD"
},
"totalSettlClGrsPrice" : {
"value" : 1267.35,
"currency" : "USD"
},
"totalSettlVatPrice" : {
"value" : 190.0,
"currency" : "EUR"
},
"totalSettlClVatPrice" : {
"value" : 202.35,
"currency" : "USD"
},
"rateDateClPrice" : "2025-09-30",
"usdSpltFlds" : {
"usePayer" : true,
"useProvider" : true,
"useSettlCurrency" : true,
"useSettlType" : true,
"useBillingScenario" : true,
"useOrderer" : false,
"usePeriod" : true,
"useService" : true,
"useOrderNumber" : false,
"useClientOrga" : false
},
"period" : {
"start" : "2025-09-01",
"end" : "2025-09-30",
"type" : "MONTH"
},
"service" : {
"identCode" : "SRV_TRANSPORT",
"description" : "International Transport"
},
"billingScenario" : {
"identCode" : "BILL_SCEN_STD"
},
"contractNumber" : "CON-778899",
"orderNumber" : "ORD-556677",
"clientOrgaId" : "CL001",
"paymentTerm" : {
"identCode" : "NET30",
"description" : "Net 30 Days"
},
"paymentMethod" : {
"identCode" : "BANK_TRANSFER",
"description" : "Bank Transfer"
},
"isPartiallyDeleted" : false,
"archiveInfo" : {
"archiveState" : "NEW",
"archivedAt" : "2025-10-01T08:15:30Z",
"archiveId" : "ARCH-00001",
"transactionId" : "TX-123456789",
"onRetrySince" : "2025-10-01T08:15:30Z"
},
"storageAdapterId" : "S3-STORAGE-01"
}
}
}
}
}
},
"404" : {
"description" : "Requested settlement does not exist.",
"content" : {
"application/json" : {
"examples" : {
"Settlement not found" : {
"description" : "Settlement not found",
"value" : {
"error" : "No settlement with the ID '0001' found."
}
}
}
}
}
}
}
}
},
"/settlements" : {
"get" : {
"tags" : [ "Settlement" ],
"summary" : "Search settlements",
"description" : "Returns all settlements matching the given filter criteria. In case no settlement matches, an empty collection is returned. Supports wildcards in filter fields.",
"operationId" : "searchSettlements",
"parameters" : [ {
"name" : "settlement_number_like",
"in" : "query",
"description" : "Filter settlements by Settlementnumber. Place holders are supported.",
"schema" : {
"maxLength" : 50,
"minLength" : 0,
"type" : "string"
},
"example" : "000001"
}, {
"name" : "settlement_type_like",
"in" : "query",
"description" : "Filter settlements by Settlementtype. Place holders are supported.",
"schema" : {
"maxLength" : 50,
"minLength" : 0,
"type" : "string"
},
"example" : "Storno"
}, {
"name" : "billing_scenario_like",
"in" : "query",
"description" : "Filter settlements by Billingscenario. Place holders are supported.",
"schema" : {
"maxLength" : 50,
"minLength" : 0,
"type" : "string"
},
"example" : "CAI"
}, {
"name" : "provider_like",
"in" : "query",
"description" : "Filter settlements by Provider companyNo. Place holders are supported.",
"schema" : {
"maxLength" : 50,
"minLength" : 0,
"type" : "string"
},
"example" : "UPS"
}, {
"name" : "status_list",
"in" : "query",
"description" : "Filter settlements by status code. Possible Status Codes are: READY, COMPILED, RELEASED, COMPLETE, CANCELLED Place holders are supported.",
"schema" : {
"maxItems" : 50,
"minItems" : 0,
"type" : "array",
"items" : {
"type" : "string"
}
},
"example" : [ "READY", "COMPILED" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "The starting point from which to return elements of the ordered list.<br><i>Minimum : 0</i>",
"schema" : {
"minimum" : 0,
"type" : "integer",
"format" : "int32",
"default" : 0
},
"example" : 0
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of elements to be returned from the ordered list.<br><i>Minimum : 1</i><br><i>Maximum : 1000</i>",
"schema" : {
"maximum" : 1000,
"minimum" : 1,
"type" : "integer",
"format" : "int32",
"default" : 1000
},
"example" : 200
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SettlementPage"
}
}
}
},
"400" : {
"description" : "Invalid Status.",
"content" : {
"application/json" : {
"examples" : {
"Invalid Status" : {
"description" : "Invalid Status",
"value" : {
"error" : "Invalid status 'Status'."
}
}
}
}
}
}
}
}
},
"/settlements/{id}/settlement-items" : {
"get" : {
"tags" : [ "SettlementItem" ],
"summary" : "Search settlements",
"description" : "Returns all settlement items matching the given filter criteria. In case no settlement items matches, an empty collection is returned. Supports wildcards in filter fields.",
"operationId" : "searchSettlementItem",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The Settlementnumber of the requested Settlement.",
"required" : true,
"schema" : {
"type" : "string"
},
"example" : "000001"
}, {
"name" : "offset",
"in" : "query",
"description" : "The starting point from which to return elements of the ordered list.<br><i>Minimum : 0</i>",
"schema" : {
"minimum" : 0,
"type" : "integer",
"format" : "int32",
"default" : 0
},
"example" : 0
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of elements to be returned from the ordered list.<br><i>Minimum : 1</i><br><i>Maximum : 1000</i>",
"schema" : {
"maximum" : 1000,
"minimum" : 1,
"type" : "integer",
"format" : "int32",
"default" : 1000
},
"example" : 200
} ],
"responses" : {
"200" : {
"description" : "Successful call.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SettlementItem"
},
"examples" : {
"Settlement entry" : {
"description" : "Settlement entry",
"value" : {
"orderNumber" : "ORD-556677",
"serviceItemId" : "SRVITEM-00042",
"numberInServiceItem" : 1,
"referenceNumber" : "REF-456",
"serviceItemDescription" : "International freight – sea FCL",
"orderDate" : "2025-09-10",
"referenceDate" : "2025-09-15",
"chargeDate" : "2025-09-20",
"serviceDate" : "2025-09-21",
"createdAt" : "2025-09-21T14:22:05Z",
"isCancelled" : false,
"boStatus" : {
"statusID" : 210,
"dirty" : false,
"identCode" : "ITEM_READY",
"error" : false
},
"clientSystemId" : "CLIENT_SYS_A",
"cli
# --- truncated at 32 KB (283 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-logistics-cost-management-openapi.json