Kuehne + Nagel LTL+
  1. Invoice
Kuehne + Nagel LTL+
  • Overview
    • Introduction
    • Acceptable Use Policy
    • Getting Started
    • Full Integration API Workflow
    • Support & Feedback
  • Accessorials
    • Accessorial - Retrieve all accessorial charge codes
      GET
  • BillOfLading
    • BOL - Create a bill of lading PDF
      POST
  • Quoting
    • RateQuote - Submit a quote request
      POST
    • RateQuote - Submit a quote request for multiple points
      POST
  • Document Retrieval
    • GetImageList - Retrieve list of available shipment documents
      POST
    • GetImage - Retrieve shipping documents based on DocumentID
      POST
  • 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
      POST
    • TrackingDetails - Retrieve all the tracking details related to a shipment
      POST
  • Load Tendering
    • LoadTender - Tender a shipment
      POST
    • LoadTender - Tender a shipment
      POST
  • Transit
    • Transit - Receive transit time for a shipment lane.
      POST
  • Orders
    • Order
      POST
    • OrderDetails
      POST
  1. Invoice

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

POST
https://api.ltlp.kuehne-nagel.com/api/invoice/invoices
Invoice
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
Authentication
object 
optional
UserName
string 
optional
ClientCode
string 
optional
AuthenticationID
string 
optional
SearchType
string 
optional
WE for Weekending (KN issues invoices every Saturday. Use only Saturday dates for WE)
PD for Pickup Date
IN for Invoice/Pro
SearchValue
string 
optional
Weekending and Pickup dates should be formatted as YYYYMMDD
Invoice should be the carrier invoice number, including any leading zeros it might contain
Example
{
  "Authentication": {
    "UserName": "string",
    "ClientCode": "string",
    "AuthenticationID": "string"
  },
  "SearchType": "string",
  "SearchValue": "string"
}

Request 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 ''

Responses

🟢200OK
application/json
Body
array of:
Wedate
string 
optional
Invoice
string 
optional
Scac
string 
optional
Carrier
string 
optional
ClientCode
string 
optional
BalanceDue
string 
optional
PickupDate
string 
optional
DeliveryDate
string 
optional
InvoiceAmount
string 
optional
Direction
string 
optional
BLNumber
string 
optional
PONumber
string 
optional
GLNumber
string 
optional
Store
string 
optional
Department
string 
optional
ReferenceNumber
string 
optional
ReferenceType
string 
optional
AuditNotes
string 
optional
TotalWeight
string 
optional
LadingQuantity
string 
optional
Miles
string 
optional
Shipper
object 
optional
Name
string 
optional
Address1
string 
optional
Address2
string 
optional
City
string 
optional
State
string 
optional
Zip
string 
optional
Consignee
object 
optional
Name
string 
optional
Address1
string 
optional
Address2
string 
optional
City
string 
optional
State
string 
optional
Zip
string 
optional
BillTo
object 
optional
Name
string 
optional
Address1
string 
optional
Address2
string 
optional
City
string 
optional
State
string 
optional
Zip
string 
optional
InvoiceImages
array [object {2}] 
optional
DocumentType
string 
optional
DocumentID
string 
optional
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