Sales Invoice Push API enables customers to receive invoice data from DHL Freight.
Best for receiving:
- Sales Invoice
- Credit Notes
- Correction Invoice
Push API is a three step process.
- Register for Push API subscription
- Provide your URL callback details (POST /subscription/invoice)
- Start to receive messages pushed from DHL to your API
Other HTTP methods such as GET & PATCH are created for supporting you with fetching subscription details & modifying configurations.
With Sales Invoice Push API, you can integrate our invoicing data into your applications. We are sharing below invoice data to your system.
-
Sales Invoice
-
Credit Notes (Sales invoice data + 4 additional fields: creditInvoiceNumber, creditInvoiceDate, creditInvoiceReason, invoiceType as “2”)
-
Correction Invoice (Sales invoice data + 4 additional fields: correctionInvoiceNumber, correctionInvoiceDate, correctionInvoiceReason,invoiceType as “8”)
To use the DHL Freight Sales Invoice Push API, your organization requires to have an active customer account with DHL Freight, proceed to below steps:
| 1) Login: | Sign up in developer portal |
| 2) Create App: |
|
| 3) Request review: |
Send an email to api.support@dhl.com along with your DHL contact person mail id in CC for getting access to Sales Invoice Push API APP. (We cannot proceed to next step, if you forget to send your DHL Contact person mail id) DHL Freight IT representatives in country of your registration will review your request. Approval process may take less than 2 working days. Once you receive email approval confirmation mail, proceed to next step |
| 4) View credentials: | From the My Apps screen, click on your app. Under "Credentials"section, click "Show Key" to view API key & secret |
See demonstration below:
API Sequence Diagram
Sandbox and production environment come equipped with self-explanatory documentation.
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 is a collaboration platform for API development and testing. Our postman collection helps you to get started quickly. If you are new to postman, you can download application here.
|
IMPORTANT INFORMATION: You can import our postman collection from Downloads. |
Demonstration below:
(Demonstration is a gif file. Please feel free to download MP4 from Downloads.)
Raise your queries via our help center
If you have questions on Sales Invoice Push API specifications, please choose following fields while filling form in help center:
- Category: "Questions on specific API"
- To which Deutsche Post DHL division does the API belong?: "DHL Freight"
- Select the API Service: "Sales Invoice Push API"
Once UAT and regression testing signed off, send an email to api.support@dhl.com, jan.zima@dhl.com & peter.bleistein@dhl.com. Either Jan or Peter will give you production environment credentials.
As of API's initial release, we cannot support Sweden Domestic & Germany (waiting for EVO TMS rollout)
Indeed. If you want to receive JSON payload via SFTP server, then we shall share our SFTP details with you.
Version
| Project title | Project Team | Short description of updates | |
| Version 1.0.0 | Sales Invoice Push API Solution Design & Rollout | Krishna Chaitanya Surati, Mary Mae Cameros, Ralph Lawrence, Martin Valent, Ancy Seles (Product Owner) | Initial release |