# AEB Transport & Freight Management API Documentation > AEB Transport & Freight Management Developer Hub ## Guides - [Getting Started](https://transport-freight-management.docs.developers.aeb.com/docs/about-carrier-connect.md) - [Basic features and processes](https://transport-freight-management.docs.developers.aeb.com/docs/learn-about-carrier-connect-and-processes.md) - [Get to know the Object Model](https://transport-freight-management.docs.developers.aeb.com/docs/get-to-know-the-object-model.md) - [Setting up your environment](https://transport-freight-management.docs.developers.aeb.com/docs/setting-up-your-environment.md) - [Code lists for quantity units](https://transport-freight-management.docs.developers.aeb.com/docs/code-lists-1.md) - [Process Integration](https://transport-freight-management.docs.developers.aeb.com/docs/process-integration.md) - [Integration of API calls in your process](https://transport-freight-management.docs.developers.aeb.com/docs/️integration-of-api-calls-in-your-process-v2.md) - [Common Shipping Scenarios](https://transport-freight-management.docs.developers.aeb.com/docs/shipping-order-processing-copy.md) - [API Configuration/Implementation & Field Mapping](https://transport-freight-management.docs.developers.aeb.com/docs/data-integration.md) - [The First Shipment](https://transport-freight-management.docs.developers.aeb.com/docs/the-first-shipment-v2.md): Prepared calls for copy/paste in your development environment - [Important body fields](https://transport-freight-management.docs.developers.aeb.com/docs/important-header-fields.md) - [Carrier, Service, Value-Added Service and Info Text Identifiers](https://transport-freight-management.docs.developers.aeb.com/docs/identcodes-for-carriers-services-value-added-services-and.md): In this section you will learn where to find the correct identifiers for carriers, services, value-added services and info texts. - [Creation Parameters](https://transport-freight-management.docs.developers.aeb.com/docs/creation-parameters-v2.md) - [Process Parameters](https://transport-freight-management.docs.developers.aeb.com/docs/process-parameters.md): The process parameters for a shipment specify which operations have to be performed after a shipment has been created. - [Error Handling](https://transport-freight-management.docs.developers.aeb.com/docs/error-handling-v2.md) - [Create](https://transport-freight-management.docs.developers.aeb.com/docs/create.md): Learn how to use the Carrier Connect API calls to programmatically CREATE new shipments or pickups. - [Update](https://transport-freight-management.docs.developers.aeb.com/docs/process.md): Learn how to use the Carrier Connect API calls to programmatically UPDATE existing shipments or pickups. - [Delete/Cancel](https://transport-freight-management.docs.developers.aeb.com/docs/deletecancel.md): Learn how to use the Carrier Connect API calls to programmatically DELETE or CANCEL existing shipments or pickups. - [Validate](https://transport-freight-management.docs.developers.aeb.com/docs/validate.md): Learn how to validate shipment data before creating a shipping order: - [Sync and Get calls](https://transport-freight-management.docs.developers.aeb.com/docs/sync.md): Learn how to synchronize shipping data programmatically using our sync calls. - [Attach and upload documents to transmit them to the carrier](https://transport-freight-management.docs.developers.aeb.com/docs/transmitting-documents-to-carrier-connect.md) - [Referencing data](https://transport-freight-management.docs.developers.aeb.com/docs/referencing-data.md): Unique and Non-Unique Identifiers for Shipments, Packages, and Items - [Transmitting references & additional information](https://transport-freight-management.docs.developers.aeb.com/docs/additional-values-reference-fields.md) - [Printing](https://transport-freight-management.docs.developers.aeb.com/docs/printing.md) - [Packing Items](https://transport-freight-management.docs.developers.aeb.com/docs/packing-items.md) - [Hazardous goods handling](https://transport-freight-management.docs.developers.aeb.com/docs/hazardous-goods-handling.md) - [Return / pickup order](https://transport-freight-management.docs.developers.aeb.com/docs/return-pickup-order.md) - [Understanding Customer Account Numbers](https://transport-freight-management.docs.developers.aeb.com/docs/account-numbers-in-carrier-connect.md): This paragraph describes how Carrier Connect utilizes customer account numbers (in processing freight costs and duties). - [Carrier specific information](https://transport-freight-management.docs.developers.aeb.com/docs/carrier-specific-information.md) - [Dachser Road Freight (Europe)](https://transport-freight-management.docs.developers.aeb.com/docs/dachser-europe-germany.md) - [Dachser Road Freight (Europe): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/dachser-europe-account-configuration.md) - [DHL Express (Germany)](https://transport-freight-management.docs.developers.aeb.com/docs/dhl-express.md) - [DHL Express (Germany): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/dhl-express-germany-account-configuration.md) - [DHL Freight (Germany)](https://transport-freight-management.docs.developers.aeb.com/docs/dhlfreight.md) - [DHL Freight (Germany): General Information](https://transport-freight-management.docs.developers.aeb.com/docs/copy-of-dhl-freight-germany.md) - [DHL Freight (Germany): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/dhlfreight-account-configuration.md) - [DHL Paket (Germany)](https://transport-freight-management.docs.developers.aeb.com/docs/dhl-paket-germany-1.md) - [DHL Paket (Germany): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/dhl-paket-germany-account-configuration.md) - [DSV Air Freight (Europa)](https://transport-freight-management.docs.developers.aeb.com/docs/dsvairfreight.md) - [DSV Air Freight (Europe): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/dsvairfreight-account-configuration.md) - [FedEx EMEA](https://transport-freight-management.docs.developers.aeb.com/docs/fedex-emea.md) - [FedEx EMEA: Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/fedex-emea-account-configuration.md) - [GLS (Germany)](https://transport-freight-management.docs.developers.aeb.com/docs/gls-germany.md) - [GLS (Germany): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/gls-germany-account-configuration.md) - [Hellmann Landverkehre (Germany)](https://transport-freight-management.docs.developers.aeb.com/docs/hellmann-landverkehr-germany.md) - [Hellmann Landverkehre (Germany): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/hellmann-landverkehr-germany-account-configuration.md) - [Noerpel (Germany)](https://transport-freight-management.docs.developers.aeb.com/docs/noerpel-germany.md) - [Noerpel (Germany): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/noerpel-germany-account-configuration.md) - [Rhenus Freight Logistics (Germany)](https://transport-freight-management.docs.developers.aeb.com/docs/rhenus-freight-germany.md) - [Rhenus Freight Logistics (Germany): Account Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/rhenus-freight-germany-account-configuration.md) - [UPS EMEA](https://transport-freight-management.docs.developers.aeb.com/docs/ups-emea.md) - [UPS EMEA: General Information](https://transport-freight-management.docs.developers.aeb.com/docs/ups-emea-general-info.md) - [UPS EMEA: Carrier Configuration](https://transport-freight-management.docs.developers.aeb.com/docs/ups-emea-carrier-configuration.md) - [UPS EMEA: Services and Value Added Services](https://transport-freight-management.docs.developers.aeb.com/docs/ups-emea-services-and-value-added-services.md) - [UPS EMEA: Collective Customs Clearance: UPS World Ease](https://transport-freight-management.docs.developers.aeb.com/docs/ups-emea-world-ease.md): UPS World Ease allows multiple shipments destined for one country to be consolidated into a single consolidated shipment. In this case, a consolidated shipment is cleared by an appointed importer in the receiving country, who is responsible for paying duties and taxes. Where goods destined for one or more locations within the EU are to be exported from a third country, UPS can simplify the process by arranging for an EU country to serve as the point of entry. - [UPS EMEA: Hazardous Goods](https://transport-freight-management.docs.developers.aeb.com/docs/ups-emea-dangerous-goods.md) - [Synchronizing events](https://transport-freight-management.docs.developers.aeb.com/docs/ces-synchronizing-events.md) - [Retrieving tracking events for specific shipments](https://transport-freight-management.docs.developers.aeb.com/docs/retrieving-tracking-events-for-specific-shipments.md) - [Getting started](https://transport-freight-management.docs.developers.aeb.com/docs/getting-started-2.md) - [Synchronizing settlements and external invoices](https://transport-freight-management.docs.developers.aeb.com/docs/synchronizingsettlements.md) - [Code lists for quantity units](https://transport-freight-management.docs.developers.aeb.com/docs/code-lists-for-quantity-units-copy.md) - [Getting Started](https://transport-freight-management.docs.developers.aeb.com/docs/getting-started-5.md) - [Staged Documents](https://transport-freight-management.docs.developers.aeb.com/docs/document-preparation-staged.md): Documents are created synchronously or asynchronously and a document storage is provided for a limited time. Documents can be tagged with a reference to a related business object and/or document type. Only the first creation of the document creation is subject to a fee. Document updates or creation of additional document contents are free of charge. - [Staged Document Maintenance](https://transport-freight-management.docs.developers.aeb.com/docs/document-maintenance.md): Documents stored in the service can be searched for, retrieved, updated, uploaded and deleted. Some documents allow manual editing of the document data. - [Staged Document Instances](https://transport-freight-management.docs.developers.aeb.com/docs/staged-document-instances.md): The term "Instance" is used to stress out that the staged documents strictly reference predefined document types and reference object instances. Manual configuration of the document types and reference object types is required. Staged document instances support advanced archiving configuration and direct document printing. Each reference object then knows all its document types and offers the document instances for them. - [Printing](https://transport-freight-management.docs.developers.aeb.com/docs/printing-1.md): Requirements of the printing API and how to use it. - [Output Settings](https://transport-freight-management.docs.developers.aeb.com/docs/output-settings.md): Description of configuration settings relevant for document print, preview, editing and archiving. - [Setting up your SAP environment (Document Service)](https://transport-freight-management.docs.developers.aeb.com/docs/platzhalter-1.md): This documentation describes how to use the Document Service from SAP via REST - [Creation of the first document](https://transport-freight-management.docs.developers.aeb.com/docs/platzhalter2.md) ## API Reference - [addShipmentAttachments](https://transport-freight-management.docs.developers.aeb.com/reference/addshipmentattachments.md): Adds attachments to a shipment (e.g. invoices, origin documents, etc.). - [cancelShipment](https://transport-freight-management.docs.developers.aeb.com/reference/cancelshipment.md): Cancels a shipment. - [createPickup](https://transport-freight-management.docs.developers.aeb.com/reference/createpickup.md): Creates a new pickup for the shipments specified in the request.
Depending on the request, an error may be returned when the shipments can't form a single pickup, e.g. when they have different carriers.
Optionally the new pickup can be manifested. That means that the EDI is sent to the carrier if necessary and the pickup will be closed.
When specified in request, the manifest documents are printed. - [createShipment](https://transport-freight-management.docs.developers.aeb.com/reference/createshipment.md): Creates a shipment with the data specified in the shipment request.
An error will be returned when the shipment exists already.
Optionally various operations like label preparation and label output can be applied on the shipment. A complete processing including the pickup assignment is also possible.
The operations are handled asynchronously, so operation processing errors and label documents are not part of the response. They can be retrieved with a syncShipments or getShipments call. - [deleteItem](https://transport-freight-management.docs.developers.aeb.com/reference/deleteitem.md): Deletes an existing item. Packages containing items remain in the shipment and can be packed again with processShipment. Deleting a item is not always possible. It mainly depends on the status of the package containing the item and the shipment. - [deletePackage](https://transport-freight-management.docs.developers.aeb.com/reference/deletepackage.md): Deletes an existing package. Packed items remain unpacked in the shipment and can be packaged again with processShipment. Deleting a package is not always possible. It mainly depends on the status of the package and the shipment. - [deletePickup](https://transport-freight-management.docs.developers.aeb.com/reference/deletepickup.md): Cancels an existing pickup. All shipments are removed from the pickup and must be assigned to a new pickup by another createPickup call.
Warning: EDI data for the existing pickup might have already been sent to the carrier. So check with the carrier that it's fine to cancel the pickup and create a new (differing) one. - [getAllCarriers](https://transport-freight-management.docs.developers.aeb.com/reference/getallcarriers.md): Returns a list of all carrier available for the requested client. - [getCarrierPortfolioDetails](https://transport-freight-management.docs.developers.aeb.com/reference/getcarrierportfoliodetails.md): Returns detailed information about the requested carriers. - [getCarrierPortfolioNames](https://transport-freight-management.docs.developers.aeb.com/reference/getcarrierportfolionames.md): Returns a list of the names of all supported carriers. - [getCarrierProperties](https://transport-freight-management.docs.developers.aeb.com/reference/getcarrierproperties.md): Returns the properties of the requested carrier. - [getPickups](https://transport-freight-management.docs.developers.aeb.com/reference/getpickups.md): Returns detail information about specific pickups. - [getShipments](https://transport-freight-management.docs.developers.aeb.com/reference/getshipments.md): Returns detail information about specific shipments. - [processPackage](https://transport-freight-management.docs.developers.aeb.com/reference/processpackage.md): Allows to perform various operations on an existing package. Especially document preparation and document (label) output can be triggered.
When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a further processPackage call, a syncShipments or getShipments call. - [processPackageReturnEnclosedLabel](https://transport-freight-management.docs.developers.aeb.com/reference/processpackagereturnenclosedlabel.md): Returns a return enclosed label in case of a return shipment. - [processPickup](https://transport-freight-management.docs.developers.aeb.com/reference/processpickup.md): Prints or reprints the manifest documents for the pickup. Mainly to be used, when manifest documents were not printed with the createPickup call or if a reprint of the documents is necessary. - [processShipment](https://transport-freight-management.docs.developers.aeb.com/reference/processshipment.md): Allows to add packages or perform various operations on an existing shipment. Especially document preparation and document (label) output can be triggered.
When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a syncShipments or getShipments call. - [syncPickups](https://transport-freight-management.docs.developers.aeb.com/reference/syncpickups.md): Allows the synchronization of client system transactions with the engine pickups. By the use of a syncId it is possible to return only pickups that have changed between two syncPickups calls. - [syncShipments](https://transport-freight-management.docs.developers.aeb.com/reference/syncshipments.md): Allows the synchronization of client system transactions with the engine shipments. By the use of a syncId it is possible to return only shipments that have changed between two syncShipments calls. - [updateCustomsData](https://transport-freight-management.docs.developers.aeb.com/reference/updatecustomsdata.md): Updates customs data for one existing shipment. Updates data on shipment and item level. Updates customs relevant data only. - [validateShipment](https://transport-freight-management.docs.developers.aeb.com/reference/validateshipment.md): Validates a shipment with the data specified in the shipment request.
Various validation operations can be applied on the shipment to determine, whether the shipment can be processed. - [getShipmentsEvents](https://transport-freight-management.docs.developers.aeb.com/reference/getshipmentsevents.md): Returns the resolved events of the given shipments sorted by CESTrackingEventResponseDTO's eventDate in ascending order, taking the time zone into account. - [synchronizeResolvedEvents](https://transport-freight-management.docs.developers.aeb.com/reference/synchronizeresolvedevents.md): Synchronizes all resolved events that have occurred since the last synchronization call. - [createRoutingTask](https://transport-freight-management.docs.developers.aeb.com/reference/createroutingtask.md): Creates a new routing task and returns a unique task id.

In case of successful creation, the response will contain the unique taskId of the created routing task. The respective routing task can be found by this task id. Proposal calculation starts in an asynchronous process. The current state of calculation can be requested by handing over the provided task id via the call of getRoutingTaskResult(GetRoutingTaskResultRequestDTO) or waitForRoutingTaskResult(WaitForRoutingTaskResultRequestDTO).
- [createSupplementTask](https://transport-freight-management.docs.developers.aeb.com/reference/createsupplementtask.md): Creates a new supplement task and returns a unique task id.

In case of successful creation, the response will contain the unique taskId of the created supplement task. The respective supplement task can be found by this task id. Supplement calculation starts in an asynchronous process. The current state of calculation can be request by handing over the provided task id via the call of getSupplementTaskResult(GetSupplementTaskResultRequestDTO).
- [getAllCarriers](https://transport-freight-management.docs.developers.aeb.com/reference/getallcarriers-1.md): Returns all carriers available for the target client.

This call might help to find the correct identCode of a carrier and service as well as the value-added services belonging to that carrier, which shall be added to the supplement task by using createSupplementTask(CreateSupplementTaskRequestDTO). - [getHandoverPoints](https://transport-freight-management.docs.developers.aeb.com/reference/gethandoverpoints.md): Returns all handover points available for the target client.

Handover points are master file data. This call can be used to choose a handover point from a drop down application. It is not intended that this call is used for master data maintenance or master data synchronization.

The address is not included in the response. - [getRatingProfiles](https://transport-freight-management.docs.developers.aeb.com/reference/getratingprofiles.md): Returns all rating profiles available for the target client.

This call might help to find the correct identCode of a rating profile, which shall be added to the routing task by using createRoutingTask(CreateRoutingTaskRequestDTO). This becomes more important, if a rating profile other than the default profile shall be used for proposal calculation.
- [getRejectedRoutingTaskResult](https://transport-freight-management.docs.developers.aeb.com/reference/getrejectedroutingtaskresult.md): Returns a sorted list of the rejected proposals for the provided task id and its current calculation state.
The rejected proposals are those proposals which were filtered out according to the settings in the rating profile.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).
- [getRoutingRequirementTypes](https://transport-freight-management.docs.developers.aeb.com/reference/getroutingrequirementtypes.md): Returns all requirements and requirement types available for the target client.

This call might help to find the correct identCode of a requirement, which shall be added to the routing task by using createRoutingTask(CreateRoutingTaskRequestDTO).
- [getRoutingTaskResult](https://transport-freight-management.docs.developers.aeb.com/reference/getroutingtaskresult.md): Returns a sorted list of proposals for the provided task id and its current calculation state.

The final list of proposals is ranked according to a rating profile. A rating profile uses supplements for score calculation and ranking.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).
- [getSupplementTaskResult](https://transport-freight-management.docs.developers.aeb.com/reference/getsupplementtaskresult.md): Returns an intermediate result of calculated supplements for the provided task id and its current calculation state.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new supplement task can be created by using createSupplementTask(CreateSupplementTaskRequestDTO).
- [waitForRoutingTaskResult](https://transport-freight-management.docs.developers.aeb.com/reference/waitforroutingtaskresult.md): Waits for the task calculation to finish and returns a sorted list of proposals for the provided task id and its current calculation state.

If the calculation takes longer than the set waiting time limit, the list of proposals will be returned in its current unfinished calculation state as soon as the limit is reached.

The final list of proposals is ranked according to a rating profile. A rating profile uses supplements for score calculation and ranking.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).
- [/billing-scenarios/{id}](https://transport-freight-management.docs.developers.aeb.com/reference/getbillingscenario.md): Returns the billing scenario with the requested ID - [/billing-scenarios](https://transport-freight-management.docs.developers.aeb.com/reference/searchscenarios.md): 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. - [acknowledgeChangedSettlements](https://transport-freight-management.docs.developers.aeb.com/reference/acknowledgechangedsettlements.md): Acknowledge that changed settlements were processed and should no longer be returned by getChangedSettlements. - [cancelServiceItems](https://transport-freight-management.docs.developers.aeb.com/reference/cancelserviceitems.md): Cancel the service items in the Billing engine.
Cancel a service item will try to logically remove the service item with all of its settelement items, if this is possible.
In some cases the cancellation of service items is not (or no longer) possible and will lead to errors.
E.g. the service item can not be found, or some of the settlement items of the service item can not or no longer be logically removed.
The processing of all items will be done in one transaction, so in case of any error, nothing will be persisted. Therefore check the errorFlag and message arrays in the response for any error to detect this case.
- [createServiceItems](https://transport-freight-management.docs.developers.aeb.com/reference/createserviceitems.md): Creates one or more service items. For each BServiceItemDTO included in the BCreateServiceItemsRequestDTO one service item is created. Starts pricing if boolean calculatePriceImmediately in BCreateServiceItemParmsDTO is true and returns the calculated prices. Use this method if you want to invoice and or audit the service items. - [getBillingScenarios](https://transport-freight-management.docs.developers.aeb.com/reference/getbillingscenarios.md): Returns all billing scenarios for the given client - [getBillingServices](https://transport-freight-management.docs.developers.aeb.com/reference/getbillingservices.md): Returns all billing services for the given client and billing scenario as optional parameter. - [getChangedSettlements](https://transport-freight-management.docs.developers.aeb.com/reference/getchangedsettlements.md):

Returns all changed settlements.

This method should be used together with acknowledgeChangedSettlements.

See also BGetChangedSettlementsResponseDTO#syncId - [getServiceItems](https://transport-freight-management.docs.developers.aeb.com/reference/getserviceitems.md): Returns all service items for the given client. - [offsetServiceItems](https://transport-freight-management.docs.developers.aeb.com/reference/offsetserviceitems.md): Offset the service items in the Billing engine.
Offsetting a service item will offset all relevant settlement items of this service item, by creating exact copies of the relevant settlement items with reversed sign.
Depending on customizing, some settlement items will not take part in offsetting the service item and some settlement items will prevent any offsetting at all, which leads to an error.
The processing of all items will be done in one transaction, so in case of any error, nothing will be persisted. Therefore check the errorFlag and error message arrays in the response for any error to detect this case.
- [setServiceMasterFileData](https://transport-freight-management.docs.developers.aeb.com/reference/setservicemasterfiledata.md): Create or update multiple Services in the Billing engine.
Create or update multiple services in the master file data of the engine. Because of performance and transactional issues it is recommended to transfer about 100 services within one synchronous call. All transfered services will be either created or updated. The identCode and scenarioIdentCode (these are key values) of the service will be checked before processing. In case of any unfilled key value, nothing will be done. In case of other problems for a single service e.g locking or invalid identCode values the processing is usually continued with the next service, skipping, the problematic service. This means the record will be skipped completely and processing will continue with the next service. Anyway such errors will set the hasErrors or hasWarnings to true. To analyse situations check the response for details. Possible messageIdentCodes are documented in AbstractResponseDTO, BSetServiceMasterFileDataResponseDTO, BServiceMFResultDTO, AbstractResponseItemDTO and BServiceMFResultDTO - [simulateCreateServiceItems](https://transport-freight-management.docs.developers.aeb.com/reference/simulatecreateserviceitems.md): This method does the same as createServiceItems, but does not store the results in the database.
So this method can e.g. be used to precalculate prices for potential service items or just for testing purposes. - [updateRateSheetEntries](https://transport-freight-management.docs.developers.aeb.com/reference/updateratesheetentries.md): Updates entries of a rate sheet. If any errors occur no entry will be changed. - [acknowledgeChangedExternalInvoices](https://transport-freight-management.docs.developers.aeb.com/reference/acknowledgechangedexternalinvoices.md): Acknowledge that changed external invoices were processed and should no longer be returned by getChangedExternalInvoices. - [createExternalInvoices](https://transport-freight-management.docs.developers.aeb.com/reference/createexternalinvoices.md): Creates one external invoice for every BExternalInvoiceDTO included in the BCreateExternalInvoicesRequestDTO. - [getChangedExternalInvoices](https://transport-freight-management.docs.developers.aeb.com/reference/getchangedexternalinvoices.md):

Returns all changed external invoices.

This method should be used together with acknowledgeChangedExternalInvoices.

See also BGetChangedExternalInvoicesResponseDTO#syncId - [getWorkstations](https://transport-freight-management.docs.developers.aeb.com/reference/getworkstations.md):

Fetch all registered workstations

Returns an information about all registered workstations as json or xml list.

- [parseDocumentTemplateContent](https://transport-freight-management.docs.developers.aeb.com/reference/parsedocumenttemplatecontent.md):

Parse document

Parses the referenced template data and returns the required information, as specified in the parse query parameters. The supported query parameters are individual to each document processor. The referenced template must already exist in the system.

- [queryDocumentTemplates](https://transport-freight-management.docs.developers.aeb.com/reference/querydocumenttemplates.md):

Query information on document templates

Returns a list of available templates for the specified processor. The templates are resolved in the context of a session client. Processor parameter is optional; templates for all supported processors are returned when empty.

- [openPrintRequestQueue](https://transport-freight-management.docs.developers.aeb.com/reference/openprintrequestqueue.md):

Get URL to print queue

Returns print request queue in url.

- [openStagedDocumentEditor](https://transport-freight-management.docs.developers.aeb.com/reference/openstageddocumenteditor.md):

Get URL to edit document

Returns document editor url.

- [openStagedDocumentSearch](https://transport-freight-management.docs.developers.aeb.com/reference/openstageddocumentsearch.md):

Get URL to search document

Returns document search link.

- [queryDocuments](https://transport-freight-management.docs.developers.aeb.com/reference/querydocuments.md):

Query information on existing documents

Executes a search query on the documents stored in the document storage. Only the documents that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

Date time interval range filter

Use one of the given attributes to pass the filter. If more than one attribute is filled attributes will be used in the following order: relative interval, absolute interval

- [createDocument](https://transport-freight-management.docs.developers.aeb.com/reference/createdocument.md):

Upload an external document

Uploads an external document (which does not depend on any document templates). Like `POST /document`, the uploaded document can be queried, deleted and fetched by calling the corresponding method with the received `documentId`. The document also has a date to which it is at least stored in the document store.
Currently only PDF documents up to a maximum size of 10MB are supported, without embedded links, scripts or attachments.

- [createDocument](https://transport-freight-management.docs.developers.aeb.com/reference/createdocument_1.md):

Generate a new document either synchronously (wait for the result) or asynchronously (enqueue document creation and get the result later with the provided documentId).

Creates a document from the referenced template and document data. The template is resolved in the context of the session client. If any of the Staging options is filled the created document contents will be retained for later reuse.
An existing document can be updated in `POST /document/{documentId}` and stored as a new revision in the archive in case it was previously archived.
The update can be done in different ways, see the description for `POST /document/{documentId}` - [createDocumentTrusted](https://transport-freight-management.docs.developers.aeb.com/reference/createdocumenttrusted.md):

Upload an external document

Access is restricted to the `I_DOCUMENTSERVICEBF_TRUSTED` role.

Like `PUT /document` but with less limitations to the uploaded contents.

- [getDocument](https://transport-freight-management.docs.developers.aeb.com/reference/getdocument.md):

Download an existing document content

Returns the requested document content if it is available for the user. A document may contain several contents, so the user has to define which content to return by the documentId and the variant.

- [updateDocument](https://transport-freight-management.docs.developers.aeb.com/reference/updatedocument.md):

Upload an external document

Uploads an external document (which does not depend on any document templates). Like `POST /document/{documentId}` the uploaded document can be queried, deleted and fetched by calling the corresponding method with received `documentId`. The document also has a date to which it is at least stored in the document store.
Currently only PDF documents up to a maximum size of 10MB are supported, without embedded links, scripts or attachments.

- [updateDocument](https://transport-freight-management.docs.developers.aeb.com/reference/updatedocument_1.md):

Update an existing document or generate it in a different format either synchronously (wait for the result) or asynchronously (enqueue document creation and get the result later with the documentId).

Possibilities to update the stored document contents:

If the stored document is archived a new revision will be created in the connected archive. - [deleteDocument](https://transport-freight-management.docs.developers.aeb.com/reference/deletedocument.md):

Delete an existing document

Deletes the document with the requested documentId.

- [queryDocumentsById](https://transport-freight-management.docs.developers.aeb.com/reference/querydocumentsbyid.md):

Query information on existing documents

Executes a search query on the documents stored in the document storage. Only the documents that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

Date time interval range filter

Use one of the given attributes to pass the filter. If more than one attribute is filled attributes will be used in the following order: relative interval, absolute interval

- [queryDocumentsByRef](https://transport-freight-management.docs.developers.aeb.com/reference/querydocumentsbyref.md):

Query information on existing documents

Executes a search query on the documents stored in the document storage. Only the documents that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

Date time interval range filter

Use one of the given attributes to pass the filter. If more than one attribute is filled attributes will be used in the following order: relative interval, absolute interval

- [updateDocumentTrusted](https://transport-freight-management.docs.developers.aeb.com/reference/updatedocumenttrusted.md):

Upload an external document

Access is restricted to the `I_DOCUMENTSERVICEBF_TRUSTED` role.

Like `PUT /document/{documentId}` but with less limitations to the uploaded contents.

- [getDocumentInstance](https://transport-freight-management.docs.developers.aeb.com/reference/getdocumentinstance.md):

Download an existing document content

Returns the document instance for the given reference object and document type.

- [updateDocumentInstance](https://transport-freight-management.docs.developers.aeb.com/reference/updatedocumentinstance.md):

Update specified document instance.

Uploads an external document which does not depend on templates of the document. The document type and reference object are resolved in the context of the session client. The archive options are defined in the referenced document type. Like POST /documentInstance/{referenceType}/{referenceNumber}/{documentType} the uploaded document can be queried, deleted and fetched by calling the corresponding method with the received documentId.The document also has a date to which this document is at least stored in the document store.
Currently only PDF up to a maximum size of 10MB is supported.

- [createDocumentInstance](https://transport-freight-management.docs.developers.aeb.com/reference/createdocumentinstance.md):

Generate a new document instance.

Prepares a document immediately within response or asynchronously from the referenced document type and document data. The document type and reference object are resolved in the context of the session client. The output format and archive options are defined in the referenced document type. Created documents are retained for later reuse, e.g. fetching or printing the document. The caller can fetch the document contents by calling GET /document/{documentId} with the received documentId or GET /documentInstance/{referenceType}/{referenceNumber}/{documentType}. An existing document can be updated by specifying the reference object and stored as a new revision in the archive if it has to be or was previously archived.

- [deleteDocumentInstance](https://transport-freight-management.docs.developers.aeb.com/reference/deletedocumentinstance.md):

Delete an existing document instance

Deletes the document instance for the given reference object and document type.

- [getDocumentReferenceObject](https://transport-freight-management.docs.developers.aeb.com/reference/getdocumentreferenceobject.md):

Find one document reference object

Returns the requested document reference object if it is available for the user.

- [updateDocumentReferenceObject](https://transport-freight-management.docs.developers.aeb.com/reference/updatedocumentreferenceobject.md):

Create or update document reference object.

Creates new or updates existing document reference object.

- [deleteDocumentReferenceObject](https://transport-freight-management.docs.developers.aeb.com/reference/deletedocumentreferenceobject.md):

Delete an existing document reference object

Deletes the document reference object with the requested referenceType and referenceNumber along with all its documents (optionally the documents can be preserved).

- [getPrintRequest](https://transport-freight-management.docs.developers.aeb.com/reference/getprintrequest.md):

Get information on print request state

Returns the state of a print request identified by its unique ID (obtained by POST /documentInstance/{documentId}/print).

- [updatePrintRequest](https://transport-freight-management.docs.developers.aeb.com/reference/updateprintrequest.md):

Update print request

Updates a print request identified by its unique ID (obtained by POST /documentInstance/{documentId}/print) with a specific action.

- [deletePrintRequest](https://transport-freight-management.docs.developers.aeb.com/reference/deleteprintrequest.md):

Delete print request.

Removes a specific print request identified by its unique ID (obtained by POST /documentInstance/{documentId}/print).

- [getDocumentInstances](https://transport-freight-management.docs.developers.aeb.com/reference/getdocumentinstances.md):

Query information on existing document instances

Returns the document instances for the given reference object.

- [getPrintRequests](https://transport-freight-management.docs.developers.aeb.com/reference/getprintrequests.md):

Get information on print requests

Returns list of all print requests for the specified queue (default: active only). The state of the queue may influence the individual request states.

- [printDocumentInstance](https://transport-freight-management.docs.developers.aeb.com/reference/printdocumentinstance.md):

Create a print request for document instance.

Creates a print request for the requested document. The document must have been created by POST /documentInstance/{referenceType}/{referenceNumber}/{documentType} and defined by its documentId.The printing location depends on the session context (e.g. user/client or workstation) and the printing output settings in the document type of the document.

The print request is processed asynchronously and may fail if the cloud printing server service is not started on the target machine. When the print request is processed the actual content of the document will be printed, e.g. if the document has been changed since the print request was created the changes will be printed.

- [queryDocumentReferenceObjects](https://transport-freight-management.docs.developers.aeb.com/reference/querydocumentreferenceobjects.md):

Search document reference objects

Executes a search query on the document reference objects. Only the document reference objects that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

- [updateDocumentInstanceTrusted](https://transport-freight-management.docs.developers.aeb.com/reference/updatedocumentinstancetrusted.md):

Generate a new document instance.

Access is restricted to I_DOCUMENTSERVICEBF_TRUSTED role.

Like PUT /documentInstance/{referenceType}/{referenceNumber}/{documentType} but with less limitations to the uploaded contents.

- [getProcessorInfo](https://transport-freight-management.docs.developers.aeb.com/reference/getprocessorinfo.md):

Fetch processor detailed information

Returns an information on functions and/or features supported by the processor.
Supported output formats are controlled by Accept header. Currently only application/json and application/xml are available.

- [getSupportedProcessors](https://transport-freight-management.docs.developers.aeb.com/reference/getsupportedprocessors.md):

Fetch supported processors

Collects tags of all document processors that are supported in this service.

## Changelog - [View all new features and changes in our Release Notes](https://transport-freight-management.docs.developers.aeb.com/changelog/view-all-new-features-and-changes-in-our-release-notes.md) - [Welcome to the Carrier Connect API documentation](https://transport-freight-management.docs.developers.aeb.com/changelog/welcome-to-carrier-connect-api.md)