Kuehne + Nagel LTL+
  1. Invoice
Kuehne + Nagel LTL+
  • Overview
    • Introduction
    • Acceptable Use Policy
    • Support & Feedback
  • API
    • Overview
    • Full Integration API Workflow
    • Accessorials
      • Accessorial - Retrieve all accessorial charge codes
    • BillOfLading
      • BOL - Create a bill of lading PDF
    • Quoting
      • RateQuote - Submit a quote request
      • RateQuote - Submit a quote request for multiple points
    • Document Retrieval
      • GetImageList - Retrieve list of available shipment documents
      • GetImage - Retrieve shipping documents based on DocumentID
    • Invoice
      • Invoice - Retrieve a single invoice or pull an entire week of invoices
        POST
    • Shipment Tracking
      • HTML Tracking Link Generation
      • TrackingList - Get a list of shipment tracking information
      • TrackingDetails - Retrieve all the tracking details related to a shipment
    • Load Tendering
      • LoadTender - Tender a shipment
      • LoadTender - Tender a shipment
    • Transit
      • Transit - Receive transit time for a shipment lane.
    • Orders
      • Order
      • OrderDetails
  • EDI
    • Overview
    • 210 - Freight Details and Invoice
    • 214 - Transportation Carrier Shipment Status Message
    • Segments
      • 210/214 - 0100 Location Loop (N1 Loop)
      • 210 - 0400 Detail Loop (LX Loop)
      • 214 - 0205 Shipment Status Details (AT7 Loop)
  1. Invoice

Invoice - Retrieve a single invoice or pull an entire week of invoices

POST
https://api.ltlp.kuehne-nagel.com/api/invoice/invoices
Last modified:2024-11-04 17:41:41
The Invoice API endpoint allows users to retrieve detailed information for either a single invoice or all invoices within a specified week, based on search criteria.

Input Parameters:#

1.
Authentication:
The Authentication object contains UserName, ClientCode, and AuthenticationID to confirm user access.
2.
Search Criteria:
SearchType: Specifies the type of search, with options:
WE for Weekending (requires a Saturday date formatted as YYYYMMDD).
PD for Pickup Date.
IN for Invoice/Pro (carrier invoice number, including any leading zeros).
SearchValue: The date (formatted as YYYYMMDD) or invoice number corresponding to the SearchType.

Output Structure:#

Each invoice retrieved includes:
General Invoice Details:
Wedate: Weekending date.
Invoice: Invoice number.
Scac, Carrier, ClientCode, and BalanceDue: Carrier details and outstanding balance.
PickupDate and DeliveryDate.
InvoiceAmount, Direction, and shipment identifiers (BLNumber, PONumber, GLNumber, Store, Department).
ReferenceNumber and ReferenceType for cross-referencing.
AuditNotes, TotalWeight, LadingQuantity, and Miles.
Addresses:
Shipper, Consignee, and BillTo: Contact details for each party involved.
Invoice Images:
InvoiceImages array, containing document details with DocumentType and DocumentID for each associated document.
This endpoint provides users with a comprehensive view of invoice details, including shipment specifics, carrier information, and downloadable document links.

Request

Body Params application/json

Example
{
    "Authentication": {
        "UserName": "string",
        "ClientCode": "string",
        "AuthenticationID": "string"
    },
    "SearchType": "string",
    "SearchValue": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.ltlp.kuehne-nagel.com/api/invoice/invoices' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Authentication": {
        "UserName": "string",
        "ClientCode": "string",
        "AuthenticationID": "string"
    },
    "SearchType": "string",
    "SearchValue": "string"
}'

Responses

🟢200OK
application/json
Body

Example
[
    {
        "Wedate": "string",
        "Invoice": "string",
        "Scac": "string",
        "Carrier": "string",
        "ClientCode": "string",
        "BalanceDue": "string",
        "PickupDate": "string",
        "DeliveryDate": "string",
        "InvoiceAmount": "string",
        "Direction": "string",
        "BLNumber": "string",
        "PONumber": "string",
        "GLNumber": "string",
        "Store": "string",
        "Department": "string",
        "ReferenceNumber": "string",
        "ReferenceType": "string",
        "AuditNotes": "string",
        "TotalWeight": "string",
        "LadingQuantity": "string",
        "Miles": "string",
        "Shipper": {
            "Name": "string",
            "Address1": "string",
            "Address2": "string",
            "City": "string",
            "State": "string",
            "Zip": "string"
        },
        "Consignee": {
            "Name": "string",
            "Address1": "string",
            "Address2": "string",
            "City": "string",
            "State": "string",
            "Zip": "string"
        },
        "BillTo": {
            "Name": "string",
            "Address1": "string",
            "Address2": "string",
            "City": "string",
            "State": "string",
            "Zip": "string"
        },
        "InvoiceImages": [
            {
                "DocumentType": "string",
                "DocumentID": "string"
            }
        ]
    }
]
Previous
GetImage - Retrieve shipping documents based on DocumentID
Next
HTML Tracking Link Generation
Built with