Banyan Technology LIVE Connect™
  1. Invoice
Banyan Technology LIVE Connect™
  • Version 3
    • Authentication
      • Retrieve a token
    • Shipments
      • Creating
        • Create a Full Shipment
        • Create an EZ Rate Shipment
      • Updating
        • Add Document(s) to a Shipment
        • Update a Shipment
        • Adds one or more Reference Numbers to a Shipment
        • Mark as Exported
      • Retrieving
        • Get a Shipment
        • Get multiple Shipments
        • Get Quotes
        • Get Reference Numbers for a Shipment
        • Get documents for the specified shipment.
      • Booking
        • Book a Shipment
        • Unbooks the awarded quote on the specified load.
      • Canceling
        • Cancels a shipment.
    • Invoice
      • Get multiple invoices
        GET
      • Mark as Exported
        POST
    • Tracking
      • Get tracking statuses
      • Mark as exported.
    • StaticData
      • Accessorials
      • Document Types
      • Equipment Types
      • Package Types
      • Limited Access Types
      • Size UOMs
      • Weight UOMs
      • Pay Types
      • Ship Types
      • Countries
      • Statuses
      • Service Modes
  • Version 2
    • Recommended Workflow
      • Rating
        • ImportForQuote
        • ImportForQuote_Sync
        • GetQuotes
      • Booking/Dispatching
        • BookLoad
      • Tracking
        • GetTrackingStatuses
      • Documents
        • GetDocuments
      • Invoices
        • GetInvoices
        • GetInvoicesWithLoadDetails
    • Additional Offerings
      • Cancelling
        • Cancel a Load
      • Updating
        • UpdateLoad
        • UpdateLoadStatus
        • UpdateShipmentsExport
      • Importing
        • PendingImport
        • ImportForBook
      • Manual Quotes
        • AddManualQuote
      • EZ Rates
        • EzRate
        • EzRate_Sync
      • Waterfall Tendering
        • StartWaterfallTendering
        • CancelWaterfallTendering
      • Unbooking
        • UnBookLoad
      • Additional Dispatching
        • DispatchLoad
      • Load Details
        • GetLoadDetails
        • GetNotes
      • Additional Tracking
        • GetTrackingByLoad
      • Other
        • Normalized Charge Codes
      • SOAP
    • Changelog
  • Exports and Webhooks
    • Standard Load Export - v1
    • Standard Load Export - v2
    • Standard Load Export - v3
    • Push Tracking
  1. Invoice

Get multiple invoices

GET
/api/v3/Invoices

Returns a paged list of all invoices that match the provided criteria.#

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

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 GET 'https://ws.integration.banyantechnology.com/api/v3/Invoices'

Responses

🟢200Success
application/json
Body

Example
[
    {
        "apId": 0,
        "carrierName": "string",
        "carrierScac": "string",
        "clientName": "string",
        "clientReferenceNumber": "string",
        "currencyCode": "string",
        "invoiceStatusCode": "string",
        "invoiceType": "string",
        "netAmountDue": 0,
        "totalCharges": 0,
        "vendorId": 0,
        "vendorName": "string",
        "ediType": "string",
        "ediBillToAccountCode": "string",
        "hasException": true,
        "shipmentCreatedFromInvoice": true,
        "createdDate": "2019-08-24T14:15:22Z",
        "exportedDate": "2019-08-24T14:15:22Z",
        "billingDate": "2019-08-24T14:15:22Z",
        "pickupDate": "2019-08-24T14:15:22Z",
        "deliveryDate": "2019-08-24T14:15:22Z",
        "bolAvailable": true,
        "podAvailable": true,
        "batchDetails": {
            "batchId": "string",
            "batchDate": "2019-08-24T14:15:22Z",
            "user": "string"
        },
        "shipmentDetails": {
            "bolNumber": "string",
            "customerPo": "string",
            "proNumber": "string",
            "loadId": 0,
            "externalLoadId": "13555740-d3ec-49f8-b62c-32a6b8e8f7db",
            "payType": "string",
            "totalPieces": 0,
            "totalWeight": 0,
            "weightUnitOfMeasure": "string"
        },
        "quoteDetails": {
            "quoteNumber": "string",
            "date": "2019-08-24T14:15:22Z",
            "interline": true,
            "carrierName": "string",
            "carrierScac": "string",
            "discountAmount": 0,
            "discountPercent": 0,
            "freightCharge": 0,
            "grossCharge": 0,
            "fuelSurcharge": 0,
            "minimum": 0,
            "totalAccessorialCharges": 0,
            "totalOtherCharges": 0,
            "totalCharge": 0,
            "variance": 0
        },
        "lineItems": [
            {
                "carrierChargeCode": "string",
                "charge": 0,
                "description": "string",
                "extension": "string",
                "freightClass": "string",
                "normalizedChargeCode": "string",
                "packagingCode": "string",
                "quantity": 0,
                "weight": 0,
                "ratedAsQuantity": 0,
                "ratedAsQualifier": "string"
            }
        ],
        "payments": [
            {
                "amount": 0,
                "batchId": "string",
                "identifier": "string",
                "type": "string",
                "user": "string",
                "date": "2019-08-24T14:15:22Z"
            }
        ],
        "addresses": [
            {
                "lineOne": "string",
                "lineTwo": "string",
                "city": "string",
                "stateCode": "string",
                "postalCode": "string",
                "countryCode": "string",
                "glCode": "string",
                "idCode": "string",
                "name": "string",
                "type": "string"
            }
        ]
    }
]
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠429Too Many Requests
Modified at 2024-09-16 11:42:17
Previous
Cancels a shipment.
Next
Mark as Exported
Built with