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

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.