Sales Invoice Push API
v 1.0.0
Division: DHL Freight

Sales Invoice Push API enables customers to receive invoice data from DHL Freight. 

Best for receiving:

  1. Sales Invoice
  2. Credit Notes
  3. Correction Invoices

 

Region: Global
Used for: Finance
What you should know about Sales Invoice Push API

With Sales Invoice Push API, you can integrate our invoicing data into your applications.

Get Access

To use the DHL Freight Sales Invoice Push API, your organization requires to have an active customer account with DHL Freight.

I already have a DHL Freight Invoice Account number:

[1.] Start my integration development
[2.] Request Review
[3.] API access
 
Sign up in developer portal & contact api.support@dhl.com to gain access to further test Sales Invoice (**please do not forget to CC your DHL contact mil id)

A DHL Freight IT representative in the country of your registration will review your request and will either approve credentials to the API Test environment or contact you for further information if needed
Once approved, your access details will be available at the My Apps dashboard. 

Authentication

Sales Invoice Push API uses oAuth 2.0 protocol to authenticate and authorize access to API consumers. 

To view your API credentials :

  1. From the My Apps screen, click on the name of our app: DHL Freight Sales Invoice Push Test Product 
    The Details screen appears. 

  2. If you have access to more than one API, click the name of the relevant API. 

  3. The APIs are listed under the “Credentials” section. Click the Show link below the asterisks that is hiding the API key & secret.   

API Sequence diagram

Sequence diagram Freight Sales Invoice Push API

 

Invoice message branching diagram below:
Node Cardinality Description
header     1..1 Message Header Details
invoice         1..1 Invoice Summary Details
  issuingParty   1..1 Issuing Branch Details
  customer     1..1 Customer Details
  billToParty     1..1 Bill To Party Details
  billToPostalParty   1..1 Bill To Postal Party Details
  VAT     1..n VAT Details
  items 1..n Shipment Details Group
    shipper 0..1 Shipper Details
    carrier 0..1 Carrier Details
    pickup 0..1 Pickup Details
    deliver 0..1 Delivery Details
    service 1..n Service Details Group
 
IMPORTANT INFORMATION

A complete message implementation guide is available in Downloads.
  
Postman collection

Postman is a collaboration platform for API development and testing. DHL Freight Sales Invoice Push API postman collection helps you to get started quickly on your integration.

If you are new to postman, you can download application here.

Demo postman

 
IMPORTANT INFORMATION

You can import our postman collection from Downloads.
  
Q&A
 Do I need special permissions to get to use these APIs?

Developer requires to create APP with our API name: "DHL Freight Sales Invoice Push API" and wait for the approval.

What are the Https Status codes?
200= "Push Notification Created", 
200= "Push Notification Updated(Disabled)", 
200= "Push Notification Updated(Enabled)", 
400= "Subscription already exists", 
500= "Internal Server Error"

 

How do I get onboarded to production?

Once UAT and regression testing signed off, customer integration IT team will assist you in releasing solution to production.

Do we have helpdesk to support customers?

Indeed, please navigate to our help center: https://support-developer.dhl.com/en/support/tickets/new

Freight helpdesk